Package org.apache.poi.hssf.record
Class ProtectRecord
- 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.ProtectRecord
-
- All Implemented Interfaces:
org.apache.poi.common.Duplicatable
,GenericRecord
public final class ProtectRecord extends StandardRecord
Defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al ignore the password record entirely).
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description ProtectRecord(boolean isProtected)
ProtectRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProtectRecord
copy()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>
getGenericProperties()
HSSFRecordTypes
getGenericRecordType()
boolean
getProtect()
get whether the sheet is protected or notshort
getSid()
return the non static version of the id for this record.void
serialize(LittleEndianOutput out)
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
equals, 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
-
ProtectRecord
public ProtectRecord(boolean isProtected)
-
ProtectRecord
public ProtectRecord(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)
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
copy
public ProtectRecord copy()
- Specified by:
copy
in interfaceorg.apache.poi.common.Duplicatable
- Specified by:
copy
in classStandardRecord
-
getGenericRecordType
public HSSFRecordTypes getGenericRecordType()
- Specified by:
getGenericRecordType
in interfaceGenericRecord
- Specified by:
getGenericRecordType
in classRecord
-
getGenericProperties
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
-
-