Top Description Constructors Methods
org.apache.poi.hssf.record

public abstract Class Record

extends RecordBase
implements Duplicatable, GenericRecord
Class Inheritance
All Implemented Interfaces
org.apache.poi.common.usermodel.GenericRecord, org.apache.poi.common.Duplicatable
Known Direct Subclasses
org.apache.poi.hssf.record.StandardRecord, org.apache.poi.hssf.record.cont.ContinuableRecord, org.apache.poi.hssf.eventusermodel.dummyrecord.DummyRecordBase, org.apache.poi.hssf.record.AbstractEscherHolderRecord, org.apache.poi.hssf.record.LabelRecord, org.apache.poi.hssf.record.ObjRecord
Imports
java.io.IOException, org.apache.commons.io.input.UnsynchronizedByteArrayInputStream, org.apache.poi.common.Duplicatable, org.apache.poi.common.usermodel.GenericRecord, org.apache.poi.util.GenericRecordJsonWriter

All HSSF Records inherit from this class.

Constructor Summary

AccessConstructor and Description
protected
protected
Record(Record other)

Method Summary

Modifier and TypeMethod and Description
public Record

Returns:

the cloned current record
cloneViaReserialise
()

Clone the current record, via a call to serialize it, and another to create a new record from the bytes.

public abstract Record
public abstract HSSFRecordTypes
public abstract short

Returns:

he id for this record
getSid
()

return the non static version of the id for this record.

public final byte[]

Returns:

byte array containing instance data
serialize
()

called by the class that is responsible for writing this sucker.

public final String
toString()

Overrides java.lang.Object.toString.

get a string representation of the record (for biffview/debugging)

Inherited from org.apache.poi.hssf.record.RecordBase:
getRecordSizeserialize

Constructor Detail

Recordback to summary
protected Record()
Recordback to summary
protected Record(Record other)

Method Detail

cloneViaReserialiseback to summary
public Record cloneViaReserialise()

Clone the current record, via a call to serialize it, and another to create a new record from the bytes. May only be used for classes which don't have internal counts / ids in them. For those which do, a full model-aware cloning is needed, which allocates new ids / counts as needed.

Returns:Record

the cloned current record

copyback to summary
public abstract Record copy()

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

Returns:Record

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

a deep copy of the implementing class / instance

getGenericRecordTypeback to summary
public abstract HSSFRecordTypes getGenericRecordType()

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

Annotations
@Override
getSidback to summary
public abstract short getSid()

return the non static version of the id for this record.

Returns:short

he id for this record

serializeback to summary
public final byte[] serialize()

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.

Returns:byte[]

byte array containing instance data

toStringback to summary
public final String toString()

Overrides java.lang.Object.toString.

get a string representation of the record (for biffview/debugging)

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations
@Override