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:
org.apache.poi.common.Duplicatable
,GenericRecord
public final class NameCommentRecord extends StandardRecord
Defines a comment associated with a specified name.
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description NameCommentRecord(java.lang.String name, java.lang.String comment)
NameCommentRecord(NameCommentRecord other)
NameCommentRecord(RecordInputStream ris)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NameCommentRecord
copy()
java.lang.String
getCommentText()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>
getGenericProperties()
HSSFRecordTypes
getGenericRecordType()
java.lang.String
getNameText()
short
getRecordType()
short
getSid()
return the non static version of the id for this record.void
serialize(LittleEndianOutput out)
void
setCommentText(java.lang.String comment)
void
setNameText(java.lang.String newName)
Updates the name we're associated with, normally used when renaming that Name-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize, toString
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NameCommentRecord
public NameCommentRecord(NameCommentRecord other)
-
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)
-
getSid
public short getSid()
return the non static version of the 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()
-
copy
public NameCommentRecord copy()
- Specified by:
copy
in interfaceorg.apache.poi.common.Duplicatable
- Specified by:
copy
in classStandardRecord
-
getGenericRecordType
public HSSFRecordTypes getGenericRecordType()
- Specified by:
getGenericRecordType
in interfaceGenericRecord
- Specified by:
getGenericRecordType
in classRecord
-
getGenericProperties
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
-
-