org.batoo.jpa.jdbc

Enum NumericFunctionType

java.lang.Object

java.lang.Enum<NumericFunctionType>

org.batoo.jpa.jdbc.NumericFunctionType

All Implemented Interfaces:

Serializable, Comparable<NumericFunctionType>

public enum NumericFunctionType
extends Enum<NumericFunctionType>

The types for the numberic functions.

Since:

2.0.0

Author:

hceylan

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABS The 'abs' function.
LENGTH The length function.
MOD The 'mod' function.
SQRT The 'sqrt' function.

Method Summary

Methods

Modifier and Type	Method and Description
String	getJpqlFragment() Returns the jpql fragment of the function type.
static NumericFunctionType	valueOf(String name) Returns the enum constant of this type with the specified name.
static NumericFunctionType[]	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

MOD

public static final NumericFunctionType MOD

The 'mod' function.

ABS

public static final NumericFunctionType ABS

The 'abs' function.

SQRT

public static final NumericFunctionType SQRT

The 'sqrt' function.

LENGTH

public static final NumericFunctionType LENGTH

The length function.

Method Detail

values

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

Returns:

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

valueOf

public static NumericFunctionType 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

getJpqlFragment

public String getJpqlFragment()

Returns the jpql fragment of the function type.

Returns:

the jpql fragment of the function type

Since:

2.0.1