rat.document
Interface IDocument

All Superinterfaces:
IResource
All Known Implementing Classes:
CompositeDocument, FileDocument, MonolithicFileDocument, ZipFileDocument

public interface IDocument
extends IResource


Method Summary
 IDocumentCollection readArchive()
          Reads contents of composite document.
 Reader reader()
          Reads the content of this document.
 
Methods inherited from interface rat.document.IResource
getName
 

Method Detail

reader

Reader reader()
              throws IOException
Reads the content of this document.

Returns:
Reader not null
Throws:
IOException - if this document cannot be read
CompositeDocumentException - if this document can only be read as a composite archive

readArchive

IDocumentCollection readArchive()
                                throws IOException
Reads contents of composite document.

Returns:
IDocumentCollection, not null
Throws:
IOException - if the document cannot be read
UnreadableArchiveException - if this document is not an archive or if this document is unreadable


Copyright © 2006-2011. All Rights Reserved.