Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.ss.formula.ptg
Class FuncVarPtg

    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.FuncVarPtg

    public final class FuncVarPtg

extends AbstractFunctionPtg

Author:
  Jason Height (jheight at chariot dot net dot au)

Field Summary
`static byte` | `sid`
`static OperationPtg` | `SUM` Single instance of this token for 'sum() taking a single argument'

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
`static FuncVarPtg` | `create(LittleEndianInput in)` Creates new function pointer from a byte array usually called while reading an excel file.
`static FuncVarPtg` | `create(java.lang.String pName, int numArgs)` Create a function ptg from a string tokenised by the parser
`int` | `getSize()`
`void` | `write(LittleEndianOutput out)`

Methods inherited from class org.apache.poi.ss.formula.ptg.AbstractFunctionPtg
`getDefaultOperandClass, getFunctionIndex, getName, getNumberOfOperands, getParameterClass, isBaseToken, isBuiltInFunctionName, isExternalFunction, toFormulaString, toFormulaString, toString`

Methods inherited from class org.apache.poi.ss.formula.ptg.Ptg
`createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, serializePtgs, setClass`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### sid

    public static final byte sid

See Also:
  Constant Field Values

### SUM

    public static final OperationPtg SUM

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

Method Detail

### create

    public static FuncVarPtg create(LittleEndianInput in)

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

### create

    public static FuncVarPtg create(java.lang.String pName,
                                    int numArgs)

  Create a function ptg from a string tokenised by the parser

### write

    public void write(LittleEndianOutput out)

  Specified by:
    `write` in class `Ptg`

### getSize

    public int getSize()

  Specified by:
    `getSize` in class `AbstractFunctionPtg`
  Returns:
    the encoded length of this Ptg, including the initial Ptg type identifier byte.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD