Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.BOFRecord

Field Summary

Modifier and Type	Field and Description
public static final short	biff2_sid
public static final short	biff3_sid
public static final short	biff4_sid
public static final short	biff5_sid
public static final int	BUILD suggested default 0x10d3
public static final int	BUILD_YEAR suggested default 0x07CC (1996)
private int	field_1_version
private int	field_2_type
private int	field_3_build
private int	field_4_year
private int	field_5_history
private int	field_6_rversion
public static final int	HISTORY_MASK suggested default for a normal sheet (0x41)
public static final short	sid for BIFF8 files the BOF is 0x809.
public static final int	TYPE_CHART
public static final int	TYPE_EXCEL_4_MACRO
public static final int	TYPE_VB_MODULE
public static final int	TYPE_WORKBOOK
public static final int	TYPE_WORKSHEET
public static final int	TYPE_WORKSPACE_FILE
public static final int	VERSION suggested default (0x0600 - BIFF8)

Constructor Summary

Access	Constructor and Description
public	BOFRecord() Constructs an empty BOFRecord with no fields set.
public	BOFRecord(BOFRecord other)
private	BOFRecord(int type)
public	BOFRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public BOFRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
public static BOFRecord	createSheetBOF()
public int	Returns: short build number of the generator of this file getBuild() get the build that wrote this file
public int	Returns: short build year of the generator of this file getBuildYear() Year of the build that wrote this file
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: int bitmask showing the history of the file (who cares!) getHistoryBitMask() get the history bit mask (not very useful)
public int	Returns: int least version that can read the file getRequiredVersion() get the minimum version required to read this file
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public int	Returns: type of object getType() type of object this marks
private String	getTypeName()
public int	Returns: version number of the generator of this file getVersion() Version number - for BIFF8 should be 0x06
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	setBuild(int build number to set build) build that wrote this file
public void	setBuildYear(int build year to set year) Year of the build that wrote this file
public void	setHistoryBitMask(int bitmask to set for the history bitmask) set the history bit mask (not very useful)
public void	setRequiredVersion(int version to set version) set the minimum version required to read this file
public void	setType(int type to be set type) type of object this marks
public void	setVersion(int version to be set version) Version number - for BIFF8 should be 0x06

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

Field Detail

biff2_sid	back to summary
public static final short biff2_sid

biff3_sid	back to summary
public static final short biff3_sid

biff4_sid	back to summary
public static final short biff4_sid

biff5_sid	back to summary
public static final short biff5_sid

BUILD	back to summary
public static final int BUILD suggested default 0x10d3

BUILD_YEAR	back to summary
public static final int BUILD_YEAR suggested default 0x07CC (1996)

field_1_version	back to summary
private int field_1_version

field_2_type	back to summary
private int field_2_type

field_3_build	back to summary
private int field_3_build

field_4_year	back to summary
private int field_4_year

field_5_history	back to summary
private int field_5_history

field_6_rversion	back to summary
private int field_6_rversion

HISTORY_MASK	back to summary
public static final int HISTORY_MASK suggested default for a normal sheet (0x41)

sid	back to summary
public static final short sid for BIFF8 files the BOF is 0x809. For earlier versions see `biff2_sid` `biff3_sid` `biff4_sid` `biff5_sid`

TYPE_CHART	back to summary
public static final int TYPE_CHART

TYPE_EXCEL_4_MACRO	back to summary
public static final int TYPE_EXCEL_4_MACRO

TYPE_VB_MODULE	back to summary
public static final int TYPE_VB_MODULE

TYPE_WORKBOOK	back to summary
public static final int TYPE_WORKBOOK

TYPE_WORKSHEET	back to summary
public static final int TYPE_WORKSHEET

TYPE_WORKSPACE_FILE	back to summary
public static final int TYPE_WORKSPACE_FILE

VERSION	back to summary
public static final int VERSION suggested default (0x0600 - BIFF8)

Constructor Detail

BOFRecord	back to summary
public BOFRecord() Constructs an empty BOFRecord with no fields set.

BOFRecord	back to summary
public BOFRecord(BOFRecord other)

BOFRecord	back to summary
private BOFRecord(int type)

BOFRecord	back to summary
public BOFRecord(RecordInputStream in)

Method Detail

copy	back to summary
public BOFRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:BOFRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public BOFRecord copy()

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

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

Returns:BOFRecord

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

a deep copy of the implementing class / instance

Annotations

@Override

createSheetBOF	back to summary
public static BOFRecord createSheetBOF()

getBuild back to summary

getBuild	back to summary
public int getBuild() get the build that wrote this file Returns:int short build number of the generator of this file See Also `BUILD`

public int getBuild()

get the build that wrote this file

Returns:int: short build number of the generator of this file
See Also: BUILD

getBuildYear back to summary

getBuildYear	back to summary
public int getBuildYear() Year of the build that wrote this file Returns:int short build year of the generator of this file See Also `BUILD_YEAR`

public int getBuildYear()

Year of the build that wrote this file

Returns:int: short build year of the generator of this file
See Also: BUILD_YEAR

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

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

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

Annotations

@Override

getGenericRecordType	back 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

getGenericRecordType

back 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

getHistoryBitMask back to summary

getHistoryBitMask	back to summary
public int getHistoryBitMask() get the history bit mask (not very useful) Returns:int int bitmask showing the history of the file (who cares!) See Also `HISTORY_MASK`

public int getHistoryBitMask()

get the history bit mask (not very useful)

Returns:int: int bitmask showing the history of the file (who cares!)
See Also: HISTORY_MASK

getRequiredVersion back to summary

getRequiredVersion	back to summary
public int getRequiredVersion() get the minimum version required to read this file Returns:int int least version that can read the file See Also `VERSION`

public int getRequiredVersion()

get the minimum version required to read this file

Returns:int: int least version that can read the file
See Also: VERSION

getSid	back 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

getSid

back 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

getType back to summary

getType	back to summary
public int getType() type of object this marks Returns:int type of object See Also `TYPE_WORKBOOK`, `TYPE_VB_MODULE`, `TYPE_WORKSHEET`, `TYPE_CHART`, `TYPE_EXCEL_4_MACRO`, `TYPE_WORKSPACE_FILE`

public int getType()

type of object this marks

Returns:int: type of object
See Also: TYPE_WORKBOOK, TYPE_VB_MODULE, TYPE_WORKSHEET, TYPE_CHART, TYPE_EXCEL_4_MACRO, TYPE_WORKSPACE_FILE

getTypeName	back to summary
private String getTypeName()

getVersion back to summary

getVersion	back to summary
public int getVersion() Version number - for BIFF8 should be 0x06 Returns:int version number of the generator of this file See Also `VERSION`

public int getVersion()

Version number - for BIFF8 should be 0x06

Returns:int: version number of the generator of this file
See Also: VERSION

serialize back to summary

serialize	back 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

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

setBuild back to summary

setBuild	back to summary
public void setBuild(int build) build that wrote this file Parameters build:int build number to set See Also `BUILD`

public void setBuild(int build)

build that wrote this file

Parameters

build:int: build number to set

See Also

BUILD

setBuildYear back to summary

setBuildYear	back to summary
public void setBuildYear(int year) Year of the build that wrote this file Parameters year:int build year to set See Also `BUILD_YEAR`

public void setBuildYear(int year)

Year of the build that wrote this file

Parameters

year:int: build year to set

See Also

BUILD_YEAR

setHistoryBitMask back to summary

setHistoryBitMask	back to summary
public void setHistoryBitMask(int bitmask) set the history bit mask (not very useful) Parameters bitmask:int bitmask to set for the history See Also `HISTORY_MASK`

public void setHistoryBitMask(int bitmask)

set the history bit mask (not very useful)

Parameters

bitmask:int: bitmask to set for the history

See Also

HISTORY_MASK

setRequiredVersion back to summary

setRequiredVersion	back to summary
public void setRequiredVersion(int version) set the minimum version required to read this file Parameters version:int version to set See Also `VERSION`

public void setRequiredVersion(int version)

set the minimum version required to read this file

Parameters

version:int: version to set

See Also

VERSION

setType back to summary

setType	back to summary
public void setType(int type) type of object this marks Parameters type:int type to be set See Also `TYPE_WORKBOOK`, `TYPE_VB_MODULE`, `TYPE_WORKSHEET`, `TYPE_CHART`, `TYPE_EXCEL_4_MACRO`, `TYPE_WORKSPACE_FILE`

public void setType(int type)

type of object this marks

Parameters

type:int: type to be set

setVersion back to summary

setVersion	back to summary
public void setVersion(int version) Version number - for BIFF8 should be 0x06 Parameters version:int version to be set See Also `VERSION`

public void setVersion(int version)

Version number - for BIFF8 should be 0x06

Parameters

version:int: version to be set

See Also

VERSION

public final Class BOFRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail