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

public final Class FuncVarPtg

extends AbstractFunctionPtg
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.ss.formula.function.FunctionMetadata, .FunctionMetadataRegistry, org.apache.poi.util.BitField, .BitFieldFactory, .GenericRecordUtil, .LittleEndianInput, .LittleEndianOutput

Field Summary

Modifier and TypeField and Description
private final boolean
_isCetab

private static final BitField
ceFunc

public static final byte
sid

private static final int
SIZE

public static final OperationPtg
SUM

Single instance of this token for 'sum() taking a single argument'

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

Constructor Summary

AccessConstructor and Description
private
FuncVarPtg(int functionIndex, int returnClass, byte[] paramClasses, int numArgs, boolean isCetab)

Method Summary

Modifier and TypeMethod and Description
public FuncVarPtg
copy()

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

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

public static FuncVarPtg
create(LittleEndianInput in)

Creates new function pointer from a byte array usually called while reading an excel file.

public static FuncVarPtg
create(String pName, int numArgs)

Create a function ptg from a string tokenised by the parser

private static FuncVarPtg
create(int numArgs, int functionIndex)

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

Overrides org.apache.poi.ss.formula.ptg.AbstractFunctionPtg.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.AbstractFunctionPtg.getSize.

protected String
lookupName(short index)

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

public void
write(LittleEndianOutput out)

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

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

Field Detail

_isCetabback to summary
private final boolean _isCetab
ceFuncback to summary
private static final BitField ceFunc
sidback to summary
public static final byte sid
SIZEback to summary
private static final int SIZE
SUMback to summary
public static final OperationPtg SUM

Single instance of this token for 'sum() taking a single argument'

Constructor Detail

FuncVarPtgback to summary
private FuncVarPtg(int functionIndex, int returnClass, byte[] paramClasses, int numArgs, boolean isCetab)

Method Detail

copyback to summary
public FuncVarPtg copy()

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

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

Returns:FuncVarPtg

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

a deep copy of the implementing class / instance

Annotations
@Override
createback to summary
public static FuncVarPtg create(LittleEndianInput in)

Creates new function pointer from a byte array usually called while reading an excel file.

createback to summary
public static FuncVarPtg create(String pName, int numArgs)

Create a function ptg from a string tokenised by the parser

createback to summary
private static FuncVarPtg create(int numArgs, int functionIndex)
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Overrides org.apache.poi.ss.formula.ptg.AbstractFunctionPtg.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.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.

lookupNameback to summary
protected String lookupName(short index)

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

Annotations
@Override
writeback to summary
public void write(LittleEndianOutput out)

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