org.eclipse.jpt.jpa.core.jpql
Enum JpaJpqlQueryHelper.EscapeType

java.lang.Object
  java.lang.Enum<JpaJpqlQueryHelper.EscapeType>
      org.eclipse.jpt.jpa.core.jpql.JpaJpqlQueryHelper.EscapeType

All Implemented Interfaces:

Serializable, Comparable<JpaJpqlQueryHelper.EscapeType>

Enclosing class:

JpaJpqlQueryHelper

public static enum JpaJpqlQueryHelper.EscapeType
extends Enum<JpaJpqlQueryHelper.EscapeType>

Constants used to determine how to escape the JPQL query.

Enum Constant Summary

JAVA
Escapes some characters when the JPQL query is in an annotation, eg: \t becomes \\t.

NONE
No modification will be performed on the JPQL query.

XML
Escapes XML reserved characters when the JPQL query is in defined xml, eg: > becomes >.

Method Summary

static JpaJpqlQueryHelper.EscapeType	valueOf(String name) Returns the enum constant of this type with the specified name.
static JpaJpqlQueryHelper.EscapeType[]	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

JAVA

public static final JpaJpqlQueryHelper.EscapeType JAVA

Escapes some characters when the JPQL query is in an annotation, eg: \t becomes \\t.

NONE

public static final JpaJpqlQueryHelper.EscapeType NONE

No modification will be performed on the JPQL query.

XML

public static final JpaJpqlQueryHelper.EscapeType XML

Escapes XML reserved characters when the JPQL query is in defined xml, eg: > becomes >.

Method Detail

values

public static JpaJpqlQueryHelper.EscapeType[] 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 (JpaJpqlQueryHelper.EscapeType c : JpaJpqlQueryHelper.EscapeType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JpaJpqlQueryHelper.EscapeType valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null