Class FormattedStringExpression

java.lang.Object

VASSAL.script.expression.Expression

VASSAL.script.expression.FormattedStringExpression

public class FormattedStringExpression
extends Expression

Report Format or old-style Formatted String expression containing at least one $variable$ name reference

Field Summary

Fields inherited from class Expression

CACHE

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

Constructor Summary

Constructors

Constructor	Description
FormattedStringExpression(String s)

Method Summary

Modifier and Type	Method	Description
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.
static Expression	instance(String s)
String	toBeanShellString()	Convert to a BeanShell expression

Methods inherited from class Expression

createExpression, createPropertyExpression, createSimplePropertyExpression, equals, evaluate, evaluate, evaluate, evaluate, evaluate, evaluate, evaluate, getExpression, getFilter, getFilter, getFilter, getFilter, handleError, hashCode, quietEvaluate, quietEvaluate, reset, resetCachedExpressions, setExpression, tryEvaluate, tryEvaluate, tryEvaluate, tryEvaluate, tryEvaluate, tryEvaluate, tryEvaluate, tryEvaluate, tryEvaluate, tryEvaluate, tryEvaluate

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 Expression.evaluate(Auditable, AuditTrail)
String	evaluate(boolean localized)	Deprecated. Use Expression.evaluate(PropertySource, boolean, Auditable, AuditTrail)
String	evaluate(PropertySource ps)	Deprecated. Use Expression.evaluate(PropertySource, Auditable, AuditTrail)
String	evaluate(PropertySource ps, boolean localized)	Deprecated. Use Expression.evaluate(PropertySource, boolean, Auditable, AuditTrail)
String	evaluate(PropertySource ps, boolean localized, Auditable owner, AuditTrail audit)
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	tryEvaluate()	Deprecated. User Expression.tryEvaluate(Auditable, AuditTrail)
String	tryEvaluate(boolean localized)	Deprecated. Use Expression.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 Expression.tryEvaluate(PropertySource, Auditable, String)
String	tryEvaluate(PropertySource ps, boolean localized)	Deprecated. Use Expression.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 Expression.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 Object

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

Constructor Details

FormattedStringExpression

public FormattedStringExpression(String s)

Method Details

evaluate

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

Deprecated.

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

Evaluate this expression. NB. Code moved from FormattedString.java

Overrides:

evaluate in class Expression

evaluate

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

Description copied from class: Expression

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.

Overrides:

evaluate in class Expression

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.

toBeanShellString

public String toBeanShellString()

Convert to a BeanShell expression

Overrides:

toBeanShellString in class Expression

Returns:

BeanShell equivalent

instance

public static Expression instance(String s)