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

BackupRecord

public class BackupRecord extends Record
Title: Backup Record

Description: Boolean specifying whether the GUI should store a backup of the file.

REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

author
Andrew C. Oliver (acoliver at apache dot org)
version
2.0-pre

Fields Summary
public static final short
sid
private short
field_1_backup
Constructors Summary
public BackupRecord()

   // = 0;

     
    
    
public BackupRecord(RecordInputStream in)
Constructs a BackupRecord and sets its fields appropriately

param
id id must be 0x40 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
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_backup = in.readShort();
    
public shortgetBackup()
get the backup flag

return
short 0/1 (off/on)

        return field_1_backup;
    
public intgetRecordSize()

        return 6;
    
public shortgetSid()

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

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset,
                              (( short ) 0x02));   // 2 bytes (6 total)
        LittleEndian.putShort(data, 4 + offset, getBackup());
        return getRecordSize();
    
public voidsetBackup(short backup)
set the backup flag (0,1)

param
backup backup flag

        field_1_backup = backup;
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[BACKUP]\n");
        buffer.append("    .backup          = ")
            .append(Integer.toHexString(getBackup())).append("\n");
        buffer.append("[/BACKUP]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

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