org.apache.poi.hssf.record

Class ObjectProtectRecord

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

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class ObjectProtectRecord
extends StandardRecord

Protect embedded object with the lamest "security" ever invented. This record tells "I want to protect my objects" with lame security. It appears in conjunction with the PASSWORD and PROTECT records as well as its scenario protect cousin.

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ObjectProtectRecord	copy()
protected int	getDataSize()
Map<String,Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
boolean	getProtect() get whether the sheet is protected or not
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	setProtect(boolean protect) set whether the sheet is protected or not

Methods inherited from class org.apache.poi.hssf.record.StandardRecord

getRecordSize, serialize

Methods inherited from class org.apache.poi.hssf.record.Record

cloneViaReserialise, serialize, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

ObjectProtectRecord

public ObjectProtectRecord()

ObjectProtectRecord

public ObjectProtectRecord(ObjectProtectRecord other)

ObjectProtectRecord

public ObjectProtectRecord(RecordInputStream in)

Method Detail

setProtect

public void setProtect(boolean protect)

set whether the sheet is protected or not

Parameters:

protect - whether to protect the sheet or not

getProtect

public boolean getProtect()

get whether the sheet is protected or not

Returns:

whether to protect the sheet or not

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 ObjectProtectRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

Returns:

a deep copy of the implementing class / instance

getGenericRecordType

public HSSFRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord

Specified by:

getGenericRecordType in class Record

getGenericProperties

public Map<String,Supplier<?>> getGenericProperties()