Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class NoteStructureSubRecord

extends SubRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .IOUtils, .LittleEndianInput, .LittleEndianOutput, .RecordFormatException
ftNts (0x000D)

Represents a NoteStructure sub record.

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

Field Summary

Modifier and TypeField and Description
private static final int
ENCODED_SIZE

private final byte[]
reserved

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
NoteStructureSubRecord()

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

public
NoteStructureSubRecord(NoteStructureSubRecord other)

public
NoteStructureSubRecord(LittleEndianInput
the input to read from
in, int
the provided size - must be 22
size)

Read the record data from the supplied RecordInputStream

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

Method Summary

Modifier and TypeMethod and Description
public NoteStructureSubRecord
copy()

Implements abstract org.apache.poi.hssf.record.SubRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.SubRecord.getDataSize.

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public SubRecord.SubRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.SubRecord.getGenericRecordType.

public short

Returns:

id of this record.
getSid()

public void
serialize(LittleEndianOutput
the stream to serialize into
out)

Implements abstract org.apache.poi.hssf.record.SubRecord.serialize.

Serialize the record data into the supplied array of bytes

Inherited from org.apache.poi.hssf.record.SubRecord:
createSubRecordgetMaxRecordLengthisTerminatingserializesetMaxRecordLengthtoString

Field Detail

ENCODED_SIZEback to summary
private static final int ENCODED_SIZE
reservedback to summary
private final byte[] reserved
sidback to summary
public static final short sid

Constructor Detail

NoteStructureSubRecordback to summary
public NoteStructureSubRecord()

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

NoteStructureSubRecordback to summary
public NoteStructureSubRecord(NoteStructureSubRecord other)
NoteStructureSubRecordback to summary
public NoteStructureSubRecord(LittleEndianInput in, int size)

Read the record data from the supplied RecordInputStream

Parameters
in:LittleEndianInput

the input to read from

size:int

the provided size - must be 22

NoteStructureSubRecordback to summary
public NoteStructureSubRecord(LittleEndianInput in, int size, int cmoOt)

Method Detail

copyback to summary
public NoteStructureSubRecord copy()

Implements abstract org.apache.poi.hssf.record.SubRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:NoteStructureSubRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.SubRecord.getDataSize.

Returns:int

Doc from org.apache.poi.hssf.record.SubRecord.getDataSize.

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.

Annotations
@Override
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public SubRecord.SubRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.SubRecord.getGenericRecordType.

Annotations
@Override
getSidback to summary
public short getSid()
Returns:short

id of this record.

serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.SubRecord.serialize.

Serialize the record data into the supplied array of bytes

Parameters
out:LittleEndianOutput

the stream to serialize into

Annotations
@Override