Modifier and Type	Class and Description
public static enum	Expression.Flag Flags that can apply to a property expression compilation
pack-priv static class	Expression.Itr

Modifier and Type	Field and Description
private final Node	content
private static final Expression	EMPTY
private static final EnumSet<Expression.Flag>	NO_FLAGS
private final Set<String>	referencedStrings

Access	Constructor and Description
pack-priv	Expression(Node content)

Method Summary

Modifier and Type	Method and Description
public static Expression	Returns: the compiled expression (not `null`) compile(String the expression string (must not be `null`) string, Expression.Flag... optional flags to apply which affect the compilation flags) Compile an expression string.
public static Expression	Returns: the compiled expression (not `null`) compile(String the expression string (must not be `null`) string, EnumSet<Expression.Flag> optional flags to apply which affect the compilation (must not be `null`) flags) Compile an expression string.
public String	Returns: the expanded string evaluate(BiConsumer<ResolveContext<RuntimeException>, StringBuilder> the expansion function to apply (must not be `null`) expandFunction) Evaluate the expression with the given expansion function.
public < the exception type thrown by the expansion function E extends Exception> String	Returns: the expanded string evaluateException(final ExceptionBiConsumer<ResolveContext<E>, StringBuilder, E> the expansion function to apply (must not be `null`) expandFunction) Evaluate the expression with the given expansion function, which may throw a checked exception.
public String	Returns: the expanded string evaluateWithEnvironment(boolean `true` to throw an `IllegalArgumentException` if an unresolvable key has no default value; `false` to expand such keys to an empty string failOnNoDefault) Evaluate the expression using a default expansion function that evaluates environment properties.
public String	Returns: the expanded string evaluateWithProperties(boolean `true` to throw an `IllegalArgumentException` if an unresolvable key has no default value; `false` to expand such keys to an empty string failOnNoDefault) Evaluate the expression using a default expansion function that evaluates system properties.
public String	Returns: the expanded string evaluateWithPropertiesAndEnvironment(boolean `true` to throw an `IllegalArgumentException` if an unresolvable key has no default value; `false` to expand such keys to an empty string failOnNoDefault) Evaluate the expression using a default expansion function that evaluates system and environment properties in the JBoss style (i.e. using the prefix `"env."` to designate an environment property).
public Set<String>	Returns: the immutable set of strings (not `null`) getReferencedStrings() Get the immutable set of string keys that are referenced by expressions in this compiled expression.
private static IllegalArgumentException	invalidExpressionSyntax(final String string, final int index)
private static Node	parseString(Expression.Itr itr, final boolean allowExpr, final boolean endOnBrace, final boolean endOnColon, final EnumSet<Expression.Flag> flags)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

content	back to summary
private final Node content

EMPTY	back to summary
private static final Expression EMPTY

NO_FLAGS	back to summary
private static final EnumSet<Expression.Flag> NO_FLAGS

referencedStrings	back to summary
private final Set<String> referencedStrings

Constructor Detail

Expression	back to summary
pack-priv Expression(Node content)

Method Detail

compile back to summary

compile	back to summary
public static Expression compile(String string, Expression.Flag... flags) Compile an expression string. Parameters string:String the expression string (must not be `null`) flags:Expression.Flag[] optional flags to apply which affect the compilation Returns:Expression the compiled expression (not `null`)

public static Expression compile(String string, Expression.Flag... flags)

Compile an expression string.

Parameters

string:String: the expression string (must not be null)
flags:Expression.Flag[]: optional flags to apply which affect the compilation

Returns:Expression

the compiled expression (not null)

compile back to summary

compile	back to summary
public static Expression compile(String string, EnumSet<Expression.Flag> flags) Compile an expression string. Parameters string:String the expression string (must not be `null`) flags:EnumSet<Expression.Flag> optional flags to apply which affect the compilation (must not be `null`) Returns:Expression the compiled expression (not `null`)

public static Expression compile(String string, EnumSet<Expression.Flag> flags)

Compile an expression string.

Parameters

string:String: the expression string (must not be null)
flags:EnumSet<Expression.Flag>: optional flags to apply which affect the compilation (must not be null)

Returns:Expression

the compiled expression (not null)

evaluate back to summary

evaluate	back to summary
public String evaluate(BiConsumer<ResolveContext<RuntimeException>, StringBuilder> expandFunction) Evaluate the expression with the given expansion function. The given "function" is a predicate which returns `true` if the expansion succeeded or `false` if it failed (in which case a default value may be used). If expansion succeeds, the expansion function should append the result to the given `StringBuilder`. Parameters expandFunction:BiConsumer<ResolveContext<RuntimeException>, StringBuilder> the expansion function to apply (must not be `null`) Returns:String the expanded string

public String evaluate(BiConsumer<ResolveContext<RuntimeException>, StringBuilder> expandFunction)

Evaluate the expression with the given expansion function. The given "function" is a predicate which returns true if the expansion succeeded or false if it failed (in which case a default value may be used). If expansion succeeds, the expansion function should append the result to the given StringBuilder.

Parameters

expandFunction:BiConsumer<ResolveContext<RuntimeException>, StringBuilder>: the expansion function to apply (must not be null)

Returns:String

the expanded string

evaluateException back to summary

evaluateException	back to summary
public <E extends Exception> String evaluateException(final ExceptionBiConsumer<ResolveContext<E>, StringBuilder, E> expandFunction) throws ExceptionBiConsumer-:E Evaluate the expression with the given expansion function, which may throw a checked exception. The given "function" is a predicate which returns `true` if the expansion succeeded or `false` if it failed (in which case a default value may be used). If expansion succeeds, the expansion function should append the result to the given `StringBuilder`. Parameters <E> the exception type thrown by the expansion function expandFunction:ExceptionBiConsumer<ResolveContext<E>, StringBuilder, E> the expansion function to apply (must not be `null`) Returns:String the expanded string Exceptions ExceptionBiConsumer-:E: if the expansion function throws an exception

public <E extends Exception> String evaluateException(final ExceptionBiConsumer<ResolveContext<E>, StringBuilder, E> expandFunction) throws ExceptionBiConsumer-:E

Evaluate the expression with the given expansion function, which may throw a checked exception. The given "function" is a predicate which returns true if the expansion succeeded or false if it failed (in which case a default value may be used). If expansion succeeds, the expansion function should append the result to the given StringBuilder.

Parameters

<E>: the exception type thrown by the expansion function
expandFunction:ExceptionBiConsumer<ResolveContext<E>, StringBuilder, E>: the expansion function to apply (must not be null)

Returns:String

the expanded string

Exceptions

ExceptionBiConsumer-:E:: if the expansion function throws an exception

evaluateWithEnvironment back to summary

evaluateWithEnvironment	back to summary
public String evaluateWithEnvironment(boolean failOnNoDefault) Evaluate the expression using a default expansion function that evaluates environment properties. The caller must have all required security manager permissions. Parameters failOnNoDefault:boolean `true` to throw an `IllegalArgumentException` if an unresolvable key has no default value; `false` to expand such keys to an empty string Returns:String the expanded string

public String evaluateWithEnvironment(boolean failOnNoDefault)

Evaluate the expression using a default expansion function that evaluates environment properties. The caller must have all required security manager permissions.

Parameters

failOnNoDefault:boolean: true to throw an IllegalArgumentException if an unresolvable key has no default value; false to expand such keys to an empty string

Returns:String

the expanded string

evaluateWithProperties back to summary

evaluateWithProperties	back to summary
public String evaluateWithProperties(boolean failOnNoDefault) Evaluate the expression using a default expansion function that evaluates system properties. The caller must have all required security manager permissions. Parameters failOnNoDefault:boolean `true` to throw an `IllegalArgumentException` if an unresolvable key has no default value; `false` to expand such keys to an empty string Returns:String the expanded string

public String evaluateWithProperties(boolean failOnNoDefault)

Evaluate the expression using a default expansion function that evaluates system properties. The caller must have all required security manager permissions.

Parameters

failOnNoDefault:boolean: true to throw an IllegalArgumentException if an unresolvable key has no default value; false to expand such keys to an empty string

Returns:String

the expanded string

evaluateWithPropertiesAndEnvironment back to summary

evaluateWithPropertiesAndEnvironment	back to summary
public String evaluateWithPropertiesAndEnvironment(boolean failOnNoDefault) Evaluate the expression using a default expansion function that evaluates system and environment properties in the JBoss style (i.e. using the prefix `"env."` to designate an environment property). The caller must have all required security manager permissions. Parameters failOnNoDefault:boolean `true` to throw an `IllegalArgumentException` if an unresolvable key has no default value; `false` to expand such keys to an empty string Returns:String the expanded string

public String evaluateWithPropertiesAndEnvironment(boolean failOnNoDefault)

Evaluate the expression using a default expansion function that evaluates system and environment properties in the JBoss style (i.e. using the prefix "env." to designate an environment property). The caller must have all required security manager permissions.

Parameters

failOnNoDefault:boolean: true to throw an IllegalArgumentException if an unresolvable key has no default value; false to expand such keys to an empty string

Returns:String

the expanded string

getReferencedStrings back to summary

getReferencedStrings	back to summary
public Set<String> getReferencedStrings() Get the immutable set of string keys that are referenced by expressions in this compiled expression. If there are no expansions in this expression, the set is empty. Note that this will not include any string keys that themselves contain expressions, in the case that `Flag#NO_RECURSE_KEY` was not specified. Returns:Set<String> the immutable set of strings (not `null`)

public Set<String> getReferencedStrings()

Get the immutable set of string keys that are referenced by expressions in this compiled expression. If there are no expansions in this expression, the set is empty. Note that this will not include any string keys that themselves contain expressions, in the case that Flag#NO_RECURSE_KEY was not specified.

Returns:Set<String>: the immutable set of strings (not null)

invalidExpressionSyntax	back to summary
private static IllegalArgumentException invalidExpressionSyntax(final String string, final int index)

parseString	back to summary
private static Node parseString(Expression.Itr itr, final boolean allowExpr, final boolean endOnBrace, final boolean endOnColon, final EnumSet<Expression.Flag> flags)

io.smallrye.common.expression back to summary

public final Enum Expression.Flag

Class Inheritance

extends Enum<Expression.Flag>

java.lang.Object
java.lang.Enum
io.smallrye.common.expression.Expression.Flag

Flags that can apply to a property expression compilation

Field Summary

Modifier and Type	Field and Description
public static final Expression.Flag	DOUBLE_COLON Treat expressions containing a double-colon delimiter as special, encoding the entire content into the key.
public static final Expression.Flag	ESCAPES Support standard escape sequences in plain text and default value fields, which begin with a backslash ("`\`") character.
public static final Expression.Flag	GENERAL_EXPANSION Support `Policy` file style "general" expansion alternate expression syntax.
public static final Expression.Flag	LENIENT_SYNTAX Ignore syntax problems instead of throwing an exception.
public static final Expression.Flag	MINI_EXPRS Support single-character expressions that can be interpreted without wrapping in curly braces.
public static final Expression.Flag	NO_$$ Escaping `$` with `$$` or `/$` only applies when `{` follows the initial escaped `$`.
public static final Expression.Flag	NO_RECURSE_DEFAULT Do not support recursion in default values.
public static final Expression.Flag	NO_RECURSE_KEY Do not support recursive expression expansion in the key part of the expression.
public static final Expression.Flag	NO_SMART_BRACES Do not support smart braces.
public static final Expression.Flag	NO_TRIM Do not trim leading and trailing whitespace off of the expression string before parsing it.

Constructor Summary

Access	Constructor and Description
private	Flag()

Method Summary

Modifier and Type	Method and Description
public static Expression.Flag	valueOf(String name)
public static Expression.Flag[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DOUBLE_COLON	back to summary
public static final Expression.Flag DOUBLE_COLON Treat expressions containing a double-colon delimiter as special, encoding the entire content into the key.

ESCAPES	back to summary
public static final Expression.Flag ESCAPES Support standard escape sequences in plain text and default value fields, which begin with a backslash ("`\`") character.

GENERAL_EXPANSION	back to summary
public static final Expression.Flag GENERAL_EXPANSION Support `Policy` file style "general" expansion alternate expression syntax. "Smart" braces will only work if the opening brace is not the first character in the expression key.

LENIENT_SYNTAX	back to summary
public static final Expression.Flag LENIENT_SYNTAX Ignore syntax problems instead of throwing an exception.

MINI_EXPRS	back to summary
public static final Expression.Flag MINI_EXPRS Support single-character expressions that can be interpreted without wrapping in curly braces.

NO_$$	back to summary
public static final Expression.Flag NO_$$ Escaping `$` with `$$` or `/$` only applies when `{` follows the initial escaped `$`.

NO_RECURSE_DEFAULT	back to summary
public static final Expression.Flag NO_RECURSE_DEFAULT Do not support recursion in default values.

NO_RECURSE_KEY	back to summary
public static final Expression.Flag NO_RECURSE_KEY Do not support recursive expression expansion in the key part of the expression.

NO_SMART_BRACES	back to summary
public static final Expression.Flag NO_SMART_BRACES Do not support smart braces.

NO_TRIM	back to summary
public static final Expression.Flag NO_TRIM Do not trim leading and trailing whitespace off of the expression string before parsing it.

Constructor Detail

Flag	back to summary
private Flag()

Method Detail

valueOf	back to summary
public static Expression.Flag valueOf(String name)

values	back to summary
public static Expression.Flag[] values()

io.smallrye.common.expression back to summary

pack-priv final Class Expression.Itr

Class Inheritance

extends Object

java.lang.Object
io.smallrye.common.expression.Expression.Itr

Field Summary

Modifier and Type	Field and Description
private int	idx
private final String	str

Constructor Summary

Access	Constructor and Description
pack-priv	Itr(final String str)

Method Summary

Modifier and Type	Method and Description
pack-priv int	getNextIdx()
pack-priv int	getPrevIdx()
pack-priv String	getStr()
pack-priv boolean	hasNext()
pack-priv int	next()
pack-priv int	peekNext()
pack-priv int	peekPrev()
pack-priv int	prev()
pack-priv void	rewind(final int newNext)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

idx	back to summary
private int idx

str	back to summary
private final String str

Constructor Detail

Itr	back to summary
pack-priv Itr(final String str)

Method Detail

getNextIdx	back to summary
pack-priv int getNextIdx()

getPrevIdx	back to summary
pack-priv int getPrevIdx()

getStr	back to summary
pack-priv String getStr()

hasNext	back to summary
pack-priv boolean hasNext()

next	back to summary
pack-priv int next()

peekNext	back to summary
pack-priv int peekNext()

peekPrev	back to summary
pack-priv int peekPrev()

prev	back to summary
pack-priv int prev()

rewind	back to summary
pack-priv void rewind(final int newNext)

public final Class Expression

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Expression.Flag

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class Expression.Itr

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail