Package org.apache.poi.ss.formula.ptg

Class StringPtg

java.lang.Object

org.apache.poi.ss.formula.ptg.Ptg

org.apache.poi.ss.formula.ptg.ScalarConstantPtg

org.apache.poi.ss.formula.ptg.StringPtg

All Implemented Interfaces:

Serializable, Duplicatable, GenericRecord

public final class StringPtg
extends ScalarConstantPtg

String Stores a String value in a formula value stored in the format <length 2 bytes>char[]

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static byte	sid

Fields inherited from class org.apache.poi.ss.formula.ptg.Ptg

CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY

Constructor Summary

Constructors

Constructor	Description
StringPtg(String value)	Create a StringPtg from a string representation of the number Number format is not checked, it is expected to be validated in the parser that calls this method.
StringPtg(LittleEndianInput in)	Create a StringPtg from a stream

Method Summary

Modifier and Type	Method	Description
StringPtg	copy()
Map<String,Supplier<?>>	getGenericProperties()
byte	getSid()
int	getSize(SpreadsheetVersion version)
String	getValue()
String	toFormulaString()	return a string representation of this token alone
void	write(LittleEndianOutput out, SpreadsheetVersion version)

Methods inherited from class org.apache.poi.ss.formula.ptg.ScalarConstantPtg

getDefaultOperandClass, isBaseToken

Methods inherited from class org.apache.poi.ss.formula.ptg.Ptg

createPtg, createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSize, getEncodedSizeWithoutArrayData, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, readTokens, serializePtgs, serializePtgs, setClass, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren, getGenericRecordType

Field Detail

sid

public static final byte sid

See Also:

Constant Field Values

Constructor Detail

StringPtg

public StringPtg(LittleEndianInput in)

Create a StringPtg from a stream

StringPtg

public StringPtg(String value)

Create a StringPtg from a string representation of the number Number format is not checked, it is expected to be validated in the parser that calls this method.

Parameters:

value - : String representation of a floating point number

Method Detail

getValue

public String getValue()

write

public void write(LittleEndianOutput out,
                  SpreadsheetVersion version)

Specified by:

write in class Ptg

getSid

public byte getSid()

Specified by:

getSid in class Ptg

Returns:

structure id of the parsed thing, or -1 if the record has no sid

getSize

public int getSize(SpreadsheetVersion version)

Specified by:

getSize in class Ptg

Returns:

the encoded length of this Ptg, including the initial Ptg type identifier byte.

toFormulaString

public String toFormulaString()

Description copied from class: Ptg

return a string representation of this token alone

Specified by:

toFormulaString in class Ptg

copy

public StringPtg copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class Ptg

Returns:

a deep copy of the implementing class / instance

getGenericProperties

public Map<String,Supplier<?>> getGenericProperties()