Package VASSAL.script.expression

Class Expression

java.lang.Object

VASSAL.script.expression.Expression

Direct Known Subclasses:

BeanShellExpression, FormattedStringExpression, IntExpression, NullExpression, PropertyMatchExpression, SinglePropertyExpression, StringExpression

public class Expression
extends Object

An abstract class representing an expression that can be evaluated. Subclasses implement specific types of expression and the way they are evaluated.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Map<org.apache.commons.lang3.tuple.Pair<Object,Class<? extends Expression>>,Expression>	CACHE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Expression(String s)

Method Summary

Modifier and Type	Method	Description
static Expression	createExpression(String s)	Factory method to create an appropriate expression based on the supplied String.
static Expression	createPropertyExpression(String s)	Factory method to create a new Property Match Expression.
static Expression	createSimplePropertyExpression(String s)	Factory method to create a Beanshell expression of a value that is known to be a property name.
boolean	equals(Object obj)
String	evaluate()	Deprecated. Use evaluate(Auditable, AuditTrail)
String	evaluate(boolean localized)	Deprecated. Use evaluate(PropertySource, boolean, Auditable, AuditTrail)
String	evaluate(PropertySource ps)	Deprecated. Use evaluate(PropertySource, Auditable, AuditTrail)
String	evaluate(PropertySource ps, boolean localized)	Deprecated. Use evaluate(PropertySource, boolean, Auditable, AuditTrail)
String	evaluate(PropertySource ps, boolean localized, Auditable owner, AuditTrail audit)
String	evaluate(PropertySource ps, Map<String,String> properties, boolean localized)	Deprecated. Use evaluate(PropertySource, Map, boolean, Auditable, AuditTrail)
String	evaluate(PropertySource ps, Map<String,String> properties, boolean localized, Auditable owner, AuditTrail audit)	Each subclass must implement evaluate() to evaluate itself The default implementation just returns the expression itself, which works correctly for simple Expression types like NullExpression and IntExpression.
String	evaluate(PropertySource ps, Auditable owner, AuditTrail audit)
String	evaluate(Auditable owner, AuditTrail audit)
String	getExpression()
PieceFilter	getFilter()	Deprecated.
PieceFilter	getFilter(PropertySource ps)	Deprecated.
PieceFilter	getFilter(PropertySource ps, Auditable owner, AuditTrail audit)	Return a PieceFilter using the expression.
PieceFilter	getFilter(Auditable owner, AuditTrail audit)
protected void	handleError(ExpressionException e)
int	hashCode()
String	quietEvaluate(PropertySource ps, Map<String,String> properties, boolean localized, Auditable owner, AuditTrail audit)	A version of tryEvaluate the supresses error messages.
String	quietEvaluate(PropertySource ps, Auditable owner, String fieldKey)
protected void	reset()
static void	resetCachedExpressions()
void	setExpression(String s)
String	toBeanShellString()	Output a BeanShell equivalent of this expression.
String	tryEvaluate()	Deprecated. User tryEvaluate(Auditable, AuditTrail)
String	tryEvaluate(boolean localized)	Deprecated. Use tryEvaluate(boolean, Auditable, AuditTrail)
String	tryEvaluate(boolean localized, Auditable owner, AuditTrail audit)	Evaluate an expression with data warning support built in
String	tryEvaluate(PropertySource ps)	Deprecated. Use tryEvaluate(PropertySource, Auditable, String)
String	tryEvaluate(PropertySource ps, boolean localized)	Deprecated. Use tryEvaluate(PropertySource, boolean, Auditable, AuditTrail)
String	tryEvaluate(PropertySource ps, boolean localized, Auditable owner, AuditTrail audit)	Evaluate an expression with data warning support built in
String	tryEvaluate(PropertySource ps, Map<String,String> properties, boolean localized)	Deprecated. Use tryEvaluate(PropertySource, Map, boolean, Auditable, AuditTrail)
String	tryEvaluate(PropertySource ps, Map<String,String> properties, boolean localized, Auditable owner, AuditTrail audit)	Core tryEvaluate implementation.
String	tryEvaluate(PropertySource ps, Auditable owner, String fieldKey)
String	tryEvaluate(PropertySource ps, Auditable owner, AuditTrail audit)	Evaluate an expression with data warning support built in
String	tryEvaluate(Auditable owner, AuditTrail audit)	Evaluate an expression with data warning support built in

Methods inherited from class java.lang.Object

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

Field Details

CACHE

protected static final Map<org.apache.commons.lang3.tuple.Pair<Object,Class<? extends Expression>>,Expression> CACHE

Constructor Details

Expression

protected Expression(String s)

Method Details

getExpression

public String getExpression()

setExpression

public void setExpression(String s)

reset

protected void reset()

evaluate

public String evaluate(PropertySource ps,
 Map<String,String> properties,
 boolean localized,
 Auditable owner,
 AuditTrail audit)
                throws ExpressionException

Each subclass must implement evaluate() to evaluate itself The default implementation just returns the expression itself, which works correctly for simple Expression types like NullExpression and IntExpression.

Parameters:

ps - Property Source providing property values

properties - default property values

localized - localize property calls?

audit - Audit trail to record expression evaluation info in

Returns:

evaluated String.

Throws:

ExpressionException

evaluate

public String evaluate(PropertySource ps,
 boolean localized,
 Auditable owner,
 AuditTrail audit)
                throws ExpressionException

Throws:

ExpressionException

evaluate

public String evaluate(PropertySource ps,
 Auditable owner,
 AuditTrail audit)
                throws ExpressionException

Throws:

ExpressionException

evaluate

public String evaluate(Auditable owner,
 AuditTrail audit)
                throws ExpressionException

Throws:

ExpressionException

evaluate

@Deprecated(since="2021-06-11")
public String evaluate(PropertySource ps,
 Map<String,String> properties,
 boolean localized)
                throws ExpressionException

Deprecated.

Use evaluate(PropertySource, Map, boolean, Auditable, AuditTrail)

Throws:

ExpressionException

evaluate

@Deprecated(since="2021-06-11")
public String evaluate(PropertySource ps,
 boolean localized)
                throws ExpressionException

Deprecated.

Use evaluate(PropertySource, boolean, Auditable, AuditTrail)

Throws:

ExpressionException

evaluate

@Deprecated(since="2021-06-11")
public String evaluate(PropertySource ps)
                throws ExpressionException

Deprecated.

Use evaluate(PropertySource, Auditable, AuditTrail)

Throws:

ExpressionException

evaluate

@Deprecated(since="2021-06-11")
public String evaluate(boolean localized)
                throws ExpressionException

Deprecated.

Use evaluate(PropertySource, boolean, Auditable, AuditTrail)

Throws:

ExpressionException

evaluate

@Deprecated(since="2021-06-11")
public String evaluate()
                throws ExpressionException

Deprecated.

Use evaluate(Auditable, AuditTrail)

Throws:

ExpressionException

handleError

protected void handleError(ExpressionException e)

tryEvaluate

public String tryEvaluate(PropertySource ps,
 Auditable owner,
 AuditTrail audit)

Evaluate an expression with data warning support built in

Parameters:

ps - Property Source providing property values

audit - Audit trail to record expression evaluation info in

Returns:

evaluated String

tryEvaluate

public String tryEvaluate(PropertySource ps,
 Auditable owner,
 String fieldKey)

quietEvaluate

public String quietEvaluate(PropertySource ps,
 Auditable owner,
 String fieldKey)

tryEvaluate

@Deprecated(since="2021-06-11")
public String tryEvaluate(PropertySource ps)

Deprecated.

Use tryEvaluate(PropertySource, Auditable, String)

tryEvaluate

public String tryEvaluate(Auditable owner,
 AuditTrail audit)

Evaluate an expression with data warning support built in

Parameters:

audit - Audit trail to record expression evaluation info in

Returns:

evaluated String

tryEvaluate

@Deprecated(since="2021-06-11")
public String tryEvaluate()

Deprecated.

User tryEvaluate(Auditable, AuditTrail)

tryEvaluate

public String tryEvaluate(PropertySource ps,
 boolean localized,
 Auditable owner,
 AuditTrail audit)

Evaluate an expression with data warning support built in

Parameters:

ps - Property Source providing property values

localized - Localize property calls?

audit - Audit trail to record expression evaluation info in

Returns:

evaluated String

tryEvaluate

@Deprecated(since="2021-06-11")
public String tryEvaluate(PropertySource ps,
 boolean localized)

Deprecated.

Use tryEvaluate(PropertySource, boolean, Auditable, AuditTrail)

tryEvaluate

public String tryEvaluate(boolean localized,
 Auditable owner,
 AuditTrail audit)

Evaluate an expression with data warning support built in

Parameters:

localized - Localize property calls?

audit - Audit trail to record expression evaluation info in

Returns:

evaluated String

tryEvaluate

@Deprecated(since="2021-06-11")
public String tryEvaluate(boolean localized)

Deprecated.

Use tryEvaluate(boolean, Auditable, AuditTrail)

tryEvaluate

public String tryEvaluate(PropertySource ps,
 Map<String,String> properties,
 boolean localized,
 Auditable owner,
 AuditTrail audit)

Core tryEvaluate implementation. All other call signatures end here. Evaluate an expression with data warning support built in Use supplied owner and AuditTrail for Expression error reporting.

Parameters:

ps - Property Source providing property values

properties - Default property values

localized - Localize property calls?

audit - Audit trail to record expression evaluation info in

Returns:

evaluated String

quietEvaluate

public String quietEvaluate(PropertySource ps,
 Map<String,String> properties,
 boolean localized,
 Auditable owner,
 AuditTrail audit)

A version of tryEvaluate the supresses error messages. Called by traits in the Game Piece Palette when an expression may fail due to properties not being accessible.

tryEvaluate

@Deprecated(since="2021-06-11")
public String tryEvaluate(PropertySource ps,
 Map<String,String> properties,
 boolean localized)

Deprecated.

Use tryEvaluate(PropertySource, Map, boolean, Auditable, AuditTrail)

getFilter

public PieceFilter getFilter(PropertySource ps,
 Auditable owner,
 AuditTrail audit)

Return a PieceFilter using the expression. The default PieceFilter always returns true. Individual subclasses that are capable of selecting pieces MUST override these defaults. Auditing functionality is supplied since creating a filter usually involves evaluating an Expression.

Parameters:

ps - PropertySource to use as source of filter

audit - Audit trail to record expression evaluation info in

Returns:

Created PieceFilter

getFilter

public PieceFilter getFilter(Auditable owner,
 AuditTrail audit)

getFilter

@Deprecated(since="2021-06-11")
public PieceFilter getFilter(PropertySource ps)

Deprecated.

getFilter

@Deprecated(since="2021-06-11")
public PieceFilter getFilter()

Deprecated.

toBeanShellString

public String toBeanShellString()

Output a BeanShell equivalent of this expression.

Returns:

BeanShell equivalent

createExpression

public static Expression createExpression(String s)

Factory method to create an appropriate expression based on the supplied String. The majority of expressions in a module are going to be blank, integers or simple strings, so return optimised Expression subclasses for these types.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

createPropertyExpression

public static Expression createPropertyExpression(String s)

Factory method to create a new Property Match Expression.

Parameters:

s - Expression string

Returns:

Generated Expression

createSimplePropertyExpression

public static Expression createSimplePropertyExpression(String s)

Factory method to create a Beanshell expression of a value that is known to be a property name. Used to convert values such as the Follow property field in Embellishment

resetCachedExpressions

public static void resetCachedExpressions()