Class FunctionMetadata
- java.lang.Object
-
- org.apache.poi.ss.formula.function.FunctionMetadata
-
public final class FunctionMetadata extends java.lang.Object
Holds information about Excel built-in functions.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getIndex()
int
getMaxParams()
int
getMinParams()
java.lang.String
getName()
byte[]
getParameterClassCodes()
byte
getReturnClassCode()
boolean
hasFixedArgsLength()
boolean
hasUnlimitedVarags()
Some varags functions (like VLOOKUP) have a specific limit to the number of arguments that can be passed.java.lang.String
toString()
-
-
-
Method Detail
-
getIndex
public int getIndex()
-
getName
public java.lang.String getName()
-
getMinParams
public int getMinParams()
-
getMaxParams
public int getMaxParams()
-
hasFixedArgsLength
public boolean hasFixedArgsLength()
-
getReturnClassCode
public byte getReturnClassCode()
-
getParameterClassCodes
public byte[] getParameterClassCodes()
-
hasUnlimitedVarags
public boolean hasUnlimitedVarags()
Some varags functions (like VLOOKUP) have a specific limit to the number of arguments that can be passed. Other functions (like SUM) don't have such a limit. For those functions, the spreadsheet version determines the maximum number of arguments that can be passed.- Returns:
true
if this function can the maximum number of arguments allowable by theSpreadsheetVersion
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-