com.communote.server.model.client

Class ClientStatus

java.lang.Object

com.communote.server.model.client.ClientStatus

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ClientStatusEnum

public class ClientStatus
extends Object
implements Serializable

Author:

Communote GmbH - http://www.communote.com/

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ClientStatus	ACTIVE The client has been created and is active.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientStatus() The default constructor allowing super classes to access it.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object that)
static ClientStatus	define(String value) Define a new client status type
boolean	equals(Object object)
static ClientStatus	fromString(String value) Creates an instance of ClientStatus from value.
String	getValue() Gets the underlying value of this type safe enumeration.
int	hashCode()
static List<String>	literals() Returns an unmodifiable list containing the literals that are known by this enumeration.
String	toString()
static void	undefine(ClientStatus status) Remove a status type that was previously added via define(String).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ACTIVE

public static final ClientStatus ACTIVE

The client has been created and is active.

Constructor Detail

ClientStatus

protected ClientStatus()

The default constructor allowing super classes to access it.

Method Detail

define

public static ClientStatus define(String value)

Define a new client status type

Parameters:

value - the value of the status

Returns:

the added status

fromString

public static ClientStatus fromString(String value)

Creates an instance of ClientStatus from value.

Parameters:

value - the value to create the ClientStatus from.

literals

public static List<String> literals()

Returns an unmodifiable list containing the literals that are known by this enumeration.

Returns:

A List containing the actual literals defined by this enumeration, this list can not be modified.

undefine

public static void undefine(ClientStatus status)

Remove a status type that was previously added via define(String). After undefining the type fromString will throw an exception if the status to resolve is not known. The built-in types cannot be undefined.

Parameters:

status - the status to remove

compareTo

public int compareTo(Object that)

See Also:

Comparable.compareTo(Object)

equals

public boolean equals(Object object)

Overrides:

equals in class Object

See Also:

Object.equals(Object)

getValue

public String getValue()

Gets the underlying value of this type safe enumeration.

Returns:

the underlying value.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()