Package net.sourceforge.pmd.util.datasource

Interface DataSource

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

net.sourceforge.pmd.util.datasource.internal.AbstractDataSource, FileDataSource, ReaderDataSource, ZipDataSource

public interface DataSource
extends Closeable

Represents a source file to be analyzed. Different implementations can get the source file from different places: the filesystem, a zip or jar file, etc.

Method Summary

Modifier and Type	Method	Description
InputStream	getInputStream()	Get an InputStream on the source file.
String	getNiceFileName(boolean shortNames, String inputFileName)	Return a nice version of the filename.

Methods inherited from interface java.io.Closeable

close

Method Detail

getInputStream

InputStream getInputStream()
                    throws IOException

Get an InputStream on the source file.

Returns:

the InputStream reading the source file

Throws:

IOException - if the file can't be opened

getNiceFileName

String getNiceFileName(boolean shortNames,
                       String inputFileName)

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