FileDocCategorySizeDatePackage
EOFRecord.javaAPI DocApache Poi 3.0.12802Mon Jan 01 12:39:40 GMT 2007org.apache.poi.hssf.record

EOFRecord

public class EOFRecord extends Record
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)

author
Andrew C. Oliver (acoliver at apache dot org)
author
Jason Height (jheight at chariot dot net dot au)
version
2.0-pre

Fields Summary
public static final short
sid
Constructors Summary
public EOFRecord()
public EOFRecord(RecordInputStream in)
Constructs a EOFRecord record and sets its fields appropriately.

param
id id must be 0x0A or an exception will be throw upon validation
param
size the size of the data area of the record
param
data data of the record (should not contain sid/len)

        super(in);
Methods Summary
public java.lang.Objectclone()

      EOFRecord rec = new EOFRecord();
      return rec;
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)
public intgetRecordSize()

        return 4;
public shortgetSid()

        return sid;
public intserialize(int offset, byte[] data)

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset,
                              (( short ) 0));   // no record info
        return getRecordSize();
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[EOF]\n");
        buffer.append("[/EOF]\n");
        return buffer.toString();
protected voidvalidateSid(short id)

        if (id != sid)
        {
            throw new RecordFormatException("NOT An EOF RECORD");
        }