org.apache.rat.document.impl

Class ArchiveEntryDocument

java.lang.Object

org.apache.rat.api.Document

org.apache.rat.document.impl.ArchiveEntryDocument

All Implemented Interfaces:

Comparable<Document>

public class ArchiveEntryDocument
extends Document

A Document that wraps an Archive entry.

Nested Class Summary

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

Document.Type

Constructor Summary

Constructors

Constructor and Description
ArchiveEntryDocument(Path path, byte[] contents) Creates an Archive entry.

Method Summary

Modifier and Type	Method and Description
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.
Reader	reader() Reads the contents of this document.

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

compareTo, equals, getMetaData, getName, getPath, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveEntryDocument

public ArchiveEntryDocument(Path path,
                            byte[] contents)

Creates an Archive entry.

Parameters:

path - The path for the entry.

contents - the contents of the entry.

Method Detail

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

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