Package org.gcube.informationsystem.resourceregistry.api.rest

Enum Class MembershipScope

java.lang.Object

java.lang.Enum<MembershipScope>

org.gcube.informationsystem.resourceregistry.api.rest.MembershipScope

All Implemented Interfaces:

Serializable, Comparable<MembershipScope>, Constable

public enum MembershipScope
extends Enum<MembershipScope>

Controls which memberships the returned contexts maps list.

The wire format uses lowercase values (e.g. "subtree"). Use toString() to obtain the wire value and fromString(String) to parse it; only the exact lowercase values are accepted.

Author:

Luca Frosini (ISTI - CNR)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GLOBAL	List every Context membership, independently of the token Context.
SUBTREE	List the memberships in the token Context and its descendants.

Field Summary

Fields

Modifier and Type	Field	Description
static final MembershipScope	DEFAULT	The default membership scope when no parameter is supplied.

Method Summary

Modifier and Type	Method	Description
static MembershipScope	fromString(String s)	Parses an exact lowercase wire value.
String	toString()	Returns the lowercase wire value (e.g.
static MembershipScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MembershipScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUBTREE

public static final MembershipScope SUBTREE

List the memberships in the token Context and its descendants.

GLOBAL

public static final MembershipScope GLOBAL

List every Context membership, independently of the token Context.

Field Details

DEFAULT

public static final MembershipScope DEFAULT

The default membership scope when no parameter is supplied.

Method Details

values

public static MembershipScope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MembershipScope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static MembershipScope fromString(String s)

Parses an exact lowercase wire value. Returns null for any other string.

Parameters:

s - the wire string to parse

Returns:

the matching MembershipScope, or null if unrecognised

toString

public String toString()

Returns the lowercase wire value (e.g. "subtree").

Overrides:

toString in class Enum<MembershipScope>