org.apache.rat.api
Interface Document

All Known Implementing Classes:

AbstractMonolithicDocument, ArchiveEntryDocument, FileDocument, MonolithicFileDocument

public interface Document

Method Summary

MetaData	getMetaData() Gets data describing this resource.
String	getName()
InputStream	inputStream() Streams the document's contents.
boolean	isComposite() Is this a composite document?
Reader	reader() Reads the content of this document.

Method Detail

getName

String getName()

reader

Reader reader()
              throws IOException

Reads the content of this document.

Returns:

Reader not null

Throws:

IOException - if this document cannot be read

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

inputStream

InputStream inputStream()
                        throws IOException

Streams the document's contents.

Returns:

not null

Throws:

IOException - when stream could not be opened

getMetaData

MetaData getMetaData()

Gets data describing this resource.

Returns:

not null

isComposite

boolean isComposite()

Is this a composite document?

Returns:

true if composite, false otherwise