BOFRecord (POI API Documentation)

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

All Implemented Interfaces:

Duplicatable, GenericRecord
```
public final class BOFRecord
extends StandardRecord
```
Somewhat of a misnomer, its used for the beginning of a set of records that have a particular purpose or subject. Used in sheets and workbooks.

Field Summary

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

Constructor Summary

Constructors
Constructor and Description

BOFRecord()
Constructs an empty BOFRecord with no fields set.

BOFRecord(BOFRecord other)

BOFRecord(RecordInputStream in)

Constructors
Constructor and Description
`BOFRecord()` Constructs an empty BOFRecord with no fields set.
`BOFRecord(BOFRecord other)`
`BOFRecord(RecordInputStream in)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BOFRecord`	`copy()`
`static BOFRecord`	`createSheetBOF()`
`int`	`getBuild()` get the build that wrote this file
`int`	`getBuildYear()` Year of the build that wrote this file
`protected int`	`getDataSize()`
`java.util.Map<java.lang.String,java.util.function.Supplier<?>>`	`getGenericProperties()`
`HSSFRecordTypes`	`getGenericRecordType()`
`int`	`getHistoryBitMask()` get the history bit mask (not very useful)
`int`	`getRequiredVersion()` get the minimum version required to read this file
`short`	`getSid()` return the non static version of the id for this record.
`int`	`getType()` type of object this marks
`int`	`getVersion()` Version number - for BIFF8 should be 0x06
`void`	`serialize(LittleEndianOutput out)` Write the data content of this BIFF record.
`void`	`setBuild(int build)` build that wrote this file
`void`	`setBuildYear(int year)` Year of the build that wrote this file
`void`	`setHistoryBitMask(int bitmask)` set the history bit mask (not very useful)
`void`	`setRequiredVersion(int version)` set the minimum version required to read this file
`void`	`setType(int type)` type of object this marks
`void`	`setVersion(int version)` Version number - for BIFF8 should be 0x06

Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize

Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren

- Field Detail
  - sid
```
public static final short sid
```
    for BIFF8 files the BOF is 0x809. For earlier versions see biff2_sid biff3_sid biff4_sid biff5_sid
    
    See Also:
    
    Constant Field Values
  - biff2_sid
```
public static final short biff2_sid
```
    See Also:
    
    Constant Field Values
  - biff3_sid
```
public static final short biff3_sid
```
    See Also:
    
    Constant Field Values
  - biff4_sid
```
public static final short biff4_sid
```
    See Also:
    
    Constant Field Values
  - biff5_sid
```
public static final short biff5_sid
```
    See Also:
    
    Constant Field Values
  - VERSION
```
public static final int VERSION
```
    suggested default (0x0600 - BIFF8)
    
    See Also:
    
    Constant Field Values
  - BUILD
```
public static final int BUILD
```
    suggested default 0x10d3
    
    See Also:
    
    Constant Field Values
  - BUILD_YEAR
```
public static final int BUILD_YEAR
```
    suggested default 0x07CC (1996)
    
    See Also:
    
    Constant Field Values
  - HISTORY_MASK
```
public static final int HISTORY_MASK
```
    suggested default for a normal sheet (0x41)
    
    See Also:
    
    Constant Field Values
  - TYPE_WORKBOOK
```
public static final int TYPE_WORKBOOK
```
    See Also:
    
    Constant Field Values
  - TYPE_VB_MODULE
```
public static final int TYPE_VB_MODULE
```
    See Also:
    
    Constant Field Values
  - TYPE_WORKSHEET
```
public static final int TYPE_WORKSHEET
```
    See Also:
    
    Constant Field Values
  - TYPE_CHART
```
public static final int TYPE_CHART
```
    See Also:
    
    Constant Field Values
  - TYPE_EXCEL_4_MACRO
```
public static final int TYPE_EXCEL_4_MACRO
```
    See Also:
    
    Constant Field Values
  - TYPE_WORKSPACE_FILE
```
public static final int TYPE_WORKSPACE_FILE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BOFRecord
```
public BOFRecord()
```
    Constructs an empty BOFRecord with no fields set.
  - BOFRecord
```
public BOFRecord(BOFRecord other)
```
  - BOFRecord
```
public BOFRecord(RecordInputStream in)
```
- Method Detail
  - createSheetBOF
```
public static BOFRecord createSheetBOF()
```
  - setVersion
```
public void setVersion(int version)
```
    Version number - for BIFF8 should be 0x06
    
    Parameters:
    
    version - version to be set
    
    See Also:
    
    VERSION
  - setType
```
public void setType(int type)
```
    type of object this marks
    
    Parameters:
    
    type - type to be set
    
    See Also:
    
    TYPE_WORKBOOK, TYPE_VB_MODULE, TYPE_WORKSHEET, TYPE_CHART, TYPE_EXCEL_4_MACRO, TYPE_WORKSPACE_FILE
  - setBuild
```
public void setBuild(int build)
```
    build that wrote this file
    
    Parameters:
    
    build - build number to set
    
    See Also:
    
    BUILD
  - setBuildYear
```
public void setBuildYear(int year)
```
    Year of the build that wrote this file
    
    Parameters:
    
    year - build year to set
    
    See Also:
    
    BUILD_YEAR
  - setHistoryBitMask
```
public void setHistoryBitMask(int bitmask)
```
    set the history bit mask (not very useful)
    
    Parameters:
    
    bitmask - bitmask to set for the history
    
    See Also:
    
    HISTORY_MASK
  - setRequiredVersion
```
public void setRequiredVersion(int version)
```
    set the minimum version required to read this file
    
    Parameters:
    
    version - version to set
    
    See Also:
    
    VERSION
  - getVersion
```
public int getVersion()
```
    Version number - for BIFF8 should be 0x06
    
    Returns:
    
    version number of the generator of this file
    
    See Also:
    
    VERSION
  - getType
```
public int getType()
```
    type of object this marks
    
    Returns:
    
    type of object
    
    See Also:
    
    TYPE_WORKBOOK, TYPE_VB_MODULE, TYPE_WORKSHEET, TYPE_CHART, TYPE_EXCEL_4_MACRO, TYPE_WORKSPACE_FILE
  - getBuild
```
public int getBuild()
```
    get the build that wrote this file
    
    Returns:
    
    short build number of the generator of this file
    
    See Also:
    
    BUILD
  - getBuildYear
```
public int getBuildYear()
```
    Year of the build that wrote this file
    
    Returns:
    
    short build year of the generator of this file
    
    See Also:
    
    BUILD_YEAR
  - getHistoryBitMask
```
public int getHistoryBitMask()
```
    get the history bit mask (not very useful)
    
    Returns:
    
    int bitmask showing the history of the file (who cares!)
    
    See Also:
    
    HISTORY_MASK
  - getRequiredVersion
```
public int getRequiredVersion()
```
    get the minimum version required to read this file
    
    Returns:
    
    int least version that can read the file
    
    See Also:
    
    VERSION
  - 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
  - copy
```
public BOFRecord copy()
```
    Specified by:
    
    copy in interface Duplicatable
    
    Specified by:
    
    copy in class StandardRecord
    
    Returns:
    
    a deep copy of the implementing class / instance
  - getGenericRecordType
```
public HSSFRecordTypes getGenericRecordType()
```
    Specified by:
    
    getGenericRecordType in interface GenericRecord
    
    Specified by:
    
    getGenericRecordType in class Record
  - getGenericProperties
```
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
```

Class BOFRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.hssf.record.StandardRecord

Methods inherited from class org.apache.poi.hssf.record.Record

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

Field Detail

sid

biff2_sid

biff3_sid

biff4_sid

biff5_sid

VERSION

BUILD

BUILD_YEAR

HISTORY_MASK

TYPE_WORKBOOK

TYPE_VB_MODULE

TYPE_WORKSHEET

TYPE_CHART

TYPE_EXCEL_4_MACRO

TYPE_WORKSPACE_FILE

Constructor Detail

BOFRecord

BOFRecord

BOFRecord

Method Detail

createSheetBOF

setVersion

setType

setBuild

setBuildYear

setHistoryBitMask

setRequiredVersion

getVersion

getType

getBuild

getBuildYear

getHistoryBitMask

getRequiredVersion

serialize

getDataSize

getSid

copy

getGenericRecordType

getGenericProperties