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

public final Class FilePassRecord

extends StandardRecord
Class Inheritance
Imports
java.io.IOException, java.util.Map, java.util.function.Supplier, org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream, org.apache.poi.EncryptedDocumentException, org.apache.poi.poifs.crypt.EncryptionInfo, .EncryptionMode, org.apache.poi.poifs.crypt.binaryrc4.BinaryRC4EncryptionHeader, .BinaryRC4EncryptionVerifier, org.apache.poi.poifs.crypt.cryptoapi.CryptoAPIEncryptionHeader, .CryptoAPIEncryptionVerifier, org.apache.poi.poifs.crypt.xor.XOREncryptionHeader, .XOREncryptionVerifier, org.apache.poi.util.GenericRecordUtil, .LittleEndianByteArrayOutputStream, .LittleEndianOutput, .LittleEndianOutputStream
File Pass Record (0x002F)

Indicates that the record after this record are encrypted.

Field Summary

Modifier and TypeField and Description
private static final int
ENCRYPTION_OTHER

private static final int
ENCRYPTION_XOR

private final EncryptionInfo
encryptionInfo

private final int
encryptionType

public static final short
sid

Constructor Summary

AccessConstructor and Description
private
FilePassRecord(FilePassRecord other)

public
FilePassRecord(EncryptionMode encryptionMode)

public
FilePassRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public FilePassRecord
copy()

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

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

protected int
getDataSize()

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

public EncryptionInfo
getEncryptionInfo()

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

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

Field Detail

ENCRYPTION_OTHERback to summary
private static final int ENCRYPTION_OTHER
ENCRYPTION_XORback to summary
private static final int ENCRYPTION_XOR
encryptionInfoback to summary
private final EncryptionInfo encryptionInfo
encryptionTypeback to summary
private final int encryptionType
sidback to summary
public static final short sid

Constructor Detail

FilePassRecordback to summary
private FilePassRecord(FilePassRecord other)
FilePassRecordback to summary
public FilePassRecord(EncryptionMode encryptionMode)
FilePassRecordback to summary
public FilePassRecord(RecordInputStream in)

Method Detail

copyback to summary
public FilePassRecord copy()

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

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

Returns:FilePassRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

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

Annotations
@Override
getEncryptionInfoback to summary
public EncryptionInfo getEncryptionInfo()
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
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

Annotations
@Override
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

Annotations
@SuppressWarnings:resource
@Override