com.grapecity.documents.excel

Class Parameter

java.lang.Object

com.grapecity.documents.excel.Parameter

public class Parameter
extends java.lang.Object

Represents the parameter of a function.

Constructor Summary

Constructors

Constructor and Description
Parameter(FunctionValueType valueType) Initializes an instance of a parameter.
Parameter(FunctionValueType valueType, boolean acceptReference) Initializes an instance of a parameter.
Parameter(FunctionValueType valueType, boolean acceptReference, boolean acceptCustomObjects) Initializes an instance of a parameter.
Parameter(FunctionValueType valueType, java.lang.Object defaultValue) Initializes an instance of a parameter.
Parameter(FunctionValueType valueType, java.lang.Object defaultValue, boolean acceptReference) Initializes an instance of a parameter.
Parameter(java.lang.String name, java.lang.String description, FunctionValueType valueType, java.lang.Object defaultValue) Initializes an instance of a parameter.
Parameter(java.lang.String name, java.lang.String description, FunctionValueType valueType, java.lang.Object defaultValue, boolean acceptReference) Initializes an instance of a parameter.
Parameter(java.lang.String name, java.lang.String description, FunctionValueType valueType, java.lang.Object defaultValue, boolean acceptReference, boolean acceptCustomObjects) Initializes an instance of a parameter.

Method Summary

Modifier and Type	Method and Description
boolean	getAcceptCustomObjects() Accepts custom objects if value type is FunctionValueType.Object.
boolean	getAcceptReference() Gets the parameter can or can't accept reference.
java.lang.Object	getDefaultValue() Gets the default value of the parameter;
java.lang.String	getDescription() Gets the description of the parameter;
java.lang.String	getName() Gets the name of the parameter;
FunctionValueType	getValueType() Gets the value type of the parameter;

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Parameter

public Parameter(FunctionValueType valueType)

Initializes an instance of a parameter.

Parameters:

valueType - The value type of the parameter.

Parameter

public Parameter(FunctionValueType valueType,
                 boolean acceptReference)

Initializes an instance of a parameter.

Parameters:

valueType - The value type of the parameter.

acceptReference - If this parameter can accept reference.

Parameter

public Parameter(FunctionValueType valueType,
                 java.lang.Object defaultValue)

Initializes an instance of a parameter.

Parameters:

valueType - The value type of the parameter.

defaultValue - The default value of the parameter.

Parameter

public Parameter(FunctionValueType valueType,
                 java.lang.Object defaultValue,
                 boolean acceptReference)

Initializes an instance of a parameter.

Parameters:

valueType - The value type of the parameter.

defaultValue - The default value of the parameter.

acceptReference - If this parameter can accept reference.

Parameter

public Parameter(java.lang.String name,
                 java.lang.String description,
                 FunctionValueType valueType,
                 java.lang.Object defaultValue)

Initializes an instance of a parameter.

Parameters:

name - The name of the parameter.

description - The description of the parameter.

valueType - The value type of the parameter.

defaultValue - The default value of the parameter.

Parameter

public Parameter(java.lang.String name,
                 java.lang.String description,
                 FunctionValueType valueType,
                 java.lang.Object defaultValue,
                 boolean acceptReference)

Initializes an instance of a parameter.

Parameters:

name -

description - The description of the parameter.

valueType - The value type of the parameter.

defaultValue - The default value of the parameter.

acceptReference - If this parameter can accept reference.

Parameter

public Parameter(FunctionValueType valueType,
                 boolean acceptReference,
                 boolean acceptCustomObjects)

Initializes an instance of a parameter.

Parameters:

valueType - The value type of the parameter.

acceptReference - If this parameter can accept reference.

acceptCustomObjects - Accepts custom objects if value type is FunctionValueType.Object.

Parameter

public Parameter(java.lang.String name,
                 java.lang.String description,
                 FunctionValueType valueType,
                 java.lang.Object defaultValue,
                 boolean acceptReference,
                 boolean acceptCustomObjects)

Initializes an instance of a parameter.

Parameters:

name - The name of the function.

description - The description of the parameter.

valueType - The value type of the parameter.

defaultValue - The default value of the parameter.

acceptReference - If this parameter can accept reference.

acceptCustomObjects - Accepts custom objects if value type is FunctionValueType.Object.

Method Detail

getName

public final java.lang.String getName()

Gets the name of the parameter;

getDescription

public final java.lang.String getDescription()

Gets the description of the parameter;

getValueType

public final FunctionValueType getValueType()

Gets the value type of the parameter;

getDefaultValue

public final java.lang.Object getDefaultValue()

Gets the default value of the parameter;

getAcceptReference

public final boolean getAcceptReference()

Gets the parameter can or can't accept reference.

getAcceptCustomObjects

public final boolean getAcceptCustomObjects()

Accepts custom objects if value type is FunctionValueType.Object.