Package org.apache.poi.hssf.record
Class EOFRecord
- java.lang.Object
-
- org.apache.poi.hssf.record.RecordBase
-
- org.apache.poi.hssf.record.Record
-
- org.apache.poi.hssf.record.StandardRecord
-
- org.apache.poi.hssf.record.EOFRecord
-
- All Implemented Interfaces:
java.lang.Cloneable
public final class EOFRecord extends StandardRecord implements java.lang.Cloneable
End Of File record.Description: Marks the end of records belonging to a particular object in the HSSF File
REFERENCE: PG 307 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)
-
-
Field Summary
Fields Modifier and Type Field Description static int
ENCODED_SIZE
static EOFRecord
instance
static short
sid
-
Constructor Summary
Constructors Constructor Description EOFRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EOFRecord
clone()
protected int
getDataSize()
short
getSid()
return the non static version of the id for this record.void
serialize(LittleEndianOutput out)
Write the data content of this BIFF record.java.lang.String
toString()
get a string representation of the record (for biffview/debugging)-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
ENCODED_SIZE
public static final int ENCODED_SIZE
- See Also:
- Constant Field Values
-
instance
public static final EOFRecord instance
-
-
Constructor Detail
-
EOFRecord
public EOFRecord(RecordInputStream in)
- Parameters:
in
- unused (since this record has no data)
-
-
Method Detail
-
toString
public java.lang.String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
serialize
public void serialize(LittleEndianOutput out)
Description copied from class:StandardRecord
Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.The number of bytes written must equal the record size reported by
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()
- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
-