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 MetaData
getMetaData()
Gets data describing this resource.java.lang.String
getName()
java.io.InputStream
inputStream()
Streams the document's contents.boolean
isComposite()
Is this a composite document?java.io.Reader
reader()
Reads the content of this document.
-
-
-
Method Detail
-
getName
java.lang.String getName()
-
reader
java.io.Reader reader() throws java.io.IOException
Reads the content of this document.- Returns:
Reader
not 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.IOException
Streams 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
-
-