org.apache.shindig.social.opensocial.model
Enum NetworkPresence

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

All Implemented Interfaces:

Serializable, Comparable<NetworkPresence>, Enum.EnumKey

public enum NetworkPresence
extends Enum<NetworkPresence>
implements Enum.EnumKey

public java.lang.Enum for opensocial.Enum.NetworkPresence.

Enum Constant Summary

AWAY
Currently online but away.

CHAT
In a chat or available to chat.

DND
Online, but don't disturb.

OFFLINE
Currently Offline.

ONLINE
Currently Online.

XA
Gone away for a longer period of time.

Method Summary

String	getDisplayValue()
String	toString()
static NetworkPresence	valueOf(String name) Returns the enum constant of this type with the specified name.
static NetworkPresence[]	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

ONLINE

public static final NetworkPresence ONLINE

Currently Online.

OFFLINE

public static final NetworkPresence OFFLINE

Currently Offline.

AWAY

public static final NetworkPresence AWAY

Currently online but away.

CHAT

public static final NetworkPresence CHAT

In a chat or available to chat.

DND

public static final NetworkPresence DND

Online, but don't disturb.

XA

public static final NetworkPresence XA

Gone away for a longer period of time.

Method Detail

values

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

Returns:

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

valueOf

public static NetworkPresence 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<NetworkPresence>

See Also:

Enum.toString()

getDisplayValue

public String getDisplayValue()

Specified by:

getDisplayValue in interface Enum.EnumKey

See Also:

Enum.EnumKey.getDisplayValue()