Package org.apache.poi.hssf.record

Class NameCommentRecord

java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.NameCommentRecord
All Implemented Interfaces:
Duplicatable, GenericRecord
public final class NameCommentRecord extends StandardRecord
Defines a comment associated with a specified name.

  • Field Details

  • Constructor Details

    • NameCommentRecord

      public NameCommentRecord(NameCommentRecord other)

    • NameCommentRecord

      public NameCommentRecord(String name, String comment)

    • NameCommentRecord

      public NameCommentRecord(RecordInputStream ris)
      Parameters:
      ris - the RecordInputstream to read the record from

  • Method Details

    • serialize

      public void serialize(LittleEndianOutput out)
      Description copied from class: StandardRecord
      Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

      The number of bytes written must equal the record size reported by RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

      Specified by:
      serialize in class StandardRecord
      Parameters:
      out - the output object

    • getDataSize

      protected int getDataSize()
      Specified by:
      getDataSize in class StandardRecord

    • getSid

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

    • getNameText

      public String getNameText()
      Returns:
      the name of the NameRecord to which this comment applies.

    • setNameText

      public void setNameText(String newName)
      Updates the name we're associated with, normally used when renaming that Name
      Parameters:
      newName - the new name

    • getCommentText

      public String getCommentText()
      Returns:
      the text of the comment.

    • setCommentText

      public void setCommentText(String comment)

    • getRecordType

      public short getRecordType()

    • copy

      public NameCommentRecord copy()
      Specified by:
      copy in interface Duplicatable
      Specified by:
      copy in class StandardRecord
      Returns:
      a deep copy of the implementing class / instance

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

      public Map<String,Supplier<?>> getGenericProperties()