Modifier and Type	Class and Description
public static enum	SubRecord.SubRecordTypes
private static class	SubRecord.UnknownSubRecord

Modifier and Type	Field and Description
private static final int	DEFAULT_MAX_RECORD_LENGTH
private static int	MAX_RECORD_LENGTH

Access	Constructor and Description
protected	SubRecord()
protected	SubRecord(SubRecord other)

Method Summary

Modifier and Type	Method and Description
public abstract SubRecord	copy() Redeclares org.apache.poi.common.Duplicatable.copy.
public static SubRecord	Returns: the created sub-record createSubRecord(LittleEndianInput the stream to read from in, int the objectType field of the containing CommonObjectDataSubRecord, we need it to propagate to next sub-records as it defines what data follows cmoOt) read a sub-record from the supplied stream
protected abstract int	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. getDataSize()
public abstract SubRecord.SubRecordTypes	getGenericRecordType() Redeclares as abstract: org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.
public static int	Returns: the max record length allowed for SubRecord getMaxRecordLength()
public boolean	Returns: whether this record is the last in the sub-record stream isTerminating() Whether this record terminates the sub-record stream.
public byte[]	serialize()
public abstract void	serialize(LittleEndianOutput out)
public static void	setMaxRecordLength(int the max record length allowed for SubRecord length)
public final String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

DEFAULT_MAX_RECORD_LENGTH	back to summary
private static final int DEFAULT_MAX_RECORD_LENGTH

MAX_RECORD_LENGTH	back to summary
private static int MAX_RECORD_LENGTH

SubRecord	back to summary
protected SubRecord()

SubRecord	back to summary
protected SubRecord(SubRecord other)

Method Detail

copy	back to summary
public abstract SubRecord copy() Redeclares org.apache.poi.common.Duplicatable.copy. Returns:SubRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public abstract SubRecord copy()

Redeclares org.apache.poi.common.Duplicatable.copy.

Returns:SubRecord

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

a deep copy of the implementing class / instance

Annotations

@Override

createSubRecord	back to summary
public static SubRecord createSubRecord(LittleEndianInput in, int cmoOt) read a sub-record from the supplied stream Parameters in:LittleEndianInput the stream to read from cmoOt:int the objectType field of the containing CommonObjectDataSubRecord, we need it to propagate to next sub-records as it defines what data follows Returns:SubRecord the created sub-record

createSubRecord

back to summary

public static SubRecord createSubRecord(LittleEndianInput in, int cmoOt)

read a sub-record from the supplied stream

Parameters

in:LittleEndianInput: the stream to read from
cmoOt:int: the objectType field of the containing CommonObjectDataSubRecord, we need it to propagate to next sub-records as it defines what data follows

Returns:SubRecord

the created sub-record

getDataSize	back to summary
protected abstract int getDataSize() Returns:int 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.

getGenericRecordType	back to summary
public abstract SubRecord.SubRecordTypes getGenericRecordType() Redeclares as abstract: org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Annotations @Override

getGenericRecordType

back to summary

public abstract SubRecord.SubRecordTypes getGenericRecordType()

Redeclares as abstract: org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Annotations

@Override

getMaxRecordLength	back to summary
public static int getMaxRecordLength() Returns:int the max record length allowed for SubRecord

isTerminating back to summary

isTerminating	back to summary
public boolean 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

public boolean 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

serialize	back to summary
public byte[] serialize()

serialize	back to summary
public abstract void serialize(LittleEndianOutput out)

setMaxRecordLength	back to summary
public static void setMaxRecordLength(int length) Parameters length:int the max record length allowed for SubRecord

toString back to summary

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.apache.poi.hssf.record back to summary

public final Enum SubRecord.SubRecordTypes

Class Inheritance

extends Enum<SubRecord.SubRecordTypes>

java.lang.Object
java.lang.Enum
org.apache.poi.hssf.record.SubRecord.SubRecordTypes

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	SubRecord.SubRecordTypes.RecordConstructor<T extends SubRecord>

Field Summary

Modifier and Type	Field and Description
public static final SubRecord.SubRecordTypes	COMMON_OBJECT_DATA
public static final SubRecord.SubRecordTypes	EMBEDDED_OBJECT_REF
public static final SubRecord.SubRecordTypes	END
public static final SubRecord.SubRecordTypes	FT_CBLS
public static final SubRecord.SubRecordTypes	FT_CF
public static final SubRecord.SubRecordTypes	FT_PIO_GRBIT
public static final SubRecord.SubRecordTypes	GROUP_MARKER
public static final SubRecord.SubRecordTypes	LBS_DATA
private static final Map<Short, SubRecord.SubRecordTypes>	LOOKUP
public static final SubRecord.SubRecordTypes	NOTE_STRUCTURE
public final SubRecord.SubRecordTypes.RecordConstructor<?>	recordConstructor
public final short	sid
public static final SubRecord.SubRecordTypes	UNKNOWN

Constructor Summary

Access	Constructor and Description
private	SubRecordTypes(int sid, SubRecord.SubRecordTypes.RecordConstructor<?> recordConstructor)

Method Summary

Modifier and Type	Method and Description
public static SubRecord.SubRecordTypes	forSID(int sid)
public short	getSid()
public static SubRecord.SubRecordTypes	valueOf(String name)
public static SubRecord.SubRecordTypes[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COMMON_OBJECT_DATA	back to summary
public static final SubRecord.SubRecordTypes COMMON_OBJECT_DATA

EMBEDDED_OBJECT_REF	back to summary
public static final SubRecord.SubRecordTypes EMBEDDED_OBJECT_REF

END	back to summary
public static final SubRecord.SubRecordTypes END

FT_CBLS	back to summary
public static final SubRecord.SubRecordTypes FT_CBLS

FT_CF	back to summary
public static final SubRecord.SubRecordTypes FT_CF

FT_PIO_GRBIT	back to summary
public static final SubRecord.SubRecordTypes FT_PIO_GRBIT

GROUP_MARKER	back to summary
public static final SubRecord.SubRecordTypes GROUP_MARKER

LBS_DATA	back to summary
public static final SubRecord.SubRecordTypes LBS_DATA

LOOKUP	back to summary
private static final Map<Short, SubRecord.SubRecordTypes> LOOKUP

NOTE_STRUCTURE	back to summary
public static final SubRecord.SubRecordTypes NOTE_STRUCTURE

recordConstructor	back to summary
public final SubRecord.SubRecordTypes.RecordConstructor<?> recordConstructor

sid	back to summary
public final short sid

UNKNOWN	back to summary
public static final SubRecord.SubRecordTypes UNKNOWN

Constructor Detail

SubRecordTypes	back to summary
private SubRecordTypes(int sid, SubRecord.SubRecordTypes.RecordConstructor<?> recordConstructor)

Method Detail

forSID	back to summary
public static SubRecord.SubRecordTypes forSID(int sid)

getSid	back to summary
public short getSid()

valueOf	back to summary
public static SubRecord.SubRecordTypes valueOf(String name)

values	back to summary
public static SubRecord.SubRecordTypes[] values()

org.apache.poi.hssf.record back to summary

public Interface SubRecord.SubRecordTypes.RecordConstructor<T extends SubRecord>

Annotations

@FunctionalInterface

Method Summary

Modifier and Type	Method and Description
public T	Returns: the created sub-record apply(LittleEndianInput the stream to read from in, int size, int the objectType field of the containing CommonObjectDataSubRecord, we need it to propagate to next sub-records as it defines what data follows cmoOt) read a sub-record from the supplied stream

Method Detail

apply	back to summary
public T apply(LittleEndianInput in, int size, int cmoOt) read a sub-record from the supplied stream Parameters in:LittleEndianInput the stream to read from cmoOt:int the objectType field of the containing CommonObjectDataSubRecord, we need it to propagate to next sub-records as it defines what data follows Returns:T the created sub-record

apply

back to summary

public T apply(LittleEndianInput in, int size, int cmoOt)

read a sub-record from the supplied stream

Parameters

in:LittleEndianInput: the stream to read from
cmoOt:int: the objectType field of the containing CommonObjectDataSubRecord, we need it to propagate to next sub-records as it defines what data follows

Returns:T

the created sub-record

org.apache.poi.hssf.record back to summary

private final Class SubRecord.UnknownSubRecord

Class Inheritance

extends SubRecord

java.lang.Object
org.apache.poi.hssf.record.SubRecord
org.apache.poi.hssf.record.SubRecord.UnknownSubRecord

Field Summary

Modifier and Type	Field and Description
private final byte[]	_data
private final int	_sid

Constructor Summary

Access	Constructor and Description
public	UnknownSubRecord(LittleEndianInput in, int size, int sid)

Method Summary

Modifier and Type	Method and Description
public SubRecord.UnknownSubRecord	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 void	serialize(LittleEndianOutput out) Implements abstract org.apache.poi.hssf.record.SubRecord.serialize.

Inherited from org.apache.poi.hssf.record.SubRecord:: createSubRecord getMaxRecordLength isTerminating serialize setMaxRecordLength toString

Field Detail

_data	back to summary
private final byte[] _data

_sid	back to summary
private final int _sid

Constructor Detail

UnknownSubRecord	back to summary
public UnknownSubRecord(LittleEndianInput in, int size, int sid)

Method Detail

copy	back to summary
public SubRecord.UnknownSubRecord copy() Implements abstract org.apache.poi.hssf.record.SubRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:SubRecord.UnknownSubRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public SubRecord.UnknownSubRecord copy()

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

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

Returns:SubRecord.UnknownSubRecord

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

a deep copy of the implementing class / instance

Annotations

@Override

getDataSize	back 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

getDataSize

back 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