Package loci.poi.hssf.record

Class SeriesTextRecord

  • public class SeriesTextRecord
extends Record
    Defines a series name NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
    Author:
    Andrew C. Oliver (acoliver at apache.org)

    • 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()  
      protected void fillFields​(RecordInputStream in)
      called by the constructor, should set class level fields.
      short getId()
      Get the id field for the SeriesText record.
      int getRecordSize()
      Size of record (exluding 4 byte header)
      short getSid()
      return the non static version of the id for this record.
      java.lang.String getText()
      Get the text field for the SeriesText record.
      byte getTextLength()
      Get the text length field for the SeriesText record.
      byte getUndocumented()
      Get the undocumented field for the SeriesText record.
      int serialize​(int offset, byte[] data)
      called by the class that is responsible for writing this sucker.
      void setId​(short field_1_id)
      Set the id field for the SeriesText record.
      void setText​(java.lang.String field_4_text)
      Set the text field for the SeriesText record.
      void setTextLength​(byte field_2_textLength)
      Set the text length field for the SeriesText record.
      void setUndocumented​(byte field_3_undocumented)
      Set the undocumented field for the SeriesText record.
      java.lang.String toString()
      get a string representation of the record (for biffview/debugging)
      protected void validateSid​(short id)
      Checks the sid matches the expected side for this record

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SeriesTextRecord

        public SeriesTextRecord()

      • SeriesTextRecord

        public SeriesTextRecord​(RecordInputStream in)
        Constructs a SeriesText record and sets its fields appropriately.
        Parameters:
        in - the RecordInputstream to read the record from

    • Method Detail

      • validateSid

        protected void validateSid​(short id)
        Checks the sid matches the expected side for this record
        Specified by:
        validateSid in class Record
        Parameters:
        id - the expected sid.

      • fillFields

        protected void fillFields​(RecordInputStream in)
        Description copied from class: Record
        called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.
        Specified by:
        fillFields in class Record
        Parameters:
        in - the RecordInputstream to read the record from

      • toString

        public java.lang.String toString()
        Description copied from class: Record
        get a string representation of the record (for biffview/debugging)
        Overrides:
        toString in class Record

      • 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

      • getRecordSize

        public int getRecordSize()
        Size of record (exluding 4 byte header)
        Overrides:
        getRecordSize in class Record

      • 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

      • clone

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

      • getId

        public short getId()
        Get the id field for the SeriesText record.

      • setId

        public void setId​(short field_1_id)
        Set the id field for the SeriesText record.

      • getTextLength

        public byte getTextLength()
        Get the text length field for the SeriesText record.

      • setTextLength

        public void setTextLength​(byte field_2_textLength)
        Set the text length field for the SeriesText record.

      • getUndocumented

        public byte getUndocumented()
        Get the undocumented field for the SeriesText record.

      • setUndocumented

        public void setUndocumented​(byte field_3_undocumented)
        Set the undocumented field for the SeriesText record.

      • getText

        public java.lang.String getText()
        Get the text field for the SeriesText record.

      • setText

        public void setText​(java.lang.String field_4_text)
        Set the text field for the SeriesText record.