Package loci.poi.hssf.record

Class ContinueRecord

  • public class ContinueRecord
extends Record
    Title: Continue Record - Helper class used primarily for SST Records

    Description: handles overflow for prior record in the input stream; content is tailored to that prior record

    Version:
    2.0-pre
    Author:
    Marc Johnson (mjohnson at apache dot org), Andrew C. Oliver (acoliver at apache dot org), Csaba Nagy (ncsaba at yahoo dot com)

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static short sid  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()
      Clone this record.
      protected void fillFields​(RecordInputStream in)
      Fill the fields.
      byte[] getData()
      get the data for continuation
      short getSid()
      return the non static version of the id for this record.
      byte[] serialize()
      USE ONLY within "processContinue"
      int serialize​(int offset, byte[] data)
      called by the class that is responsible for writing this sucker.
      void setData​(byte[] data)  
      java.lang.String toString()
      Debugging toString
      protected void validateSid​(short id)
      Make sure we have a good id

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ContinueRecord

        public ContinueRecord()
        default constructor

      • ContinueRecord

        public ContinueRecord​(RecordInputStream in)
        Main constructor -- kinda dummy because we don't validate or fill fields
        Parameters:
        in - the RecordInputstream to read the record from

    • Method Detail

      • serialize

        public byte[] serialize()
        USE ONLY within "processContinue"
        Overrides:
        serialize in class Record
        Returns:
        byte array containing instance data

      • serialize

        public int serialize​(int offset,
                     byte[] data)
        Description copied from class: Record
        called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.
        Specified by:
        serialize in class Record
        Parameters:
        offset - to begin writing at
        data - byte array containing instance data
        Returns:
        number of bytes written

      • setData

        public void setData​(byte[] data)

      • getData

        public byte[] getData()
        get the data for continuation
        Returns:
        byte array containing all of the continued data

      • validateSid

        protected void validateSid​(short id)
        Make sure we have a good id
        Specified by:
        validateSid in class Record
        Parameters:
        id - the alleged id

      • toString

        public java.lang.String toString()
        Debugging toString
        Overrides:
        toString in class Record
        Returns:
        string representation

      • getSid

        public short getSid()
        Description copied from class: Record
        return the non static version of the id for this record.
        Specified by:
        getSid in class Record

      • fillFields

        protected void fillFields​(RecordInputStream in)
        Fill the fields. Only thing is, this record has no fields --
        Specified by:
        fillFields in class Record
        Parameters:
        in - the RecordInputstream to read the record from

      • clone

        public java.lang.Object clone()
        Clone this record.
        Overrides:
        clone in class Record