Class NameCommentRecord

  • All Implemented Interfaces:
    org.apache.poi.common.Duplicatable, GenericRecord

    public final class NameCommentRecord
    extends StandardRecord
    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

      • 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 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()
      • getGenericProperties

        public java.util.Map<java.lang.String,​java.util.function.Supplier<?>> getGenericProperties()