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

public final Class StringRecord

extends ContinuableRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.hssf.record.cont.ContinuableRecord, .ContinuableRecordOutput, org.apache.poi.util.GenericRecordUtil, .StringUtil
STRING (0x0207)

Stores the cached result of a text formula

Field Summary

Modifier and TypeField and Description
private boolean
_is16bitUnicode

private String
_text

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
StringRecord()

public
StringRecord(StringRecord other)

public
StringRecord(RecordInputStream
the RecordInputStream to read the record from
in)

Method Summary

Modifier and TypeMethod and Description
public StringRecord
copy()

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

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

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 String

Returns:

The string represented by this record.
getString()

protected void
serialize(ContinuableRecordOutput
a data output stream
out)

Implements abstract org.apache.poi.hssf.record.cont.ContinuableRecord.serialize.

Serializes this record's content to the supplied data output.

public void
setString(String
The string-value for this record
string)

Sets the string represented by this record.

Inherited from org.apache.poi.hssf.record.cont.ContinuableRecord:
getRecordSizeserialize

Field Detail

_is16bitUnicodeback to summary
private boolean _is16bitUnicode
_textback to summary
private String _text
sidback to summary
public static final short sid

Constructor Detail

StringRecordback to summary
public StringRecord()
StringRecordback to summary
public StringRecord(StringRecord other)
StringRecordback to summary
public StringRecord(RecordInputStream in)
Parameters
in:RecordInputStream

the RecordInputStream to read the record from

Method Detail

copyback to summary
public StringRecord copy()

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

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

Returns:StringRecord

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

a deep copy of the implementing class / instance

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

getStringback to summary
public String getString()
Returns:String

The string represented by this record.

serializeback to summary
protected void serialize(ContinuableRecordOutput out)

Implements abstract org.apache.poi.hssf.record.cont.ContinuableRecord.serialize.

Doc from org.apache.poi.hssf.record.cont.ContinuableRecord.serialize.

Serializes this record's content to the supplied data output.

The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so only BIFF data should be written by this method. Simple data types can be written with the standard LittleEndianOutput methods. Methods from ContinuableRecordOutput can be used to serialize strings (with ContinueRecords being written as required). If necessary, implementors can explicitly start ContinueRecords (regardless of the amount of remaining space).

Parameters
out:ContinuableRecordOutput

a data output stream

setStringback to summary
public void setString(String string)

Sets the string represented by this record.

Parameters
string:String

The string-value for this record