org.apache.poi.hssf.record.cont
Class ContinuableRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.cont.ContinuableRecord
Direct Known Subclasses:
SSTRecord, StringRecord, TextObjectRecord

public abstract class ContinuableRecord
extends Record

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

Author:
Josh Micich

Method Summary
 int getRecordSize()
          gives the current serialized size of the record.
 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
clone, cloneViaReserialise, getSid, serialize, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

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