Package org.docx4j.org.apache.poi.poifs.storage

Class SmallDocumentBlockList

java.lang.Object
org.docx4j.org.apache.poi.poifs.storage.SmallDocumentBlockList
All Implemented Interfaces:
BlockList
public class SmallDocumentBlockList extends Object
A list of SmallDocumentBlocks instances, and methods to manage the list

  • Constructor Details

    • SmallDocumentBlockList

      public SmallDocumentBlockList(List<SmallDocumentBlock> blocks)
      Constructor SmallDocumentBlockList
      Parameters:
      blocks - a list of SmallDocumentBlock instances

  • Method Details

    • setBlocks

      protected void setBlocks(ListManagedBlock[] blocks)
      provide blocks to manage
      Parameters:
      blocks - blocks to be managed

    • zap

      public void zap(int index)
      remove the specified block from the list
      Specified by:
      zap in interface BlockList
      Parameters:
      index - the index of the specified block; if the index is out of range, that's ok

    • get

      protected ListManagedBlock get(int index)
      Unit testing method. Gets, without sanity checks or removing.

    • remove

      public ListManagedBlock remove(int index) throws IOException
      remove and return the specified block from the list
      Specified by:
      remove in interface BlockList
      Parameters:
      index - the index of the specified block
      Returns:
      the specified block
      Throws:
      IOException - if the index is out of range or has already been removed

    • fetchBlocks

      public ListManagedBlock[] fetchBlocks(int startBlock, int headerPropertiesStartBlock) throws IOException
      get the blocks making up a particular stream in the list. The blocks are removed from the list.
      Specified by:
      fetchBlocks in interface BlockList
      Parameters:
      startBlock - the index of the first block in the stream
      headerPropertiesStartBlock - the index of the first header block in the stream
      Returns:
      the stream as an array of correctly ordered blocks
      Throws:
      IOException - if blocks are missing

    • setBAT

      public void setBAT(BlockAllocationTableReader bat) throws IOException
      set the associated BlockAllocationTable
      Specified by:
      setBAT in interface BlockList
      Parameters:
      bat - the associated BlockAllocationTable
      Throws:
      IOException

    • blockCount

      public int blockCount()
      Returns the count of the number of blocks
      Specified by:
      blockCount in interface BlockList

    • remainingBlocks

      protected int remainingBlocks()
      Returns the number of remaining blocks