org.apache.poi.ss.formula.ptg

Class FuncPtg

java.lang.Object

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

org.apache.poi.ss.formula.ptg.OperationPtg

org.apache.poi.ss.formula.ptg.AbstractFunctionPtg

org.apache.poi.ss.formula.ptg.FuncPtg

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class FuncPtg
extends AbstractFunctionPtg

Field Summary

Fields

Modifier and Type	Field and Description
static byte	sid
static int	SIZE

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

FUNCTION_NAME_IF

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

TYPE_BINARY, TYPE_FUNCTION, TYPE_UNARY

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
FuncPtg	copy()
static FuncPtg	create(int functionIndex)
static FuncPtg	create(LittleEndianInput in)
byte	getSid()
int	getSize()
void	write(LittleEndianOutput out)

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

getDefaultOperandClass, getFunctionIndex, getGenericProperties, getName, getNumberOfOperands, getParameterClass, isBaseToken, isBuiltInFunctionName, isExternalFunction, lookupIndex, lookupName, lookupName, toFormulaString, toFormulaString

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

SIZE

public static final int SIZE

See Also:

Constant Field Values

Method Detail

create

public static FuncPtg create(LittleEndianInput in)

create

public static FuncPtg create(int functionIndex)

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 AbstractFunctionPtg

Returns:

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

copy

public FuncPtg copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class Ptg

Returns:

a deep copy of the implementing class / instance