Package manifold.api.highjump

Class Symbol

java.lang.Object

manifold.api.highjump.Symbol

public class Symbol
extends Object

Use Symbol to manage external symbols that can be directly referenced in dynamic scripts and expressions.

Constructor Summary

Constructors

Constructor	Description
Symbol(String uid, String name, String type)	Same as: new Symbol(uid, name, type, false, null)
Symbol(String uid, String name, String type, boolean readOnly, Object initialValue)	Create a Symbol that can be directly referenced in a dynamic expression or script.

Method Summary

Modifier and Type	Method	Description
Object	getInitialValue()
String	getName()
String	getType()
String	getUid()
Object	getValue()
boolean	isReadOnly()
void	setValue(Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

Symbol

public Symbol(String uid,
              String name,
              String type,
              boolean readOnly,
              Object initialValue)

Create a Symbol that can be directly referenced in a dynamic expression or script. Use with Highjump.evaluate(Options).

Parameters:

uid - Qualifies the name to uniquely identify this symbol. uid must strictly follow Java identifier naming rules (alphanumeric and underscore chars). Can be the empty string if no further qualification is necessary.

name - The name of the symbol that will be directly referenced in the script or expression. name must strictly follow Java identifier naming rules (alphanumeric and underscore chars).

type - The fully qualified name of the symbol's type, such as: java.lang.String, java.math.BigDecimal[], and java.util.List<java.lang.String>. Note the type must be non-primitive.

readOnly - If true, indicates the symbol is read-only and the initialValue is constant.

initialValue - The initial value of the symbol, may be {@code null).

Symbol

public Symbol(String uid,
              String name,
              String type)

Same as: new Symbol(uid, name, type, false, null)

Symbol(String, String, String, boolean, Object)

Method Detail

getUid

public String getUid()

getName

public String getName()

getType

public String getType()

isReadOnly

public boolean isReadOnly()

getInitialValue

public Object getInitialValue()

getValue

public Object getValue()

setValue

public void setValue(Object value)