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

public final Class CountryRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Country Record (aka WIN.INI country) - used for localization

Currently HSSF always sets this to 1 and it seems to work fine even in Germany.

Version
2.0-pre

Field Summary

Modifier and TypeField and Description
private short
field_1_default_country

private short
field_2_current_country

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
CountryRecord()

public
CountryRecord(CountryRecord other)

public
CountryRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public CountryRecord
copy()

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

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

public short

Returns:

country ID (1 = US)
getCurrentCountry()

gets the current country

protected int
getDataSize()

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

public short

Returns:

country ID (1 = US)
getDefaultCountry()

gets the default country

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
setCurrentCountry(short
ID to set (1 = US)
country)

sets the current country

public void
setDefaultCountry(short
ID to set (1 = US)
country)

sets the default country

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

Field Detail

field_1_default_countryback to summary
private short field_1_default_country
field_2_current_countryback to summary
private short field_2_current_country
sidback to summary
public static final short sid

Constructor Detail

CountryRecordback to summary
public CountryRecord()
CountryRecordback to summary
public CountryRecord(CountryRecord other)
CountryRecordback to summary
public CountryRecord(RecordInputStream in)

Method Detail

copyback to summary
public CountryRecord copy()

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

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

Returns:CountryRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getCurrentCountryback to summary
public short getCurrentCountry()

gets the current country

Returns:short

country ID (1 = US)

getDataSizeback to summary
protected int getDataSize()

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

getDefaultCountryback to summary
public short getDefaultCountry()

gets the default country

Returns:short

country ID (1 = US)

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

setCurrentCountryback to summary
public void setCurrentCountry(short country)

sets the current country

Parameters
country:short

ID to set (1 = US)

setDefaultCountryback to summary
public void setDefaultCountry(short country)

sets the default country

Parameters
country:short

ID to set (1 = US)