Package org.apache.rat.api

Interface Document

All Known Implementing Classes:
AbstractMonolithicDocument, ArchiveEntryDocument, FileDocument, MonolithicFileDocument
public interface Document

  • Method Details

    • getName

      String getName()
      Returns:
      the name of the current document.

    • reader

      Reader reader() throws IOException
      Reads the contents 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

    • inputStream

      InputStream inputStream() throws IOException
      Streams the document's contents.
      Returns:
      not null
      Throws:
      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