net.sourceforge.pmd.util.datasource

Class FileDataSource

java.lang.Object

net.sourceforge.pmd.util.datasource.FileDataSource

All Implemented Interfaces:

DataSource

public class FileDataSource
extends Object
implements DataSource

DataSource implementation to read data from a file.

Constructor Summary

Constructors

Constructor and Description
FileDataSource(File file)

Method Summary

Methods

Modifier and Type	Method and 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileDataSource

public FileDataSource(File file)

Parameters:

file - the file to read

Method Detail

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: DataSource

Get an InputStream on the source file.

Specified by:

getInputStream in interface DataSource

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.

Specified by:

getNiceFileName in interface DataSource

Parameters:

shortNames - true if short names are being used

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

Returns:

String