org.apache.rat.document.impl

Class FileDocument

java.lang.Object

org.apache.rat.api.Document

org.apache.rat.document.impl.FileDocument

All Implemented Interfaces:

Comparable<Document>

public class FileDocument
extends Document

Document wrapping a File object

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.rat.api.Document

Document.Type

Constructor Summary

Constructors

Constructor and Description
FileDocument(File file) Creates a File document.

Method Summary

Modifier and Type	Method and Description
Path	getPath() Get the path that identifies the document.
InputStream	inputStream() Streams the document's contents.
boolean	isDirectory() Determines if this Document is a directory type.
SortedSet<Document>	listChildren() Gets a sorted set of Documents that are children of this document.
static String	normalizeFileName(File file) Normalizes a file name to linux style.
Reader	reader() Reads the contents of this document.

Methods inherited from class org.apache.rat.api.Document

compareTo, equals, getMetaData, getName, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FileDocument

public FileDocument(File file)

Creates a File document.

Parameters:

file - the file to wrap.

Method Detail

normalizeFileName

public static final String normalizeFileName(File file)

Normalizes a file name to linux style. Accounts for Windows to Unix conversion.

Parameters:

file - The file to normalize

Returns:

the String for the file name.

getPath

public Path getPath()

Description copied from class: Document

Get the path that identifies the document.

Overrides:

getPath in class Document

Returns:

the path for the document.

isDirectory

public boolean isDirectory()

Description copied from class: Document

Determines if this Document is a directory type.

Specified by:

isDirectory in class Document

Returns:

true if this is a directory.

listChildren

public SortedSet<Document> listChildren()

Description copied from class: Document

Gets a sorted set of Documents that are children of this document.

Specified by:

listChildren in class Document

Returns:

A sorted set of child Documents. May be empty

reader

public Reader reader()
              throws IOException

Description copied from class: Document

Reads the contents of this document.

Specified by:

reader in class Document

Returns:

Reader not null

Throws:

IOException - if this document cannot be read composite archive

inputStream

public InputStream inputStream()
                        throws IOException

Description copied from class: Document

Streams the document's contents.

Specified by:

inputStream in class Document

Returns:

a non null input stream of the document.

Throws:

IOException - when stream could not be opened