com.atlassian.rest.annotation

Enum RestProperty.Scope

java.lang.Object

java.lang.Enum<RestProperty.Scope>

com.atlassian.rest.annotation.RestProperty.Scope

All Implemented Interfaces:

Serializable, Comparable<RestProperty.Scope>

Enclosing class:

RestProperty

public static enum RestProperty.Scope
extends Enum<RestProperty.Scope>

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO if the field name is self or expand then RESPONSE, otherwise BOTH
BOTH for fields available in requests and in responses
REQUEST for fields available only in requests
RESPONSE for fields available only in responses

Method Summary

Modifier and Type	Method and Description
boolean	contains(RestProperty.Scope scope)
boolean	includes(RestProperty.Scope fieldScope, String fieldName)
static RestProperty.Scope	valueOf(String name) Returns the enum constant of this type with the specified name.
static RestProperty.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

REQUEST

public static final RestProperty.Scope REQUEST

for fields available only in requests

RESPONSE

public static final RestProperty.Scope RESPONSE

for fields available only in responses

BOTH

public static final RestProperty.Scope BOTH

for fields available in requests and in responses

AUTO

public static final RestProperty.Scope AUTO

if the field name is self or expand then RESPONSE, otherwise BOTH

Method Detail

values

public static RestProperty.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 (RestProperty.Scope c : RestProperty.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 RestProperty.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

contains

public boolean contains(RestProperty.Scope scope)

includes

public boolean includes(RestProperty.Scope fieldScope,
                        String fieldName)