org.apache.poi.ss.formula.ptg

Class ParenthesisPtg

java.lang.Object

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

org.apache.poi.ss.formula.ptg.ControlPtg

org.apache.poi.ss.formula.ptg.ParenthesisPtg

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class ParenthesisPtg
extends ControlPtg

While formula tokens are stored in RPN order and thus do not need parenthesis for precedence reasons, Parenthesis tokens ARE written to ensure that user entered parenthesis are displayed as-is on reading back

Field Summary

Fields

Modifier and Type	Field and Description
static ParenthesisPtg	instance
static byte	sid

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

CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY

Method Summary

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

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

getDefaultOperandClass, isBaseToken

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

createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, 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

instance

public static final ParenthesisPtg instance

Method Detail

write

public void write(LittleEndianOutput out)

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

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

toFormulaString

public String toFormulaString(String[] operands)

copy

public ParenthesisPtg 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()