org.apache.rat.document.impl
Class AbstractMonolithicDocument

java.lang.Object
  extended by org.apache.rat.document.impl.AbstractMonolithicDocument
All Implemented Interfaces:
IDocument, IResource
Direct Known Subclasses:
MonolithicFileDocument

public abstract class AbstractMonolithicDocument
extends java.lang.Object
implements IDocument

Abstract base class for monolithic documents.


Constructor Summary
AbstractMonolithicDocument(java.lang.String pName)
           
 
Method Summary
 java.lang.String getName()
           
 IDocumentCollection readArchive()
          Reads contents of composite document.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.rat.document.IDocument
reader
 

Constructor Detail

AbstractMonolithicDocument

public AbstractMonolithicDocument(java.lang.String pName)
Method Detail

readArchive

public IDocumentCollection readArchive()
                                throws java.io.IOException
Description copied from interface: IDocument
Reads contents of composite document.

Specified by:
readArchive in interface IDocument
Returns:
IDocumentCollection, not null
Throws:
java.io.IOException - if the document cannot be read
UnreadableArchiveException - if this document is not an archive or if this document is unreadable

getName

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


Copyright © 2006-2009 The Apache Software Foundation. All Rights Reserved.