com.whitestein.lsps.lang.exec

Interface ReferenceHolder

All Superinterfaces:

ValueHolder

All Known Implementing Classes:

ReferenceExpressionHolder, ReferenceValue

public interface ReferenceHolder
extends ValueHolder

All objects of the type ReferenceType must implement this interface. References point to a variable or a field of a record. The value can be both read and written.

Author:

rba

Method Summary

Modifier and Type	Method and Description
List<Property>	getAdditionalProperties() Returns additional properties that are added to the referenced path.
ClosureOrigin	getClosureOrigin()
String	getExpressionString() Returns a string representation of this reference holder expression.
Namespace	getNamespace() Returns namespace
Path	getPath() Returns referenced path if a property is referenced.
Property	getProperty() Returns last referenced property if a property is referenced.
default RecordHolder	getPropertyRecord() Returns root record for the property if a property is referenced.
RecordHolder	getPropertyRecord(InterpreterStackTrace stackTrace) Returns root record for the property if a property is referenced.
ReferenceType	getType() Returns the type of the holder.
default Object	getValue() Gets the value of the referenced element.
Object	getValue(InterpreterStackTrace stackTrace) Gets the value of the referenced element.
Object	getValue(String evaluationLevel, InterpreterStackTrace stackTrace) Returns value of referenced value-holder (variable/record) in the specified evaluation level.
boolean	isChanged() Returns true if referenced place holder has changed value.
default void	setValue(Object value) Sets the value of the referenced element.
void	setValue(Object value, InterpreterStackTrace stackTrace) Sets the value of the referenced element.

Methods inherited from interface com.whitestein.lsps.lang.exec.ValueHolder

getId, getNotCompiledValueHolder

Method Detail

getType

ReferenceType getType()

Description copied from interface: ValueHolder

Returns the type of the holder.

Specified by:

getType in interface ValueHolder

Returns:

the type of the holder

setValue

default void setValue(Object value)
               throws ErrorException

Sets the value of the referenced element.

Parameters:

value -

Throws:

ErrorException

setValue

void setValue(Object value,
              InterpreterStackTrace stackTrace)
       throws ErrorException

Sets the value of the referenced element.

Parameters:

value -

stackTrace - a stack trace

Throws:

ErrorException

getValue

default Object getValue()
                 throws ErrorException

Gets the value of the referenced element.

Returns:

the value of the referenced element

Throws:

ErrorException

getValue

Object getValue(InterpreterStackTrace stackTrace)
         throws ErrorException

Gets the value of the referenced element.

Parameters:

stackTrace -

Returns:

the value of the referenced element

Throws:

ErrorException

getExpressionString

String getExpressionString()

Returns a string representation of this reference holder expression.

Returns:

a string representation of this reference holder expression

getProperty

Property getProperty()

Returns last referenced property if a property is referenced. Returns null in other cases.

Returns:

referenced property

getAdditionalProperties

List<Property> getAdditionalProperties()

Returns additional properties that are added to the referenced path.

Returns:

additional properties that are added to the referenced path.

getPath

Path getPath()

Returns referenced path if a property is referenced. Returns null in other cases.

Returns:

referenced path

getPropertyRecord

default RecordHolder getPropertyRecord()
                                throws ErrorException

Returns root record for the property if a property is referenced. Returns null in other cases.

Returns:

root record for the property

Throws:

ErrorException

getPropertyRecord

RecordHolder getPropertyRecord(InterpreterStackTrace stackTrace)
                        throws ErrorException

Returns root record for the property if a property is referenced. Returns null in other cases.

Parameters:

stackTrace - a stack trace

Returns:

root record for the property

Throws:

ErrorException

isChanged

boolean isChanged()

Returns true if referenced place holder has changed value. It fails if the reference is in the base evaluation level, in such case there is no way to detect changes.

Returns:

true if referenced place holder has changed value

getValue

Object getValue(String evaluationLevel,
                InterpreterStackTrace stackTrace)
         throws ErrorException

Returns value of referenced value-holder (variable/record) in the specified evaluation level. It fails if the referenced value-holder does not exist on the specified evaluation level.

Parameters:

evaluationLevel -

stackTrace - a stack trace

Returns:

referenced value transformed to the required level

Throws:

ErrorException

getNamespace

Namespace getNamespace()

Returns namespace

Returns:

namespace

getClosureOrigin

ClosureOrigin getClosureOrigin()

Returns:

the closure origin, may be null