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

public final Class CodepageRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.CodePageUtil, .GenericRecordUtil, .LittleEndianOutput
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

Modifier and TypeField and Description
public static final short
CODEPAGE

Excel 97+ (Biff 8) should always store strings as UTF-16LE or compressed versions of that.

private short
field_1_codepage

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
CodepageRecord()

public
CodepageRecord(CodepageRecord other)

public
CodepageRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public CodepageRecord
copy()

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

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

public short

Returns:

codepage - the codepage to set
getCodepage()

get the codepage for this workbook

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 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
setCodepage(short
the codepage to set
cp)

set the codepage for this workbook

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

CODEPAGEback to summary
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.

field_1_codepageback to summary
private short field_1_codepage
sidback to summary
public static final short sid

Constructor Detail

CodepageRecordback to summary
public CodepageRecord()
CodepageRecordback to summary
public CodepageRecord(CodepageRecord other)
CodepageRecordback to summary
public CodepageRecord(RecordInputStream in)

Method Detail

copyback to summary
public CodepageRecord copy()

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

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

Returns:CodepageRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getCodepageback to summary
public short getCodepage()

get the codepage for this workbook

Returns:short

codepage - the codepage to set

See Also
CODEPAGE
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

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

setCodepageback to summary
public void setCodepage(short cp)

set the codepage for this workbook

Parameters
cp:short

the codepage to set

See Also
CODEPAGE