org.apache.poi.hssf.record

## Class CodepageRecord

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

- All Implemented Interfaces:
    Duplicatable

      public final class CodepageRecord
      extends StandardRecord

  The default characterset. for the workbook

  Use `CodePageUtil` to turn these values into Java code pages to encode/decode strings.

  Version:
    2.0-pre

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static short` | `CODEPAGE` Excel 97+ (Biff 8) should always store strings as UTF-16LE or compressed versions of that.
    `static short` | `sid`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `CodepageRecord()`
    `CodepageRecord(CodepageRecord other)`
    `CodepageRecord(RecordInputStream in)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `CodepageRecord` | `copy()`
    `short` | `getCodepage()` get the codepage for this workbook
    `protected int` | `getDataSize()`
    `short` | `getSid()` return the non static version of the id for this record.
    `void` | `serialize(LittleEndianOutput out)` Write the data content of this BIFF record.
    `void` | `setCodepage(short cp)` set the codepage for this workbook
    `java.lang.String` | `toString()` get a string representation of the record (for biffview/debugging)

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

      `getRecordSize, serialize`

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

      `cloneViaReserialise, serialize`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### sid

          public static final short sid

      See Also:
        Constant Field Values

    - #### CODEPAGE

          public static final short CODEPAGE

      Excel 97+ (Biff 8) should always store strings as UTF-16LE or compressed versions of that. As such, this should always be 0x4b0 = UTF_16, except for files coming from older versions.
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### CodepageRecord

          public CodepageRecord()

    - #### CodepageRecord

          public CodepageRecord(CodepageRecord other)

    - #### CodepageRecord

          public CodepageRecord(RecordInputStream in)

  - ### Method Detail

    - #### setCodepage

          public void setCodepage(short cp)

      set the codepage for this workbook
      Parameters:
        `cp` - the codepage to set
      See Also:
        `CODEPAGE`

    - #### getCodepage

          public short getCodepage()

      get the codepage for this workbook
      Returns:
        codepage - the codepage to set
      See Also:
        `CODEPAGE`

    - #### toString

          public java.lang.String toString()

      Description copied from class: `Record`
      get a string representation of the record (for biffview/debugging)
      Overrides:
        `toString` in class `Record`

    - #### 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 CodepageRecord copy()

      Specified by:
        `copy` in interface `Duplicatable`
      Specified by:
        `copy` in class `StandardRecord`
      Returns:
        a deep copy of the implementing class / instance

Copyright 2020 The Apache Software Foundation or its licensors, as applicable.