com.speedment.runtime.typemapper

Enum TypeMapper.Ordering

java.lang.Object

java.lang.Enum<TypeMapper.Ordering>

com.speedment.runtime.typemapper.TypeMapper.Ordering

All Implemented Interfaces:

Serializable, Comparable<TypeMapper.Ordering>

Enclosing interface:

TypeMapper<DB_TYPE,JAVA_TYPE>

public static enum TypeMapper.Ordering
extends Enum<TypeMapper.Ordering>

Indicates how the ordering of mapped vs un-mapped types relate to each other.

Since:

3.0.11

Author:

Per Minborg

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVERT Objects of the DB_TYPE type and objects of the the JAVA_TYPE have the inverted order.
RETAIN Objects of the DB_TYPE type and objects of the the JAVA_TYPE have the same order.
UNSPECIFIED Objects of the DB_TYPE type and objects of the the JAVA_TYPE may have different order.

Method Summary

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

RETAIN

public static final TypeMapper.Ordering RETAIN

Objects of the DB_TYPE type and objects of the the JAVA_TYPE have the same order. I.e. ordering is retained for mapped/un-mapped objects in both directions of mapping.

INVERT

public static final TypeMapper.Ordering INVERT

Objects of the DB_TYPE type and objects of the the JAVA_TYPE have the inverted order. I.e. ordering is reversed for mapped/un-mapped objects in both directions of mapping.

UNSPECIFIED

public static final TypeMapper.Ordering UNSPECIFIED

Objects of the DB_TYPE type and objects of the the JAVA_TYPE may have different order. I.e. ordering is unrelated for mapped/un-mapped objects in either direction of mapping. If either of the types does not have an order, then this alternative applies by definition.

Method Detail

values

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

Returns:

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

valueOf

public static TypeMapper.Ordering 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