Package net.sourceforge.pmd.util.datasource

Class ZipDataSource

java.lang.Object

net.sourceforge.pmd.util.datasource.internal.AbstractDataSource

net.sourceforge.pmd.util.datasource.ZipDataSource

All Implemented Interfaces:

Closeable, AutoCloseable, DataSource

public class ZipDataSource
extends net.sourceforge.pmd.util.datasource.internal.AbstractDataSource

DataSource implementation to read data from an entry in a zip or jar file.

Constructor Summary

Constructors

Constructor	Description
ZipDataSource(ZipFile zipFile, ZipEntry zipEntry)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	equals(Object obj)
InputStream	getInputStream()	Get an InputStream on the source file.
String	getNiceFileName(boolean shortNames, String inputFileName)	Return a nice version of the filename.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ZipDataSource

public ZipDataSource(ZipFile zipFile,
                     ZipEntry zipEntry)

Parameters:

zipFile - the ZipFile

zipEntry - the ZipEntry containing the file to read

Method Detail

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: DataSource

Get an InputStream on the source file.

Returns:

the InputStream reading the source file

Throws:

IOException - if the file can't be opened

getNiceFileName

public String getNiceFileName(boolean shortNames,
                              String inputFileName)

Description copied from interface: DataSource

Return a nice version of the filename.

Parameters:

shortNames - true if short names are being used

inputFileName - name of a "master" file this file is relative to

Returns:

String

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class net.sourceforge.pmd.util.datasource.internal.AbstractDataSource

Throws:

IOException