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

All Implemented Interfaces:

Duplicatable

public final class PasswordRecord
extends StandardRecord

Stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
PasswordRecord(int password)
PasswordRecord(PasswordRecord other)
PasswordRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
PasswordRecord	clone() Deprecated.
PasswordRecord	copy() Clone this record.
protected int	getDataSize()
int	getPassword() get the password
short	getSid() return the non static version of the id for this record.
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(PasswordRecord other)

PasswordRecord

public PasswordRecord(RecordInputStream in)

Method Detail

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 number of bytes written must equal the record size reported by RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Specified by:

serialize in class StandardRecord

Parameters:

out - the output object

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

Returns:

he id for this record

clone

@Deprecated
 @Removal(version="5.0.0")
public PasswordRecord clone()

Deprecated.

Overrides:

clone in class java.lang.Object

copy

public PasswordRecord copy()

Clone this record.

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

Returns:

a deep copy of the implementing class / instance