org.apache.poi.hssf.record

Class BackupRecord

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.BackupRecord

All Implemented Interfaces:

Duplicatable

public final class BackupRecord
extends StandardRecord

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

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
BackupRecord()
BackupRecord(BackupRecord other)
BackupRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
BackupRecord	copy()
short	getBackup() get the backup flag
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.
void	setBackup(short backup) set the backup flag (0,1)
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

BackupRecord

public BackupRecord()

BackupRecord

public BackupRecord(BackupRecord other)

BackupRecord

public BackupRecord(RecordInputStream in)

Method Detail

setBackup

public void setBackup(short backup)

set the backup flag (0,1)

Parameters:

backup - backup flag

getBackup

public short getBackup()

get the backup flag

Returns:

short 0/1 (off/on)

toString

public java.lang.String toString()

Description copied from class: Record

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class Record

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 class StandardRecord

Parameters:

out - the output object

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class StandardRecord

getSid

public short getSid()

Description copied from class: Record

return the non static version of the id for this record.

Specified by:

getSid in class Record

Returns:

he id for this record

copy

public BackupRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

Returns:

a deep copy of the implementing class / instance