org.apache.shindig.gadgets.oauth

Enum OAuthArguments.UseToken

java.lang.Object

java.lang.Enum<OAuthArguments.UseToken>

org.apache.shindig.gadgets.oauth.OAuthArguments.UseToken

All Implemented Interfaces:

Serializable, Comparable<OAuthArguments.UseToken>

Enclosing class:

OAuthArguments

public static enum OAuthArguments.UseToken
extends Enum<OAuthArguments.UseToken>

Should the OAuth access token be used?

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Use the access token if it exists, and prompt if it doesn't
IF_AVAILABLE Use the access token if it exists already, but don't prompt for permission
NEVER Do not use the OAuth access token

Method Summary

Methods

Modifier and Type	Method and Description
static OAuthArguments.UseToken	valueOf(String name) Returns the enum constant of this type with the specified name.
static OAuthArguments.UseToken[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEVER

public static final OAuthArguments.UseToken NEVER

Do not use the OAuth access token

IF_AVAILABLE

public static final OAuthArguments.UseToken IF_AVAILABLE

Use the access token if it exists already, but don't prompt for permission

ALWAYS

public static final OAuthArguments.UseToken ALWAYS

Use the access token if it exists, and prompt if it doesn't

Method Detail

values

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

Returns:

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

valueOf

public static OAuthArguments.UseToken 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