Package org.forgerock.openig.types

Class TypeDefinitions

java.lang.Object
org.forgerock.openig.types.TypeDefinitions
public final class TypeDefinitions extends Object
Type definitions helpers for generic types. Completes helper methods provided by TypeDefinition.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.forgerock.openig.model.type.StringTypeDefinition<Duration>
    DURATION_TYPE
    Represents the "Duration" type, which is a String with a specific Syntax.
    static final org.forgerock.openig.model.type.Syntax<Pattern>
    PATTERN_SYNTAX
    The "PATTERN"'s Syntax.
    static final org.forgerock.openig.model.type.StringTypeDefinition<Pattern>
    PATTERN_TYPE
    Represents the "Pattern" type, which is a String with a specific Syntax.
    static final org.forgerock.openig.model.type.Syntax<Version>
    PRODUCT_VERSION_SYNTAX
    The "PRODUCT_VERSION"'s Syntax.
    static final org.forgerock.openig.model.type.StringTypeDefinition<Version>
    PRODUCT_VERSION_TYPE
    Represents the "PRODUCT_VERSION" type, which is a String with a specific Syntax.
    static final org.forgerock.openig.model.type.Syntax<Realm>
    REALM_SYNTAX
    The "REALM"'s Syntax.
    static final org.forgerock.openig.model.type.StringTypeDefinition<Realm>
    REALM_TYPE
    Represents the "PRODUCT_VERSION" type, which is a String with a specific Syntax.
    static final org.forgerock.openig.model.type.StringTypeDefinition<URI>
    URI_TYPE
    Represents the "URI" type, which is a String with a specific Syntax.
    static final org.forgerock.openig.model.type.StringTypeDefinition<URL>
    URL_TYPE
    Represents the "URL" type, which is a String with a specific Syntax.

  • Method Summary

    Modifier and Type
    Method
    Description
    static <T> org.forgerock.openig.model.type.StringTypeDefinition<Expression<T>>
    expressionOf(Class<T> type)
    Represents a runtime Expression of type T, which is a String with a specific Syntax.
    static <T> org.forgerock.openig.model.type.Syntax<Expression<T>>
    expressionSyntaxOf(Class<T> type)
    Creates an expression Syntax that is bound to the given type.
    static <T> org.forgerock.openig.model.type.StringTypeDefinition<LeftValueExpression<T>>
    leftValueExpressionOf(Class<T> type)
    Represents a runtime LeftValueExpression of type T, which is a String with a specific Syntax.
    static <T> org.forgerock.openig.model.type.Syntax<LeftValueExpression<T>>
    leftValueExpressionSyntaxOf(Class<T> type)
    Creates a left-value expression Syntax that is bound to the given type.
    static <T extends Secret>
    org.forgerock.openig.model.type.StringTypeDefinition<Purpose<T>>
    purposeOf(Class<T> type)
    Represents a runtime Purpose of secret's type T, which is a String with a specific Syntax.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • DURATION_TYPE

      public static final org.forgerock.openig.model.type.StringTypeDefinition<Duration> DURATION_TYPE
      Represents the "Duration" type, which is a String with a specific Syntax.

    • URI_TYPE

      public static final org.forgerock.openig.model.type.StringTypeDefinition<URI> URI_TYPE
      Represents the "URI" type, which is a String with a specific Syntax.

    • URL_TYPE

      public static final org.forgerock.openig.model.type.StringTypeDefinition<URL> URL_TYPE
      Represents the "URL" type, which is a String with a specific Syntax.

    • PATTERN_SYNTAX

      public static final org.forgerock.openig.model.type.Syntax<Pattern> PATTERN_SYNTAX
      The "PATTERN"'s Syntax. See Pattern

    • PATTERN_TYPE

      public static final org.forgerock.openig.model.type.StringTypeDefinition<Pattern> PATTERN_TYPE
      Represents the "Pattern" type, which is a String with a specific Syntax.

    • PRODUCT_VERSION_SYNTAX

      public static final org.forgerock.openig.model.type.Syntax<Version> PRODUCT_VERSION_SYNTAX
      The "PRODUCT_VERSION"'s Syntax. See Version

    • PRODUCT_VERSION_TYPE

      public static final org.forgerock.openig.model.type.StringTypeDefinition<Version> PRODUCT_VERSION_TYPE
      Represents the "PRODUCT_VERSION" type, which is a String with a specific Syntax.

    • REALM_SYNTAX

      public static final org.forgerock.openig.model.type.Syntax<Realm> REALM_SYNTAX
      The "REALM"'s Syntax. See Realm

    • REALM_TYPE

      public static final org.forgerock.openig.model.type.StringTypeDefinition<Realm> REALM_TYPE
      Represents the "PRODUCT_VERSION" type, which is a String with a specific Syntax.

  • Method Details

    • expressionOf

      public static <T> org.forgerock.openig.model.type.StringTypeDefinition<Expression<T>> expressionOf(Class<T> type)
      Represents a runtime Expression of type T, which is a String with a specific Syntax.
      Type Parameters:
      T - The Expression's type
      Parameters:
      type - The Expression's type
      Returns:
      The TypeDefinition of a runtime expression.

    • expressionSyntaxOf

      public static <T> org.forgerock.openig.model.type.Syntax<Expression<T>> expressionSyntaxOf(Class<T> type)
      Creates an expression Syntax that is bound to the given type.

      The produced syntax can coerce a String into a Expression<T> and the reverse (based on toString() of the expression).

      Type Parameters:
      T - Expression's type
      Parameters:
      type - expression's type (never null)
      Returns:
      a new Syntax that will parse a String into

    • leftValueExpressionOf

      public static <T> org.forgerock.openig.model.type.StringTypeDefinition<LeftValueExpression<T>> leftValueExpressionOf(Class<T> type)
      Represents a runtime LeftValueExpression of type T, which is a String with a specific Syntax.
      Type Parameters:
      T - LeftValueExpression's type
      Parameters:
      type - The left-value expression's type
      Returns:
      The TypeDefinition of a left-value expression.

    • leftValueExpressionSyntaxOf

      public static <T> org.forgerock.openig.model.type.Syntax<LeftValueExpression<T>> leftValueExpressionSyntaxOf(Class<T> type)
      Creates a left-value expression Syntax that is bound to the given type.

      The produced syntax can coerce a String into a LeftValueExpression<T> and the reverse (based on toString() of the expression).

      Type Parameters:
      T - LeftValueExpression's type
      Parameters:
      type - left-value expression's type (never null)
      Returns:
      a new Syntax that will parse a String into

    • purposeOf

      public static <T extends Secret> org.forgerock.openig.model.type.StringTypeDefinition<Purpose<T>> purposeOf(Class<T> type)
      Represents a runtime Purpose of secret's type T, which is a String with a specific Syntax.
      Type Parameters:
      T - The Secret's type
      Parameters:
      type - The Secret's type
      Returns:
      The TypeDefinition of a Purpose.