Package org.eclipse.persistence.jpa.jpql

Enum JPQLQueryDeclaration.Type

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<JPQLQueryDeclaration.Type>
    Enclosing interface:
    JPQLQueryDeclaration
    public static enum JPQLQueryDeclaration.Type
extends java.lang.Enum<JPQLQueryDeclaration.Type>
    This enum type defines the various types of declarations supported by both the JPA functional specification and EclipseLink.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CLASS_NAME
      Indicates the "root" object maps a fully qualified class name.
      COLLECTION
      Indicates the "root" object maps a collection-valued path expression.
      DERIVED
      Indicates the "root" object is a derived path expression where the identification variable is declared in the super query, otherwise it's an entity name.
      RANGE
      Indicates the "root" object maps to an entity.
      SUBQUERY
      Indicates the "root" object maps to a subquery.
      TABLE
      Indicates the "root" object maps directly to a database table.
      UNKNOWN
      Indicates the "root" object maps to an unknown expression.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isRange()
      Determines whether this type represents a range variable declaration.
      static JPQLQueryDeclaration.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static JPQLQueryDeclaration.Type[] 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

      • CLASS_NAME

        public static final JPQLQueryDeclaration.Type CLASS_NAME
        Indicates the "root" object maps a fully qualified class name.

      • COLLECTION

        public static final JPQLQueryDeclaration.Type COLLECTION
        Indicates the "root" object maps a collection-valued path expression.

      • DERIVED

        public static final JPQLQueryDeclaration.Type DERIVED
        Indicates the "root" object is a derived path expression where the identification variable is declared in the super query, otherwise it's an entity name.

    • Method Detail

      • values

        public static JPQLQueryDeclaration.Type[] 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 (JPQLQueryDeclaration.Type c : JPQLQueryDeclaration.Type.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static JPQLQueryDeclaration.Type 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

      • isRange

        public boolean isRange()
        Determines whether this type represents a range variable declaration.
        Returns:
        true if this constant represents a range variable declaration; false otherwise