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

public final Class DSFRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.BitField, .BitFieldFactory, .GenericRecordUtil, .LittleEndianOutput
Tells if this is a double stream file. (never applies to HSSF generated files)

Double Stream files contain both BIFF8 and BIFF7 workbooks.

Field Summary

Modifier and TypeField and Description
private int
_options

private static final BitField
biff5BookStreamFlag

public static final short
sid

Constructor Summary

AccessConstructor and Description
private
DSFRecord(DSFRecord other)

private
DSFRecord(int options)

public
DSFRecord(boolean isBiff5BookStreamPresent)

public
DSFRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public DSFRecord
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 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 boolean
isBiff5BookStreamPresent()

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

_optionsback to summary
private int _options
biff5BookStreamFlagback to summary
private static final BitField biff5BookStreamFlag
sidback to summary
public static final short sid

Constructor Detail

DSFRecordback to summary
private DSFRecord(DSFRecord other)
DSFRecordback to summary
private DSFRecord(int options)
DSFRecordback to summary
public DSFRecord(boolean isBiff5BookStreamPresent)
DSFRecordback to summary
public DSFRecord(RecordInputStream in)

Method Detail

copyback to summary
public DSFRecord copy()

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

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

Returns:DSFRecord

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.

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

isBiff5BookStreamPresentback to summary
public boolean isBiff5BookStreamPresent()
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