Package 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

Field Summary

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

name, nameMatcher

Constructor Summary

Constructors

Constructor	Description
ArchiveEntryDocument(DocumentName outerName, byte[] contents, DocumentNameMatcher nameMatcher)	Creates an Archive entry.

Method Summary

Modifier and Type	Method	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, getNameMatcher, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ArchiveEntryDocument

public ArchiveEntryDocument(DocumentName outerName,
 byte[] contents,
 DocumentNameMatcher nameMatcher)

Creates an Archive entry.

Parameters:

outerName - the name of this entry from outside the archive.

contents - the contents of the entry.

nameMatcher - the name matcher to filter contents with.

Method Details

inputStream

public InputStream inputStream()

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.

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()

Description copied from class: Document

Reads the contents of this document.

Specified by:

reader in class Document

Returns:

Reader not null