public interface AQFunctionParameter
Synopsis:
A FunctionParameter is a parameter for a SeriesFunction.
Description:
FunctionParameter provides a interface for getting and setting the name, value and data type of a parameter being passed to a SeriesFunction.
Modifier and Type | Interface and Description |
---|---|
static class |
AQFunctionParameter.DataType
Supported parameter datatypes: Integer, Float, Double
|
Modifier and Type | Method and Description |
---|---|
AQFunctionParameter.DataType |
getDataType()
Get the parameter's datatype (Integer, Float or Double)
|
String |
getName()
Get the name of the parameter.
|
Object |
getValue()
Get the value of the parameter.
|
String |
getValueString()
Get a string representation of the parameter value.
|
boolean |
isDouble()
Return TRUE if the parameter is a Double.
|
boolean |
isFloat()
Return TRUE if the parameter is a Float.
|
boolean |
isInteger()
Return TRUE if the parameter is an Integer.
|
boolean |
isOptional()
Return True if the parameter is optional
|
void |
setDataType(AQFunctionParameter.DataType dataType)
Set the parameter's datatype (Integer, Float or Double)
|
void |
setName(String name)
Set the name of the parameter.
|
void |
setValue(Object value)
Set the value of the parameter.
|
boolean |
setValueFromString(String valueString)
Use a string to set the value of the parameter.
|
String getName()
void setName(String name)
name
- Parameter nameString getValueString()
Object getValue()
void setValue(Object value)
value
- Parameter valueboolean setValueFromString(String valueString)
valueString
- String representation of parameter valueAQFunctionParameter.DataType getDataType()
void setDataType(AQFunctionParameter.DataType dataType)
dataType
- DataType of parameterboolean isInteger()
boolean isFloat()
boolean isDouble()
boolean isOptional()
Copyright © 2017 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.