Package org.apache.poi.hssf.record

Class NameCommentRecord

  • public final class NameCommentRecord
extends StandardRecord
    Title: NAMECMT Record (0x0894)

    Description: Defines a comment associated with a specified name.

    • Constructor Detail

      • NameCommentRecord

        public NameCommentRecord​(java.lang.String name,
                         java.lang.String comment)

      • NameCommentRecord

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

    • Method Detail

      • 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

      • 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

      • 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

      • getNameText

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

      • setNameText

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

      • getCommentText

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

      • setCommentText

        public void setCommentText​(java.lang.String comment)

      • getRecordType

        public short getRecordType()