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

Enum Class ContextsPolicy

java.lang.Object

java.lang.Enum<ContextsPolicy>

org.gcube.informationsystem.resourceregistry.api.rest.ContextsPolicy

All Implemented Interfaces:

Serializable, Comparable<ContextsPolicy>, Constable

public enum ContextsPolicy
extends Enum<ContextsPolicy>

Controls contexts inclusion in REST responses.

The wire format uses lowercase values (e.g. "none"). 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
ALL	Include contexts on top-level and nested response elements.
NONE	Do not include contexts in the response.
ROOT	Include contexts only on top-level response elements.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextsPolicy	DEFAULT	The default contexts policy when no parameter is supplied.

Method Summary

Modifier and Type	Method	Description
static ContextsPolicy	fromString(String s)	Parses an exact lowercase wire value.
String	toString()	Returns the lowercase wire value (e.g.
static ContextsPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ContextsPolicy[]	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

NONE

public static final ContextsPolicy NONE

Do not include contexts in the response.

ROOT

public static final ContextsPolicy ROOT

Include contexts only on top-level response elements.

ALL

public static final ContextsPolicy ALL

Include contexts on top-level and nested response elements.

Field Details

DEFAULT

public static final ContextsPolicy DEFAULT

The default contexts policy when no parameter is supplied.

Method Details

values

public static ContextsPolicy[] 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 ContextsPolicy 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 ContextsPolicy 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 ContextsPolicy, or null if unrecognised

toString

public String toString()

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

Overrides:

toString in class Enum<ContextsPolicy>