Package org.wildfly.common.expression

Class ResolveContext<E extends Exception>

java.lang.Object
org.wildfly.common.expression.ResolveContext<E>
Type Parameters:
E - the exception type that can be thrown by the expansion function
public final class ResolveContext<E extends Exception> extends Object
The expression resolve context, which can be used to query the current expression key, write out expansions or default values, or perform validation.

The expression context is not thread-safe and is not valid outside of the property expansion function body.

Author:
David M. Lloyd

  • Method Details

    • getKey

      public String getKey() throws E
      Get the expression resolution key, as a string. If the key contains an expression, it will have been expanded unless Expression.Flag.NO_RECURSE_KEY was given. The result is not cached and will be re-expanded every time this method is called.
      Returns:
      the expanded key (not null)
      Throws:
      E - if the recursive expansion threw an exception

    • expandDefault

      public void expandDefault(StringBuilder target) throws E
      Expand the default value to the given string builder. If the default value contains an expression, it will have been expanded unless Expression.Flag.NO_RECURSE_DEFAULT was given. The result is not cached and will be re-expanded every time this method is called.
      Parameters:
      target - the string builder target
      Throws:
      E - if the recursive expansion threw an exception

    • expandDefault

      public void expandDefault() throws E
      Expand the default value to the current target string builder. If the default value contains an expression, it will have been expanded unless Expression.Flag.NO_RECURSE_DEFAULT was given. The result is not cached and will be re-expanded every time this method is called.
      Throws:
      E - if the recursive expansion threw an exception

    • getExpandedDefault

      public String getExpandedDefault() throws E
      Expand the default value to a string. If the default value contains an expression, it will have been expanded unless Expression.Flag.NO_RECURSE_DEFAULT was given. The result is not cached and will be re-expanded every time this method is called.
      Returns:
      the expanded string (not null)
      Throws:
      E - if the recursive expansion threw an exception

    • hasDefault

      public boolean hasDefault()
      Determine if the current expression has a default value.
      Returns:
      true if there is a default value, false otherwise