org.apache.poi.hssf.record
Class PasswordRecord

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.PasswordRecord

public final class PasswordRecord
extends StandardRecord

Title: Password Record (0x0013)

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)

Author:

Andrew C. Oliver (acoliver at apache dot org)

Field Summary

static short

sid

Constructor Summary

PasswordRecord(int password)

PasswordRecord(RecordInputStream in)

Method Summary

java.lang.Object	clone() Clone this record.
protected int	getDataSize()
int	getPassword() get the password
short	getSid() return the non static version of the id for this record.
static short	hashPassword(java.lang.String password)
void	serialize(LittleEndianOutput out) Write the data content of this BIFF record.
void	setPassword(int password) set the password
java.lang.String	toString() get a string representation of the record (for biffview/debugging)

Methods inherited from class org.apache.poi.hssf.record.StandardRecord

getRecordSize, serialize

Methods inherited from class org.apache.poi.hssf.record.Record

cloneViaReserialise, serialize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

PasswordRecord

public PasswordRecord(int password)

PasswordRecord

public PasswordRecord(RecordInputStream in)

Method Detail

hashPassword

public static short hashPassword(java.lang.String password)

setPassword

public void setPassword(int password)

set the password

Parameters:

password - representing the password

getPassword

public int getPassword()

get the password

Returns:

short representing the password

toString

public java.lang.String toString()

Description copied from class: Record

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class Record

serialize

public void serialize(LittleEndianOutput out)

Description copied from class: StandardRecord

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.
The subclass must write the exact number of bytes as reported by RecordBase.getRecordSize()}

Specified by:

serialize in class StandardRecord

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class StandardRecord

getSid

public short getSid()

Description copied from class: Record

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

Specified by:

getSid in class Record

clone

public java.lang.Object clone()

Clone this record.

Overrides:

clone in class Record