|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.rat.document.impl.FileDocument
public class FileDocument
Document wrapping a file of undetermined composition.
| Constructor Summary | |
|---|---|
FileDocument(java.io.File file)
|
|
| Method Summary | |
|---|---|
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. |
java.lang.String |
toString()
Representations suitable for logging. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public FileDocument(java.io.File file)
| Method Detail |
|---|
public boolean isComposite()
Document
isComposite in interface Document
public java.io.Reader reader()
throws java.io.IOException
Document
reader in interface DocumentReader not null
java.io.IOException - if this document cannot be read
CompositeDocumentException - if this document can only be read as
a composite archivepublic java.lang.String getName()
getName in interface Documentpublic MetaData getMetaData()
Document
getMetaData in interface Document
public java.io.InputStream inputStream()
throws java.io.IOException
Document
inputStream in interface Documentjava.io.IOException - when stream could not be openedpublic java.lang.String toString()
toString in class java.lang.ObjectString representation
of this object.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||