org.vishia.util

Class DataAccess.Variable<T>

java.lang.Object

org.vishia.util.DataAccess.Variable<T>

Enclosing class:

DataAccess

public static final class DataAccess.Variable<T>
extends java.lang.Object

This class wraps any Object which is used for a variable. A Variable is helpfully if the content of referenced instances should be changed without changing all references:

      any_instance---------------->|
      other_instance-------------->|
                              Variable
                                   |--value------->references_somewhat
                                       ^   \
                                       |    ------>other_reference
                                     is changed:  
                                   
 

A variable is member of a container Map< String, DataAccess.Variable> which is used to access in the DataAccess class and which is used especially for variables in the org.vishia.cmd.JZtxtcmdExecuter#setScriptVariable(String, Object) and org.vishia.cmd.JZtxtcmdExecuter.ExecuteLevel#setLocalVariable(String, Object) which are accessed with the DataAccess class while setting and evaluating. A user can build a datapool independently of the JZcmd approach writing the code:

   Map< String, DataAccess.Variable> datapool = new TreeMap< String, DataAccess.Variable>();
   String name = "thename";
   DataAccess.Variable variable = new DataAccess.Variable('O', name, anyInstance);
   datapool.put(variable);
 

This datapool can be used to access with DataAccess#getData(List, Object, Map, boolean, boolean).

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<? extends T>	clazz A Class which should be base class of the value.
protected boolean	isConst Property whether this variable should be non-changeable (true) or changeable (false).
protected java.lang.String	name Same name of the variable like it is stored in the container.
protected char	type Type of the variable.
protected T	value Reference to the data.

Constructor Summary

Constructors

Constructor and Description
Variable(char type, java.lang.String name, T value)
Variable(char type, java.lang.String name, T value, boolean isConst) Creates a variable which's value is const or not.
Variable(DataAccess.Variable<T> src) Builds a copy of this.

Method Summary

Modifier and Type	Method and Description
boolean	isConst()
java.lang.String	name()
void	setValue(T value)
java.lang.String	toString()
char	type() Returns the type of the variable: The type follows the DataAccess.DatapathElement.whatisit on creation of the variable: 'A': A new Appendable variable 'C': A new Class variable 'E': A new environment variable 'F': ?
T	value()

Methods inherited from class java.lang.Object

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

Field Detail

type

protected char type

Type of the variable. Type designations see type().

clazz

protected java.lang.Class<? extends T> clazz

A Class which should be base class of the value.

isConst

protected boolean isConst

Property whether this variable should be non-changeable (true) or changeable (false). It should be tested and realized on runtime.
A const variable can be set by another 'const' value, see DataAccess.createOrReplaceVariable(Map, String, char, Object, boolean). It is prevented to change by a non-const value only.

name

protected final java.lang.String name

Same name of the variable like it is stored in the container.

value

protected T value

Reference to the data.

Constructor Detail

Variable

public Variable(char type,
                java.lang.String name,
                T value)

Variable

public Variable(char type,
                java.lang.String name,
                T value,
                boolean isConst)

Creates a variable which's value is const or not.

Parameters:

type - One of "SAPLFOEVC" see type()

name -

value -

isConst - true then the value is const.

Variable

public Variable(DataAccess.Variable<T> src)

Builds a copy of this.

Parameters:

src - any variable

Method Detail

name

public java.lang.String name()

value

public T value()

type

public char type()

Returns the type of the variable: The type follows the DataAccess.DatapathElement.whatisit on creation of the variable:

• 'A': A new Appendable variable
• 'C': A new Class variable
• 'E': A new environment variable
• 'F': ? open file
• 'K': A new Value variable
• 'L': A new list container.
• 'O': A new Object variable
• 'P': A new pipe variable.
• 'Q': A new Boolean variable
• 'S': A new String variable
• 'V': ?? container
• 'X': A new Codeblock variable (eXecute, Subtextvar, Subroutinevar)

isConst

public boolean isConst()

setValue

public void setValue(T value)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object