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

UnitsRecord

public class UnitsRecord extends Record
The units record describes units. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
author
Glen Stampoultzis (glens at apache.org)

Fields Summary
public static final short
sid
private short
field_1_units
Constructors Summary
public UnitsRecord()



     
    

    
public UnitsRecord(RecordInputStream in)
Constructs a Units record and sets its fields appropriately.

param
id id must be 0x1001 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()

        UnitsRecord rec = new UnitsRecord();
    
        rec.field_1_units = field_1_units;
        return rec;
    
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_units                  = in.readShort();

    
public intgetRecordSize()
Size of record (exluding 4 byte header)

        return 4  + 2;
    
public shortgetSid()

        return sid;
    
public shortgetUnits()
Get the units field for the Units record.

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

        int pos = 0;

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

        LittleEndian.putShort(data, 4 + offset + pos, field_1_units);

        return getRecordSize();
    
public voidsetUnits(short field_1_units)
Set the units field for the Units record.

        this.field_1_units = field_1_units;
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[UNITS]\n");
        buffer.append("    .units                = ")
            .append("0x").append(HexDump.toHex(  getUnits ()))
            .append(" (").append( getUnits() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

        buffer.append("[/UNITS]\n");
        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 Units record");
        }