## net.sourceforge.pmd
Class FileDataSource

    java.lang.Object
      net.sourceforge.pmd.FileDataSource

All Implemented Interfaces:
  DataSource

public class FileDataSource
extends java.lang.Object
implements DataSource

DataSource implementation to read data from a file.

Constructor Summary
`FileDataSource(java.io.File file)`

Method Summary
`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.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### FileDataSource

    public FileDataSource(java.io.File file)

Parameters:
  `file` - the file to read

Method Detail

### getInputStream

    public java.io.InputStream getInputStream()
                                       throws java.io.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:
    `java.io.IOException` - if the file can't be opened

### getNiceFileName

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

Copyright © 2002-2006 InfoEther. All Rights Reserved.