org.cyclos.model.users.contacts

Enum ContactOrderBy

java.lang.Object

java.lang.Enum<ContactOrderBy>

org.cyclos.model.users.contacts.ContactOrderBy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ContactOrderBy>, HasMessageKey

public enum ContactOrderBy
extends java.lang.Enum<ContactOrderBy>
implements HasMessageKey

Contains the possible order by values for searching contacts

Author:

luis

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALPHABETICALLY_ASC
ALPHABETICALLY_DESC
RELEVANCE

Method Summary

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

RELEVANCE

public static final ContactOrderBy RELEVANCE

ALPHABETICALLY_ASC

public static final ContactOrderBy ALPHABETICALLY_ASC

ALPHABETICALLY_DESC

public static final ContactOrderBy ALPHABETICALLY_DESC

Method Detail

values

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

Returns:

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

valueOf

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

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey