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

public final Class FuncPtg

extends AbstractFunctionPtg
Class Inheritance
Imports
org.apache.poi.ss.formula.function.FunctionMetadata, .FunctionMetadataRegistry, org.apache.poi.util.LittleEndianInput, .LittleEndianOutput

Field Summary

Modifier and TypeField and Description
public static final byte
sid

public static final int
SIZE

Inherited from org.apache.poi.ss.formula.ptg.AbstractFunctionPtg:
FUNCTION_NAME_IF

Constructor Summary

AccessConstructor and Description
private
FuncPtg(int funcIndex, FunctionMetadata fm)

Method Summary

Modifier and TypeMethod and Description
public FuncPtg
copy()

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

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

public static FuncPtg
create(LittleEndianInput in)

public static FuncPtg
create(int functionIndex)

public byte
getSid()

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

public int
getSize()

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

public void
write(LittleEndianOutput out)

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

Inherited from org.apache.poi.ss.formula.ptg.AbstractFunctionPtg:
getDefaultOperandClassgetFunctionIndexgetGenericPropertiesgetNamegetNumberOfOperandsgetParameterClassisBaseTokenisBuiltInFunctionNameisExternalFunctionlookupIndexlookupNamelookupNametoFormulaStringtoFormulaString

Field Detail

sidback to summary
public static final byte sid
SIZEback to summary
public static final int SIZE

Constructor Detail

FuncPtgback to summary
private FuncPtg(int funcIndex, FunctionMetadata fm)

Method Detail

copyback to summary
public FuncPtg copy()

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

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

Returns:FuncPtg

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

a deep copy of the implementing class / instance

Annotations
@Override
createback to summary
public static FuncPtg create(LittleEndianInput in)
createback to summary
public static FuncPtg create(int functionIndex)
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.AbstractFunctionPtg.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.

writeback to summary
public void write(LittleEndianOutput out)

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