Package org.eclipse.persistence.jpa.jpql

Enum LiteralType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<LiteralType>
    public enum LiteralType
extends java.lang.Enum<LiteralType>
    Some Expression can have a "literal", this enumeration is used to visit an Expression and to retrieve the right value.

    Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

    Version:
    2.4
    See Also:
    JPQLQueryContext.literal(Expression, LiteralType), LiteralVisitor
    Author:
    Pascal Filion
    Since:
    2.3

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static LiteralType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static LiteralType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • ABSTRACT_SCHEMA_NAME

        public static final LiteralType ABSTRACT_SCHEMA_NAME
        Retrieves the abstract schema name only.

      • ENTITY_TYPE

        public static final LiteralType ENTITY_TYPE
        Retrieves the entity type name only.

      • IDENTIFICATION_VARIABLE

        public static final LiteralType IDENTIFICATION_VARIABLE
        Retrieves an identification variable name only.

      • INPUT_PARAMETER

        public static final LiteralType INPUT_PARAMETER
        Retrieves the input parameter value.

      • PATH_EXPRESSION_ALL_PATH

        public static final LiteralType PATH_EXPRESSION_ALL_PATH
        Retrieves the entire state field path or collection-valued path expression.

      • PATH_EXPRESSION_IDENTIFICATION_VARIABLE

        public static final LiteralType PATH_EXPRESSION_IDENTIFICATION_VARIABLE
        Retrieves the identification variable name of a path expression.

      • PATH_EXPRESSION_LAST_PATH

        public static final LiteralType PATH_EXPRESSION_LAST_PATH
        Retrieves the last path of a state field path or collection-valued path expression.

      • RESULT_VARIABLE

        public static final LiteralType RESULT_VARIABLE
        Retrieves the result variable.

      • STRING_LITERAL

        public static final LiteralType STRING_LITERAL
        Retrieves the string literal only.

    • Method Detail

      • values

        public static LiteralType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (LiteralType c : LiteralType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static LiteralType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null