org.apache.shindig.social.opensocial.model

Enum Group.Field

java.lang.Object

java.lang.Enum<Group.Field>

org.apache.shindig.social.opensocial.model.Group.Field

All Implemented Interfaces:

Serializable, Comparable<Group.Field>

Enclosing interface:

Group

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESCRIPTION Description of group Optional.
ID Unique ID for this group Required.
TITLE Title of group Required.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	ALL_FIELDS The set of all fields.
static Set<String>	DEFAULT_FIELDS The set of default fields returned fields.

Method Summary

Methods

Modifier and Type	Method and Description
static Group.Field	fromUrlString(String jsonString) Converts from a url string (usually passed in the fields= parameter) into the corresponding field enum.
String	toString() Emit the field as a JSON element.
static Group.Field	valueOf(String name) Returns the enum constant of this type with the specified name.
static Group.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 Group.Field ID

Unique ID for this group Required.

TITLE

public static final Group.Field TITLE

Title of group Required.

DESCRIPTION

public static final Group.Field DESCRIPTION

Description of group Optional.

Field Detail

ALL_FIELDS

public static final Set<String> ALL_FIELDS

The set of all fields.

DEFAULT_FIELDS

public static final Set<String> DEFAULT_FIELDS

The set of default fields returned fields.

Method Detail

values

public static Group.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 (Group.Field c : Group.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 Group.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()

Emit the field as a JSON element.

Overrides:

toString in class Enum<Group.Field>

Returns:

the field name

fromUrlString

public static Group.Field fromUrlString(String jsonString)

Converts from a url string (usually passed in the fields= parameter) into the corresponding field enum.

Parameters:

jsonString - The string to translate.

Returns:

The corresponding group field.