Package loci.poi.hssf.record
Class FileSharingRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.FileSharingRecord
Title: FileSharing
Description: stores the encrypted readonly for a workbook (write protect) REFERENCE: PG 314 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 FileSharing record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()Clone this record.protected voidcalled by the constructor, should set class level fields.shortshortget the readonlyintgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.shortbytestatic shorthashPassword(String password) intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetPassword(short password) voidsetReadOnly(short readonly) set the readonly flagvoidsetUnknown(short unk) voidsetUsername(String username) voidsetUsernameLength(byte length) toString()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
-
FileSharingRecord
public FileSharingRecord() -
FileSharingRecord
Constructs a FileSharing 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
-
setReadOnly
public void setReadOnly(short readonly) set the readonly flag- Parameters:
readonly- 1 for true, not 1 for false
-
getReadOnly
public short getReadOnly()get the readonly- Returns:
- short representing if this is read only (1 = true)
-
setPassword
public void setPassword(short password) - Parameters:
password- hashed password
-
getPassword
public short getPassword()- Returns:
- password hashed with hashPassword() (very lame)
-
getUsernameLength
public byte getUsernameLength()- Returns:
- byte representing the length of the username field
-
setUsernameLength
public void setUsernameLength(byte length) - Parameters:
length-
-
getUsername
- Returns:
- username of the user that created the file
-
setUsername
- Parameters:
username- of the user that created the file
-
getUnknown
public short getUnknown()- Returns:
- short value of a "bonus field" in Excel that was not doc'd
-
setUnknown
public void setUnknown(short unk) - Parameters:
unk- field value to set (bonus field that is not doc'd)
-
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.
-