Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class ProtectionRev4Record

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.BitField, .BitFieldFactory, .GenericRecordUtil, .LittleEndianOutput
Describes whether this is a protected shared/tracked workbook

Field Summary

Modifier and TypeField and Description
private int
_options

private static final BitField
protectedFlag

public static final short
sid

Constructor Summary

AccessConstructor and Description
private
ProtectionRev4Record(int options)

private
ProtectionRev4Record(ProtectionRev4Record other)

public
ProtectionRev4Record(boolean protect)

public
ProtectionRev4Record(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public ProtectionRev4Record
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public boolean

Returns:

whether to protect the workbook or not
getProtect()

get whether the this is protected shared/tracked workbook or not

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

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

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
setProtect(boolean
whether to protect the workbook or not
protect)

set whether the this is protected shared/tracked workbook or not

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

_optionsback to summary
private int _options
protectedFlagback to summary
private static final BitField protectedFlag
sidback to summary
public static final short sid

Constructor Detail

ProtectionRev4Recordback to summary
private ProtectionRev4Record(int options)
ProtectionRev4Recordback to summary
private ProtectionRev4Record(ProtectionRev4Record other)
ProtectionRev4Recordback to summary
public ProtectionRev4Record(boolean protect)
ProtectionRev4Recordback to summary
public ProtectionRev4Record(RecordInputStream in)

Method Detail

copyback to summary
public ProtectionRev4Record copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:ProtectionRev4Record

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

Annotations
@Override
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getProtectback to summary
public boolean getProtect()

get whether the this is protected shared/tracked workbook or not

Returns:boolean

whether to protect the workbook or not

getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

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

Returns:short

he id for this record

Annotations
@Override
serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

Annotations
@Override
setProtectback to summary
public void setProtect(boolean protect)

set whether the this is protected shared/tracked workbook or not

Parameters
protect:boolean

whether to protect the workbook or not