org.shredzone.flattr4j.oauth

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

org.shredzone.flattr4j.oauth.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>

public enum Scope
extends Enum<Scope>

Scope of rights the consumer requests from the user.

Author:

Richard "Shred" Körber

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMAIL The consumer wants to read the user's email address.
EXTENDEDREAD The application has read access, plus access to private user information and hidden things for the authenticated user.
FLATTR The consumer wants to flattr things.
THING The consumer wants to create, update and delete things.

Method Summary

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

FLATTR

public static final Scope FLATTR

The consumer wants to flattr things.

Since:

2.0

THING

public static final Scope THING

The consumer wants to create, update and delete things.

Since:

2.0

EMAIL

public static final Scope EMAIL

The consumer wants to read the user's email address.

Since:

2.2

EXTENDEDREAD

public static final Scope EXTENDEDREAD

The application has read access, plus access to private user information and hidden things for the authenticated user.

Method Detail

values

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

Returns:

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

valueOf

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