com.google.gwt.gadgets.client.io
Enum OAuthUseTokenOptions

java.lang.Object
  java.lang.Enum<OAuthUseTokenOptions>
      com.google.gwt.gadgets.client.io.OAuthUseTokenOptions

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OAuthUseTokenOptions>

public enum OAuthUseTokenOptions
extends java.lang.Enum<OAuthUseTokenOptions>

An enum representing the gadgets.io.RequestParameters.OAUTH_USE_TOKEN options.

Enum Constant Summary

ALWAYS

IF_AVAILABLE

NEVER

Method Summary

java.lang.String	getUseTokenOption() Returns the String representing when to use OAuth tokens.
static OAuthUseTokenOptions	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OAuthUseTokenOptions[]	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

ALWAYS

public static final OAuthUseTokenOptions ALWAYS

IF_AVAILABLE

public static final OAuthUseTokenOptions IF_AVAILABLE

NEVER

public static final OAuthUseTokenOptions NEVER

Method Detail

values

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

Returns:

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

valueOf

public static OAuthUseTokenOptions valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getUseTokenOption

public java.lang.String getUseTokenOption()

Returns the String representing when to use OAuth tokens.

Returns:

the String representing when to use OAuth tokens.