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

Enum OperationReturn

  • All Implemented Interfaces:
    Serializable, Comparable<OperationReturn>
    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)

    • Enum Constant Detail

      • REPRESENTATION

        public static final OperationReturn REPRESENTATION
        Full operation envelope.

      • MINIMAL

        public static final OperationReturn MINIMAL
        Minimal operation envelope.

    • Field Detail

      • DEFAULT

        public static final OperationReturn DEFAULT
        The default operation return when no Prefer header is supplied.

    • Method Detail

      • values

        public static OperationReturn[] 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 (OperationReturn c : OperationReturn.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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