FuncPtg (Keikai Spreadsheet Build 6.0.0 API)

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:

Serializable, Duplicatable, GenericRecord
```
public final class FuncPtg
extends AbstractFunctionPtg
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field 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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`FuncPtg`	`copy()`
`static FuncPtg`	`create(int functionIndex)`
`static FuncPtg`	`create(LittleEndianInput in)`
`byte`	`getSid()`
`int`	`getSize(SpreadsheetVersion version)`
`void`	`write(LittleEndianOutput out, SpreadsheetVersion version)`

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, toInternalFormulaString

Methods inherited from class org.apache.poi.ss.formula.ptg.Ptg
createPtg, createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSize, getEncodedSizeWithoutArrayData, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, readTokens, serializePtgs, 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,
                  SpreadsheetVersion version)
```
    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(SpreadsheetVersion version)
```
    Specified by:
    
    getSize in class Ptg
    
    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