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

public final Class EndSubRecord

extends SubRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.LittleEndianInput, .LittleEndianOutput, .RecordFormatException
ftEnd (0x0000)

The end data record is used to denote the end of the subrecords.

Field Summary

Modifier and TypeField and Description
private static final int
ENCODED_SIZE

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
EndSubRecord()

public
EndSubRecord(LittleEndianInput
unused (since this record has no data)
in, int
must be 0
size)

pack-priv
EndSubRecord(LittleEndianInput in, int size, int cmoOt)

Method Summary

Modifier and TypeMethod and Description
public EndSubRecord
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
getSid()

public boolean
isTerminating()

Overrides org.apache.poi.hssf.record.SubRecord.isTerminating.

Whether this record terminates the sub-record stream.

public void
serialize(LittleEndianOutput out)

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

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

Field Detail

ENCODED_SIZEback to summary
private static final int ENCODED_SIZE
sidback to summary
public static final short sid

Constructor Detail

EndSubRecordback to summary
public EndSubRecord()
EndSubRecordback to summary
public EndSubRecord(LittleEndianInput in, int size)
Parameters
in:LittleEndianInput

unused (since this record has no data)

size:int

must be 0

EndSubRecordback to summary
pack-priv EndSubRecord(LittleEndianInput in, int size, int cmoOt)

Method Detail

copyback to summary
public EndSubRecord copy()

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

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

Returns:EndSubRecord

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.

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()
isTerminatingback to summary
public boolean isTerminating()

Overrides org.apache.poi.hssf.record.SubRecord.isTerminating.

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

Whether this record terminates the sub-record stream. There are two cases when this method must be overridden and return true - EndSubRecord (sid = 0x00) - LbsDataSubRecord (sid = 0x12)

Returns:boolean

whether this record is the last in the sub-record stream

Annotations
@Override
serializeback to summary
public void serialize(LittleEndianOutput out)

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