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

Enum Class OperationReturn

java.lang.Object

java.lang.Enum<OperationReturn>

org.gcube.informationsystem.resourceregistry.api.rest.OperationReturn

All Implemented Interfaces:

Serializable, Comparable<OperationReturn>, Constable

public enum OperationReturn
extends Enum<OperationReturn>

Controls the payload density returned by operation-envelope endpoints.

The wire format follows the Prefer / Preference-Applied return token syntax (e.g. "return=representation").

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
MINIMAL	Minimal operation envelope.
REPRESENTATION	Full operation envelope.

Field Summary

Fields

Modifier and Type	Field	Description
static final OperationReturn	DEFAULT	The default operation return when no Prefer header is supplied.

Method Summary

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

REPRESENTATION

public static final OperationReturn REPRESENTATION

Full operation envelope.

MINIMAL

public static final OperationReturn MINIMAL

Minimal operation envelope.

Field Details

DEFAULT

public static final OperationReturn DEFAULT

The default operation return when no Prefer header is supplied.

Method Details

values

public static OperationReturn[] 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 OperationReturn 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 OperationReturn fromString(String s)

Parses a wire value (case-insensitive). Returns null for unrecognised strings.

Parameters:

s - the wire string to parse

Returns:

the matching OperationReturn, or null if unrecognised

toString

public String toString()

Returns the wire value (e.g. "return=representation").

Overrides:

toString in class Enum<OperationReturn>