Package com.qfs.snl.ws

Enum Class IMessageWsService.FetchMessageMode

java.lang.Object

java.lang.Enum<IMessageWsService.FetchMessageMode>

com.qfs.snl.ws.IMessageWsService.FetchMessageMode

All Implemented Interfaces:

Serializable, Comparable<IMessageWsService.FetchMessageMode>, java.lang.constant.Constable

Enclosing interface:

IMessageWsService

public static enum IMessageWsService.FetchMessageMode
extends Enum<IMessageWsService.FetchMessageMode>

The authorized type of message fetching when a socket connects to the service.

Author:

ActiveViam

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Fetch all messages existing for the user.
NONE	Fetch none of the existing messages.
UNREAD	Fetch mode to get only unread messages.

Method Summary

Modifier and Type	Method	Description
static IMessageWsService.FetchMessageMode	fromName(String name)	Returns the enum value from its name, as defined by getName().
String	getName()
static IMessageWsService.FetchMessageMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IMessageWsService.FetchMessageMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final IMessageWsService.FetchMessageMode NONE

Fetch none of the existing messages.

UNREAD

public static final IMessageWsService.FetchMessageMode UNREAD

Fetch mode to get only unread messages.

ALL

public static final IMessageWsService.FetchMessageMode ALL

Fetch all messages existing for the user.

Method Details

values

public static IMessageWsService.FetchMessageMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static IMessageWsService.FetchMessageMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

fromName

public static IMessageWsService.FetchMessageMode fromName(String name)

Returns the enum value from its name, as defined by getName().