Class ValueOrExpression<T>

java.lang.Object
org.forgerock.opendj.config.ValueOrExpression<T>
Type Parameters:
T - type of value that can be held
public final class ValueOrExpression<T> extends Object
Wraps either a value of a given type or an expression string containing at least one token.

Token(s) in an expression must use the pattern: 

&{some.token}
Example: a ValueOrExpression<Integer> could contain either the integer value 4444 or the expression "&{port}".

  • Field Details

  • Method Details

    • newExpression

      public static <T> ValueOrExpression<T> newExpression(String expression)
      Returns a wrapper for an expression.
      Type Parameters:
      T - type of value
      Parameters:
      expression - The expression
      Returns:
      a wrapper for an expression
      Throws:
      NullPointerException - if provided expression is null

    • newFileExpression

      public static ValueOrExpression<String> newFileExpression(String filePath)
      Returns a wrapper for an expression corresponding to a file path.
      Parameters:
      filePath - The file path to use in the expression
      Returns:
      a wrapper for an expression corresponding to a file path

    • newValue

      public static <T> ValueOrExpression<T> newValue(T value)
      Returns a wrapper for a value.
      Type Parameters:
      T - type of value
      Parameters:
      value - The actual value
      Returns:
      a wrapper for a value
      Throws:
      NullPointerException - if provided value is null

    • newValueOrNull

      public static <T> ValueOrExpression<T> newValueOrNull(T value)
      Returns a wrapper for a value, or null if a null value is provided.
      Type Parameters:
      T - type of value
      Parameters:
      value - The value which may be null
      Returns:
      a wrapper for a value, or null if a null value is provided

    • containsExpression

      public static boolean containsExpression(String expression)
      Validates the expression, checking it has at least one token.
      Parameters:
      expression - The expression to validate
      Returns:
      true if the expression is valid, false otherwise

    • getExpression

      public String getExpression()
      Returns the wrapped expression, or null if there is no expression.
      Returns:
      the wrapped expression, or null if there is no expression

    • getValue

      public T getValue()
      Returns the wrapped value or null if there is no value.
      Returns:
      the wrapped value or null if there is no value

    • getValueOrThrowIfExpression

      public T getValueOrThrowIfExpression() throws ExpressionException
      Returns the never null wrapped value, or throws if no value is available.
      Returns:
      the never null wrapped value, or throws if no value is available
      Throws:
      ExpressionException - if this expression does not contain a value

    • isExpression

      public boolean isExpression()
      Returns true if this wraps an expression, or false if it is a value.
      Returns:
      true if this wraps an expression, or false if it is a value

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object