Package com.myscript.iink

Enum Class MathVariableSourceType

java.lang.Object

java.lang.Enum<MathVariableSourceType>

com.myscript.iink.MathVariableSourceType

All Implemented Interfaces:

Serializable, Comparable<MathVariableSourceType>, Constable

public enum MathVariableSourceType
extends Enum<MathVariableSourceType>

Enumerates the possible sources from which a variable can be defined.

Note: API variables have priority over BLOCK variables, which have priority over API_GLOBAL variables. PREDEFINED variables cannot be redefined.

Since:

4.1

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
API	The local variable was defined through MathSolverController.setVariableValue(blockId, ...).
API_GLOBAL	The global variable was defined through MathSolverController.setVariableValue("", ...).
BLOCK	The variable was defined through a block expression.
PREDEFINED	The variable is a predefined constant (ex: Pi).
UNDEFINED	The variable has not been defined.

Method Summary

Modifier and Type	Method	Description
static MathVariableSourceType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MathVariableSourceType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNDEFINED

public static final MathVariableSourceType UNDEFINED

The variable has not been defined.

API

public static final MathVariableSourceType API

The local variable was defined through MathSolverController.setVariableValue(blockId, ...).

API_GLOBAL

public static final MathVariableSourceType API_GLOBAL

The global variable was defined through MathSolverController.setVariableValue("", ...).

BLOCK

public static final MathVariableSourceType BLOCK

The variable was defined through a block expression.

PREDEFINED

public static final MathVariableSourceType PREDEFINED

The variable is a predefined constant (ex: Pi).

Method Details

values

public static MathVariableSourceType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MathVariableSourceType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null