Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class PasswordRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)

Field Summary

Modifier and TypeField and Description
private int
field_1_password

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
PasswordRecord(int password)

public
PasswordRecord(PasswordRecord other)

public
PasswordRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public PasswordRecord
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Clone this record.

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public int

Returns:

short representing the password
getPassword()

get the password

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

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

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
setPassword(int
representing the password
password)

set the password

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

field_1_passwordback to summary
private int field_1_password
sidback to summary
public static final short sid

Constructor Detail

PasswordRecordback to summary
public PasswordRecord(int password)
PasswordRecordback to summary
public PasswordRecord(PasswordRecord other)
PasswordRecordback to summary
public PasswordRecord(RecordInputStream in)

Method Detail

copyback to summary
public PasswordRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Clone this record.

Returns:PasswordRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getPasswordback to summary
public int getPassword()

get the password

Returns:int

short representing the password

getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

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

Returns:short

he id for this record

serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

setPasswordback to summary
public void setPassword(int password)

set the password

Parameters
password:int

representing the password