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

Enum MetadataPolicy

java.lang.Object

java.lang.Enum<MetadataPolicy>

org.gcube.informationsystem.resourceregistry.api.rest.MetadataPolicy

All Implemented Interfaces:

Serializable, Comparable<MetadataPolicy>

public enum MetadataPolicy
extends Enum<MetadataPolicy>

Controls metadata inclusion in REST responses.

The wire format uses lowercase values (e.g. "none"). Use toString() to obtain the wire value and fromString(String) for case-insensitive parsing.

Author:

Luca Frosini (ISTI - CNR)

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Include metadata on top-level and nested response elements.
NONE	Do not include metadata in the response.
ROOT	Include metadata only on top-level response elements.

Field Summary

Fields

Modifier and Type	Field	Description
static MetadataPolicy	DEFAULT	The default metadata policy when no parameter is supplied.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final MetadataPolicy NONE

Do not include metadata in the response.

ROOT

public static final MetadataPolicy ROOT

Include metadata only on top-level response elements.

ALL

public static final MetadataPolicy ALL

Include metadata on top-level and nested response elements.

Field Detail

DEFAULT

public static final MetadataPolicy DEFAULT

The default metadata policy when no parameter is supplied.

Method Detail

values

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

Returns:

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

valueOf

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

fromString

public static MetadataPolicy fromString(String s)

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

Parameters:

s - the wire string to parse

Returns:

the matching MetadataPolicy, or null if unrecognised

toString

public String toString()

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

Overrides:

toString in class Enum<MetadataPolicy>