org.apache.shindig.social.opensocial.model
Enum MessageCollection.Field

java.lang.Object
  java.lang.Enum<MessageCollection.Field>
      org.apache.shindig.social.opensocial.model.MessageCollection.Field

All Implemented Interfaces:

Serializable, Comparable<MessageCollection.Field>

Enclosing interface:

MessageCollection

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

An enumeration of field names in a message.

Enum Constant Summary

ID

TITLE
the field name for the title of this message collection.

TOTAL
the field name for total number of messages.

UNREAD
the field name for the total number of unread messages

UPDATED
The field name for the updated time stamp

Field Summary

static Set<String>

ALL_FIELDS

Method Summary

String	toString()
static MessageCollection.Field	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageCollection.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ID

public static final MessageCollection.Field ID

TITLE

public static final MessageCollection.Field TITLE

the field name for the title of this message collection.

TOTAL

public static final MessageCollection.Field TOTAL

the field name for total number of messages.

UNREAD

public static final MessageCollection.Field UNREAD

the field name for the total number of unread messages

UPDATED

public static final MessageCollection.Field UPDATED

The field name for the updated time stamp

Field Detail

ALL_FIELDS

public static final Set<String> ALL_FIELDS

Method Detail

values

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

Returns:

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

valueOf

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

Returns:

a string representation of the enum.