Package org.apache.poi.hssf.record

Class NoteStructureSubRecord

java.lang.Object

org.apache.poi.hssf.record.SubRecord

org.apache.poi.hssf.record.NoteStructureSubRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class NoteStructureSubRecord
extends SubRecord

ftNts (0x000D)

Represents a NoteStructure sub record.

The docs say nothing about it. The length of this record is always 26 bytes.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.hssf.record.SubRecord

SubRecord.SubRecordTypes

Field Summary

Fields

Modifier and Type	Field	Description
static short	sid

Constructor Summary

Constructors

Constructor	Description
NoteStructureSubRecord()	Construct a new NoteStructureSubRecord and fill its data with the default values
NoteStructureSubRecord(NoteStructureSubRecord other)
NoteStructureSubRecord(LittleEndianInput in, int size)	Read the record data from the supplied RecordInputStream
NoteStructureSubRecord(LittleEndianInput in, int size, int cmoOt)

Method Summary

Modifier and Type	Method	Description
NoteStructureSubRecord	copy()
protected int	getDataSize()
Map<String,Supplier<?>>	getGenericProperties()
SubRecord.SubRecordTypes	getGenericRecordType()
short	getSid()
void	serialize(LittleEndianOutput out)	Serialize the record data into the supplied array of bytes

Methods inherited from class org.apache.poi.hssf.record.SubRecord

createSubRecord, getMaxRecordLength, isTerminating, serialize, setMaxRecordLength, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

NoteStructureSubRecord

public NoteStructureSubRecord()

Construct a new NoteStructureSubRecord and fill its data with the default values

NoteStructureSubRecord

public NoteStructureSubRecord(NoteStructureSubRecord other)

NoteStructureSubRecord

public NoteStructureSubRecord(LittleEndianInput in,
                              int size)

Read the record data from the supplied RecordInputStream

Parameters:

in - the input to read from

size - the provided size - must be 22

NoteStructureSubRecord

public NoteStructureSubRecord(LittleEndianInput in,
                              int size,
                              int cmoOt)

Method Detail

serialize

public void serialize(LittleEndianOutput out)

Serialize the record data into the supplied array of bytes

Specified by:

serialize in class SubRecord

Parameters:

out - the stream to serialize into

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class SubRecord

Returns:

the size of the data for this record (which is always 4 bytes less than the total record size). Note however, that ushort encoded after the record sid is usually but not always the data size.

getSid

public short getSid()

Returns:

id of this record.

copy

public NoteStructureSubRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class SubRecord

Returns:

a deep copy of the implementing class / instance

getGenericRecordType

public SubRecord.SubRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord

Specified by:

getGenericRecordType in class SubRecord

getGenericProperties

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