org.apache.poi.hssf.record

Class StringRecord

java.lang.Object

org.apache.poi.hssf.record.RecordBase

org.apache.poi.hssf.record.Record

org.apache.poi.hssf.record.cont.ContinuableRecord

org.apache.poi.hssf.record.StringRecord

All Implemented Interfaces:

Duplicatable

public final class StringRecord
extends ContinuableRecord

STRING (0x0207)

Stores the cached result of a text formula

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
StringRecord()
StringRecord(RecordInputStream in)
StringRecord(StringRecord other)

Method Summary

Modifier and Type	Method and Description
StringRecord	clone() Deprecated.
StringRecord	copy()
short	getSid() return the non static version of the id for this record.
java.lang.String	getString()
protected void	serialize(ContinuableRecordOutput out) Serializes this record's content to the supplied data output.
void	setString(java.lang.String string) Sets the string represented by this record.
java.lang.String	toString() get a string representation of the record (for biffview/debugging)

Methods inherited from class org.apache.poi.hssf.record.cont.ContinuableRecord

getRecordSize, serialize

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

cloneViaReserialise, serialize

Methods inherited from class java.lang.Object

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

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

StringRecord

public StringRecord()

StringRecord

public StringRecord(StringRecord other)

StringRecord

public StringRecord(RecordInputStream in)

Parameters:

in - the RecordInputStream to read the record from

Method Detail

serialize

protected void serialize(ContinuableRecordOutput out)

Description copied from class: ContinuableRecord

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

Specified by:

serialize in class ContinuableRecord

Parameters:

out - a data output stream

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

getString

public java.lang.String getString()

Returns:

The string represented by this record.

setString

public void setString(java.lang.String string)

Sets the string represented by this record.

Parameters:

string - The string-value for this record

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

clone

@Deprecated
 @Removal(version="5.0.0")
public StringRecord clone()

Deprecated.

Overrides:

clone in class java.lang.Object

copy

public StringRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class Record

Returns:

a deep copy of the implementing class / instance