Package org.wso2.carbon.registry.social.api.message

Enum Message.Field

java.lang.Object

java.lang.Enum<Message.Field>

org.wso2.carbon.registry.social.api.message.Message.Field

All Implemented Interfaces:

Serializable, Comparable<Message.Field>, java.lang.constant.Constable

Enclosing interface:

Message

public static enum Message.Field
extends Enum<Message.Field>

An enumeration of field names in a message.

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
APP_URL
BODY	the field name for body.
BODY_ID	the field name for body id.
COLLECTION_IDS	the field name for the collection IDs
ID	the field name for the unique ID of this message.
IN_REPLY_TO	the field name for the Parent Message Id for this message.
RECIPIENTS	the field name for recipient list.
REPLIES	the field name for replies to this message
SENDER_ID	the field name for the ID of the person who sent this message.
STATUS	the field name for status.
TIME_SENT	the field name for the time this message was sent.
TITLE	the field name for title.
TITLE_ID	the field name for title id.
TYPE	the field name for type.
UPDATED	the field name for updated time stamp.
URLS	the field name for urls.

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	ALL_FIELDS

Method Summary

Modifier and Type	Method	Description
String	toString()
static Message.Field	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Message.Field[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

APP_URL

public static final Message.Field APP_URL

BODY

public static final Message.Field BODY

the field name for body.

BODY_ID

public static final Message.Field BODY_ID

the field name for body id.

COLLECTION_IDS

public static final Message.Field COLLECTION_IDS

the field name for the collection IDs

ID

public static final Message.Field ID

the field name for the unique ID of this message.

IN_REPLY_TO

public static final Message.Field IN_REPLY_TO

the field name for the Parent Message Id for this message.

REPLIES

public static final Message.Field REPLIES

the field name for replies to this message

RECIPIENTS

public static final Message.Field RECIPIENTS

the field name for recipient list.

SENDER_ID

public static final Message.Field SENDER_ID

the field name for the ID of the person who sent this message.

TIME_SENT

public static final Message.Field TIME_SENT

the field name for the time this message was sent.

TITLE

public static final Message.Field TITLE

the field name for title.

TITLE_ID

public static final Message.Field TITLE_ID

the field name for title id.

TYPE

public static final Message.Field TYPE

the field name for type.

STATUS

public static final Message.Field STATUS

the field name for status.

UPDATED

public static final Message.Field UPDATED

the field name for updated time stamp.

URLS

public static final Message.Field URLS

the field name for urls.

Field Details

ALL_FIELDS

public static final Set<String> ALL_FIELDS

Method Details

values

public static Message.Field[] values()

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

Returns:

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

valueOf

public static Message.Field 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

toString

public String toString()

Overrides:

toString in class Enum<Message.Field>

Returns:

a string representation of the enum.