Top Description Fields Constructors Methods
org.apache.poi.ss.formula.ptg

public final Class ParenthesisPtg

extends ControlPtg
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.LittleEndianOutput
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

Modifier and TypeField and Description
public static final ParenthesisPtg
instance

public static final byte
sid

private static final int
SIZE

Constructor Summary

AccessConstructor and Description
private
ParenthesisPtg()

Method Summary

Modifier and TypeMethod and Description
public ParenthesisPtg
copy()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.copy.

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

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public byte
getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

public int
getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

public String
toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

public String
toFormulaString(String[] operands)

public void
write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.

Inherited from org.apache.poi.ss.formula.ptg.ControlPtg:
getDefaultOperandClassisBaseToken

Field Detail

instanceback to summary
public static final ParenthesisPtg instance
sidback to summary
public static final byte sid
SIZEback to summary
private static final int SIZE

Constructor Detail

ParenthesisPtgback to summary
private ParenthesisPtg()

Method Detail

copyback to summary
public ParenthesisPtg copy()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.copy.

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

Returns:ParenthesisPtg

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

a deep copy of the implementing class / instance

Annotations
@Override
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getSidback to summary
public byte getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

Returns:byte

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSid.

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

Annotations
@Override
getSizeback to summary
public int getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

Returns:int

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSize.

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

toFormulaStringback to summary
public String toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

Doc from org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

toFormulaStringback to summary
public String toFormulaString(String[] operands)
writeback to summary
public void write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.