Package net.sourceforge.pmd.util.datasource

Interface DataSource

All Known Implementing Classes:

FileDataSource, ReaderDataSource, ZipDataSource

public interface DataSource

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
java.io.InputStream	getInputStream()	Get an InputStream on the source file.
java.lang.String	getNiceFileName(boolean shortNames, java.lang.String inputFileName)	Return a nice version of the filename.

Method Detail

getInputStream

java.io.InputStream getInputStream()
                            throws java.io.IOException

Get an InputStream on the source file.

Returns:

the InputStream reading the source file

Throws:

java.io.IOException - if the file can't be opened

getNiceFileName

java.lang.String getNiceFileName(boolean shortNames,
                                 java.lang.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