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 VASSAL.script.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 VASSAL.script.expression.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

Methods inherited from class java.lang.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)