org.apache.rat.document.impl
Class FileDocument

java.lang.Object
  extended by org.apache.rat.document.impl.FileDocument
All Implemented Interfaces:
Document

public class FileDocument
extends java.lang.Object
implements Document

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

FileDocument

public FileDocument(java.io.File file)
Method Detail

isComposite

public boolean isComposite()
Description copied from interface: Document
Is this a composite document?

Specified by:
isComposite in interface Document
Returns:
true if composite, false otherwise

reader

public java.io.Reader reader()
                      throws java.io.IOException
Description copied from interface: Document
Reads the content of this document.

Specified by:
reader in interface Document
Returns:
Reader not null
Throws:
java.io.IOException - if this document cannot be read
CompositeDocumentException - if this document can only be read as a composite archive

getName

public java.lang.String getName()
Specified by:
getName in interface Document

getMetaData

public MetaData getMetaData()
Description copied from interface: Document
Gets data describing this resource.

Specified by:
getMetaData in interface Document
Returns:
not null

inputStream

public java.io.InputStream inputStream()
                                throws java.io.IOException
Description copied from interface: Document
Streams the document's contents.

Specified by:
inputStream in interface Document
Returns:
not null
Throws:
java.io.IOException - when stream could not be opened

toString

public java.lang.String toString()
Representations suitable for logging.

Overrides:
toString in class java.lang.Object
Returns:
a String representation of this object.


Copyright © 2006-2010 Apache Software Foundation. All Rights Reserved.