org.apache.poi.hssf.record

Class EndSubRecord

java.lang.Object

org.apache.poi.hssf.record.SubRecord

org.apache.poi.hssf.record.EndSubRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class EndSubRecord
extends SubRecord

ftEnd (0x0000)

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

Nested Class Summary

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

SubRecord.SubRecordTypes

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
EndSubRecord()
EndSubRecord(LittleEndianInput in, int size)

Method Summary

Modifier and Type	Method and Description
EndSubRecord	copy()
protected int	getDataSize()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
SubRecord.SubRecordTypes	getGenericRecordType()
short	getSid()
boolean	isTerminating() Whether this record terminates the sub-record stream.
void	serialize(LittleEndianOutput out)

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

createSubRecord, getMaxRecordLength, 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

EndSubRecord

public EndSubRecord()

EndSubRecord

public EndSubRecord(LittleEndianInput in,
                    int size)

Parameters:

in - unused (since this record has no data)

size - must be 0

Method Detail

isTerminating

public boolean isTerminating()

Description copied from class: SubRecord

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)

Overrides:

isTerminating in class SubRecord

Returns:

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

serialize

public void serialize(LittleEndianOutput out)

Specified by:

serialize in class SubRecord

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

copy

public EndSubRecord 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 java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()