Package org.apache.poi.hssf.record

Class BOFRecord

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:
org.apache.poi.common.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 Details

  • Constructor Details

    • BOFRecord

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

    • BOFRecord

      public BOFRecord(BOFRecord other)

    • BOFRecord

      public BOFRecord(RecordInputStream in)

  • Method Details

    • 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:

    • setType

      public void setType(int type)
      type of object this marks
      Parameters:
      type - type to be set
      See Also:

    • setBuild

      public void setBuild(int build)
      build that wrote this file
      Parameters:
      build - build number to set
      See Also:

    • setBuildYear

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

    • setHistoryBitMask

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

    • setRequiredVersion

      public void setRequiredVersion(int version)
      set the minimum version required to read this file
      Parameters:
      version - version to set
      See Also:

    • getVersion

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

    • getType

      public int getType()
      type of object this marks
      Returns:
      type of object
      See Also:

    • getBuild

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

    • getBuildYear

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

    • 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:

    • getRequiredVersion

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

    • serialize

      public void serialize(LittleEndianOutput out)

    • 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 org.apache.poi.common.Duplicatable
      Specified by:
      copy in class StandardRecord

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

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