org.zkoss.poi.ss.formula.ptg

Class StringPtg

java.lang.Object

org.zkoss.poi.ss.formula.ptg.Ptg

org.zkoss.poi.ss.formula.ptg.ScalarConstantPtg

org.zkoss.poi.ss.formula.ptg.StringPtg

All Implemented Interfaces:

Serializable, Cloneable

public final class StringPtg
extends ScalarConstantPtg

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

Author:

Werner Froidevaux, Jason Height (jheight at chariot dot net dot au), Bernard Chesnoy

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static byte	sid

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

CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY

Constructor Summary

Constructors

Constructor and Description
StringPtg(LittleEndianInput in) Create a StringPtg from a stream
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.

Method Summary

Modifier and Type	Method and Description
int	getSize()
int	getSize(SpreadsheetVersion version)
String	getValue()
String	toFormulaString() return a string representation of this token alone
void	write(LittleEndianOutput out)
void	write(LittleEndianOutput out, SpreadsheetVersion version)

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

getDefaultOperandClass, isBaseToken, toString

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

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

Methods inherited from class java.lang.Object

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

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)

Specified by:

write in class Ptg

write

public void write(LittleEndianOutput out,
                  SpreadsheetVersion version)

Specified by:

write in class Ptg

getSize

public int getSize()

Specified by:

getSize in class Ptg

Returns:

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

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