org.eth.cyril.expressions

Class JavaFieldsExpression

java.lang.Object

org.eth.cyril.expressions.JavaFieldsExpression

All Implemented Interfaces:

Expression

public class JavaFieldsExpression
extends java.lang.Object
implements Expression

An expression which evaluates a value and a given set of fields in Java.

Constructor Summary

Constructors

Constructor and Description
JavaFieldsExpression(java.util.List<java.lang.String> fields)

Method Summary

Modifier and Type	Method and Description
java.lang.String	describe(Value value, Value... args) Describe this expression in a human-readable way.
java.util.Optional<Value>	evaluate(Value value, Value... args) Evaluates the given expression for the given value and the array of arguments.
static java.util.List<java.lang.String>	getAllFieldNames(Value value)
void	initialize(DrawingStepHandler stepHandler) Initialize the given step handler.
int	requiredArguments() Returns the number of required arguments to evaluate this expression.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaFieldsExpression

public JavaFieldsExpression(java.util.List<java.lang.String> fields)

Method Detail

getAllFieldNames

public static java.util.List<java.lang.String> getAllFieldNames(Value value)

requiredArguments

public int requiredArguments()

Description copied from interface: Expression

Returns the number of required arguments to evaluate this expression.

Specified by:

requiredArguments in interface Expression

evaluate

public java.util.Optional<Value> evaluate(Value value,
                                          Value... args)

Description copied from interface: Expression

Evaluates the given expression for the given value and the array of arguments. The number of needed arguments depends on the expression, and in some cases no arguments may be supplied. See Expression.requiredArguments() for the number of required arguments to be supplied.

Specified by:

evaluate in interface Expression

Parameters:

value - The value to evaluate the expression for.

args - The array of arguments. There must be at least Expression.requiredArguments() arguments given. Additional arguments will be ignored.

Returns:

A value representing the result of the evaluated expression. If any error occurs during evaluation, an empty optional is returned instead. Note that however supplying an insufficient number of arguments will instead throw an IllegalArgumentException.

describe

public java.lang.String describe(Value value,
                                 Value... args)

Description copied from interface: Expression

Describe this expression in a human-readable way. This description is an already translated string. This expression should be described as if it were evaluated with the given value and arguments.

Specified by:

describe in interface Expression

Parameters:

value - The value which would be given to the Expression.evaluate(Value, Value...) method.

args - The array of arguments which would be given to the Expression.evaluate(Value, Value...) method.

Returns:

A string describing this expression, if it were evaluated on the given arguments. Note that this string does not describe the result of the evaluation, but rather the operation behind it.

initialize

public void initialize(DrawingStepHandler stepHandler)

Description copied from interface: Expression

Initialize the given step handler. The step handler will be used to layout the heaps produced by this expression. The expression initializes the step handler to be properly usable, for example by changing the DSLUpdater instance used for updates to the blacklist, etc.

Specified by:

initialize in interface Expression

Parameters:

stepHandler - The step handler to be initialized.