net.sf.mmm.util.query.base

Enum QueryMode

java.lang.Object

java.lang.Enum<QueryMode>

net.sf.mmm.util.query.base.QueryMode

All Implemented Interfaces:

Serializable, Comparable<QueryMode>

public enum QueryMode
extends Enum<QueryMode>

This is the Enum for the available modes of a Query.

Since:

8.0.0

Author:

hohwille

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIRST Mode for a query where only the first result should be returned.
NORMAL Mode for a normal query.
UNIQUE Mode for a query where only a single unique result should match and be returned.

Method Summary

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

NORMAL

public static final QueryMode NORMAL

Mode for a normal query.

FIRST

public static final QueryMode FIRST

Mode for a query where only the first result should be returned.

UNIQUE

public static final QueryMode UNIQUE

Mode for a query where only a single unique result should match and be returned.

Method Detail

values

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

Returns:

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

valueOf

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