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

GroupMarkerSubRecord

public class GroupMarkerSubRecord extends SubRecord
The group marker record is used as a position holder for groups.
author
Glen Stampoultzis (glens at apache.org)

Fields Summary
public static final short
sid
private byte[]
reserved
Constructors Summary
public GroupMarkerSubRecord()

    // would really love to know what goes in here.
public GroupMarkerSubRecord(RecordInputStream in)
Constructs a group marker record and sets its fields appropriately.

param
id id must be 0x00 or an exception will be throw upon validation
param
size 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()

        GroupMarkerSubRecord rec = new GroupMarkerSubRecord();
        rec.reserved = new byte[reserved.length];
        for ( int i = 0; i < reserved.length; i++ )
            rec.reserved[i] = reserved[i];
        return rec;
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

//        int pos = 0;
        reserved = in.readRemainder();
public intgetRecordSize()
Size of record (exluding 4 byte header)

        return 4 + reserved.length;
public shortgetSid()

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

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
        System.arraycopy(reserved, 0, data, offset + 4, getRecordSize() - 4);

        return getRecordSize();
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        String nl = System.getProperty("line.separator");
        buffer.append("[ftGmo]" + nl);
        buffer.append("  reserved = ").append(HexDump.toHex(reserved)).append(nl);
        buffer.append("[/ftGmo]" + nl);
        return buffer.toString();
protected voidvalidateSid(short id)
Checks the sid matches the expected side for this record

param
id the expected sid.

        if (id != sid)
        {
            throw new RecordFormatException("Not a Group Marker record");
        }