Module org.eclipse.persistence.jpa.jpql

Package org.eclipse.persistence.jpa.jpql.tools.model

Enum IJPQLQueryFormatter.IdentifierStyle

java.lang.Object

java.lang.Enum<IJPQLQueryFormatter.IdentifierStyle>

org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryFormatter.IdentifierStyle

All Implemented Interfaces:

Serializable, Comparable<IJPQLQueryFormatter.IdentifierStyle>, java.lang.constant.Constable

Enclosing interface:

IJPQLQueryFormatter

public static enum IJPQLQueryFormatter.IdentifierStyle
extends Enum<IJPQLQueryFormatter.IdentifierStyle>

This enumeration determines how the JPQL identifiers are formatted when written out.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CAPITALIZE_EACH_WORD	The JPQL identifiers are written out the first letter being uppercase and the rest being lower case.
LOWERCASE	The JPQL identifiers are written out with lowercase letters.
UPPERCASE	The JPQL identifiers are written out with uppercase letters.

Method Summary

Modifier and Type	Method	Description
String	capitalizeEachWord(String identifier)	Returns the given JPQL identifier with the first letter of each word capitalized and the rest being lower case.
String	formatIdentifier(String identifier)	Formats the given JPQL identifier, if it needs to be decorated with more information.
static IJPQLQueryFormatter.IdentifierStyle	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IJPQLQueryFormatter.IdentifierStyle[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CAPITALIZE_EACH_WORD

public static final IJPQLQueryFormatter.IdentifierStyle CAPITALIZE_EACH_WORD

The JPQL identifiers are written out the first letter being uppercase and the rest being lower case.

LOWERCASE

public static final IJPQLQueryFormatter.IdentifierStyle LOWERCASE

The JPQL identifiers are written out with lowercase letters.

UPPERCASE

public static final IJPQLQueryFormatter.IdentifierStyle UPPERCASE

The JPQL identifiers are written out with uppercase letters.

Method Details

values

public static IJPQLQueryFormatter.IdentifierStyle[] values()

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

Returns:

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

valueOf

public static IJPQLQueryFormatter.IdentifierStyle 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

capitalizeEachWord

public String capitalizeEachWord(String identifier)

Returns the given JPQL identifier with the first letter of each word capitalized and the rest being lower case.

Parameters:

identifier - The JPQL identifier to format

Returns:

The formatted JPQL identifier

formatIdentifier

public String formatIdentifier(String identifier)

Formats the given JPQL identifier, if it needs to be decorated with more information. Which depends on how the string is created.

Parameters:

identifier - JPQL identifier to format

Returns:

By default the given identifier is returned