org.apache.rat.document.impl

Class MonolithicFileDocument

java.lang.Object

org.apache.rat.document.impl.AbstractMonolithicDocument

org.apache.rat.document.impl.MonolithicFileDocument

All Implemented Interfaces:

Document

public class MonolithicFileDocument
extends AbstractMonolithicDocument

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	file
private static java.lang.String	FILE_URL_PREFIX
private static java.lang.String	UTF_8

Constructor Summary

Constructors

Constructor and Description
MonolithicFileDocument(java.io.File file)

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	inputStream() Streams the document's contents.
static Document	newInstance(java.net.URL url)
java.io.Reader	reader() Reads the content of this document.

Methods inherited from class org.apache.rat.document.impl.AbstractMonolithicDocument

getMetaData, getName, isComposite

Methods inherited from class java.lang.Object

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

Field Detail

UTF_8

private static final java.lang.String UTF_8

See Also:

Constant Field Values

FILE_URL_PREFIX

private static final java.lang.String FILE_URL_PREFIX

See Also:

Constant Field Values

file

private final java.io.File file

Constructor Detail

MonolithicFileDocument

public MonolithicFileDocument(java.io.File file)

Method Detail

newInstance

public static Document newInstance(java.net.URL url)

Parameters:

url - The document is read from the given URL.

Returns:

Creates and returns a new instance.

reader

public java.io.Reader reader()
                      throws java.io.IOException

Description copied from interface: Document

Reads the content of this document.

Returns:

Reader not null

Throws:

java.io.IOException - if this document cannot be read

CompositeDocumentException - if this document can only be read as a composite archive

inputStream

public java.io.InputStream inputStream()
                                throws java.io.IOException

Description copied from interface: Document

Streams the document's contents.

Returns:

not null

Throws:

java.io.IOException - when stream could not be opened