Package loci.poi.hssf.record
Class PasswordRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.PasswordRecord
Title: Password Record
Description: stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption) REFERENCE: PG 371 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a Password record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()Clone this record.protected voidcalled by the constructor, should set class level fields.shortget the passwordintgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.static shorthashPassword(String password) intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetPassword(short password) set the passwordtoString()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
-
PasswordRecord
public PasswordRecord() -
PasswordRecord
Constructs a Password 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
-
hashPassword
-
setPassword
public void setPassword(short password) set the password- Parameters:
password- representing the password
-
getPassword
public short getPassword()get the password- Returns:
- short representing the password
-
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
Clone this record.
-