Class FileDataSource
- java.lang.Object
-
- net.sourceforge.pmd.util.datasource.internal.AbstractDataSource
-
- net.sourceforge.pmd.util.datasource.FileDataSource
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,DataSource
public class FileDataSource extends AbstractDataSource
DataSource implementation to read data from a file.
-
-
Constructor Summary
Constructors Constructor Description FileDataSource(java.io.File file)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.io.InputStream
getInputStream()
Get an InputStream on the source file.java.lang.String
getNiceFileName(boolean shortNames, java.lang.String inputPaths)
Return a nice version of the filename.int
hashCode()
java.lang.String
toString()
-
Methods inherited from class net.sourceforge.pmd.util.datasource.internal.AbstractDataSource
close
-
-
-
-
Method Detail
-
getInputStream
public java.io.InputStream getInputStream() throws java.io.IOException
Description copied from interface:DataSource
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
public java.lang.String getNiceFileName(boolean shortNames, java.lang.String inputPaths)
Description copied from interface:DataSource
Return a nice version of the filename.- Parameters:
shortNames
- true if short names are being usedinputPaths
- name of a "master" file this file is relative to- Returns:
- String
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
-