Package org.apache.rat.api
Interface Document
-
- All Known Implementing Classes:
AbstractMonolithicDocument,ArchiveEntryDocument,FileDocument,FilesReportable.FileDocument,MonolithicFileDocument,ResourceCollectionContainer.ResourceDocument
public interface Document
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description MetaDatagetMetaData()Gets data describing this resource.java.lang.StringgetName()java.io.InputStreaminputStream()Streams the document's contents.booleanisComposite()Is this a composite document?java.io.Readerreader()Reads the content of this document.
-
-
-
Method Detail
-
getName
java.lang.String getName()
-
reader
java.io.Reader reader() throws java.io.IOExceptionReads the content of this document.- Returns:
Readernot null- Throws:
java.io.IOException- if this document cannot be readCompositeDocumentException- if this document can only be read as a composite archive
-
inputStream
java.io.InputStream inputStream() throws java.io.IOExceptionStreams the document's contents.- Returns:
- not null
- Throws:
java.io.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
-
-