Package org.exbin.xbup.core.block

Class XBTDefaultDocument

  • All Implemented Interfaces:
    XBTDocument
    public class XBTDefaultDocument
extends java.lang.Object
implements XBTDocument
    Basic plain implementation of XBTDocument interface.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long getDocumentSize()
      Returns size of the whole document if available.
      java.util.Optional<XBTBlock> getRootBlock()
      Returns root block of the document.
      java.util.Optional<java.io.InputStream> getTailData()
      Returns tail data input stream.
      long getTailDataSize()
      Returns size of the tail data if available.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • XBTDefaultDocument

        public XBTDefaultDocument​(@Nonnull
                          XBTBlock rootBlock)

      • XBTDefaultDocument

        public XBTDefaultDocument​(@Nonnull
                          XBTBlock rootBlock,
                          @Nullable
                          org.exbin.auxiliary.paged_data.BinaryData tailData)

    • Method Detail

      • getRootBlock

        @Nonnull
public java.util.Optional<XBTBlock> getRootBlock()
        Description copied from interface: XBTDocument
        Returns root block of the document.
        Specified by:
        getRootBlock in interface XBTDocument
        Returns:
        root block if exits

      • getTailData

        @Nonnull
public java.util.Optional<java.io.InputStream> getTailData()
        Description copied from interface: XBTDocument
        Returns tail data input stream.
        Specified by:
        getTailData in interface XBTDocument
        Returns:
        data stream

      • getTailDataSize

        public long getTailDataSize()
        Description copied from interface: XBTDocument
        Returns size of the tail data if available.
        Specified by:
        getTailDataSize in interface XBTDocument
        Returns:
        length of tail data in bytes or -1 if not available or is infinite

      • getDocumentSize

        public long getDocumentSize()
        Description copied from interface: XBTDocument
        Returns size of the whole document if available.
        Specified by:
        getDocumentSize in interface XBTDocument
        Returns:
        length of whole document in bytes or -1 if not available or is infinite