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

All Implemented Interfaces:

org.apache.poi.common.Duplicatable, GenericRecord

Direct Known Subclasses:

ExtSSTRecord, NameRecord, SSTRecord, StringRecord, TextObjectRecord

public abstract class ContinuableRecord
extends Record

Common superclass of all records that can produce ContinueRecords while being serialized.

Method Summary

Modifier and Type	Method	Description
final int	getRecordSize()	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.

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

cloneViaReserialise, copy, getGenericRecordType, getSid, serialize, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren, getGenericProperties

Method Details

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 class RecordBase

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 class RecordBase

Parameters:

offset - to begin writing at

data - byte array containing instance data

Returns:

number of bytes written