Package loci.poi.hssf.record
Class ProtectRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.ProtectRecord
Title: Protect Record
Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)
(kindly ask the US government to stop having arcane stupid encryption laws and we'll support it)
(after all terrorists will all use US-legal encrypton right??)
HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al ignore the password record entirely). REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Author:
- Andrew C. Oliver (acoliver at apache dot org)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a Protect record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.booleanget whether the sheet is protected or notintgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetProtect(boolean protect) set whether the sheet is protected or nottoString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.Methods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
ProtectRecord
public ProtectRecord() -
ProtectRecord
Constructs a Protect record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Description copied from class:Recordcalled by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
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
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array. -
getRecordSize
public int getRecordSize()Description copied from class:Recordgives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-