Package org.apache.poi.hssf.record.cont
Class ContinuableRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.cont.ContinuableRecord
- Direct Known Subclasses:
ExtSSTRecord
,NameRecord
,SSTRecord
,StringRecord
,TextObjectRecord
Common superclass of all records that can produce
ContinueRecord
s while being serialized.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal int
gives the current serialized size of the record.final int
serialize
(int offset, byte[] data) called by the class that is responsible for writing this sucker.protected abstract void
Serializes this record's content to the supplied data output.
-
Constructor Details
-
ContinuableRecord
protected ContinuableRecord()
-
-
Method Details
-
serialize
Serializes this record's content to the supplied data output.The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so only BIFF data should be written by this method. Simple data types can be written with the standard
LittleEndianOutput
methods. Methods fromContinuableRecordOutput
can be used to serialize strings (withContinueRecord
s being written as required). If necessary, implementors can explicitly startContinueRecord
s (regardless of the amount of remaining space).- Parameters:
out
- a data output stream
-
getRecordSize
public final int getRecordSize()Description copied from class:RecordBase
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Specified by:
getRecordSize
in classRecordBase
- Returns:
- the total length of the encoded record(s)
(Note - if any
ContinueRecord
is required, this result includes the size of those too)
-
serialize
public final int serialize(int offset, byte[] data) Description copied from class:RecordBase
called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.- Specified by:
serialize
in classRecordBase
- Parameters:
offset
- to begin writing atdata
- byte array containing instance data- Returns:
- number of bytes written
-