org.eclipse.persistence.jpa.jpql.parser

Enum TrimExpression.Specification

java.lang.Object

java.lang.Enum<TrimExpression.Specification>

org.eclipse.persistence.jpa.jpql.parser.TrimExpression.Specification

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TrimExpression.Specification>

Enclosing class:

TrimExpression

public static enum TrimExpression.Specification
extends java.lang.Enum<TrimExpression.Specification>

The possible ways to trim the string.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH The leading and trailing parts of the string will be trimmed.
DEFAULT Used when the trim specification is not specified, by default it means the leading and trailing parts of the string will be trimmed.
LEADING Only the leading part of the string will be trimmed.
TRAILING Only the trailing part of the string will be trimmed.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getValue() Returns the actual identifier associated with the constant.
static TrimExpression.Specification	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TrimExpression.Specification[]	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

BOTH

public static final TrimExpression.Specification BOTH

The leading and trailing parts of the string will be trimmed.

DEFAULT

public static final TrimExpression.Specification DEFAULT

Used when the trim specification is not specified, by default it means the leading and trailing parts of the string will be trimmed.

LEADING

public static final TrimExpression.Specification LEADING

Only the leading part of the string will be trimmed.

TRAILING

public static final TrimExpression.Specification TRAILING

Only the trailing part of the string will be trimmed.

Method Detail

values

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

Returns:

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

valueOf

public static TrimExpression.Specification 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

getValue

public java.lang.String getValue()

Returns the actual identifier associated with the constant.

Returns:

The identifier associated with the constant or an empty string for DEFAULT