StandardOperation (Java SE 14 & JDK 14)
Description: declaration: module: jdk.dynalink, package: jdk.dynalink, enum: StandardOperation
Keywords: jdk.dynalink.StandardOperation class

Module jdk.dynalink
Package jdk.dynalink

# Enum StandardOperation

java.lang.Object
java.lang.Enum<StandardOperation>
jdk.dynalink.StandardOperation

All Implemented Interfaces:
  `Serializable`, `Comparable<StandardOperation>`, `Constable`, `Operation`

    public enum StandardOperation
    extends Enum<StandardOperation>
    implements Operation

Defines the standard dynamic operations. The operations `GET` and `SET` must be used as part of a `NamespaceOperation`. `NamedOperation` can then be further used on these `NamespaceOperation`s to bind the name parameter of `GET` and `SET` operations, in which case it disappears from their type signature. `NamedOperation` can also be used to decorate `CALL` and `NEW` operations with a diagnostic name, and as such it does not affect their type signature.

- ## Nested Class Summary

  ## Nested classes/interfaces declared in class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant | Description
  --- | ---
  `CALL` | Call a callable object.
  `GET` | Get the value from a namespace defined on an object.
  `NEW` | Call a constructor object.
  `REMOVE` | Removes the value from a namespace defined on an object.
  `SET` | Set the value in a namespace defined on an object.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `static StandardOperation` | `valueOf​(String name)` | Returns the enum constant of this type with the specified name.
  `static StandardOperation[]` | `values()` | Returns an array containing the constants of this enum type, in the order they are declared.

  ### Methods declared in class java.lang.Enum

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

  ### Methods declared in class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

  ### Methods declared in interface jdk.dynalink.Operation

  `named, withNamespace, withNamespaces`

- ## Enum Constant Details

  - ### GET

    public static final StandardOperation GET
    Get the value from a namespace defined on an object. Call sites with this operation should have a signature of `(receiver, name)→value` or `(receiver)→value` when used with `NamedOperation`, with all parameters and return type being of any type (either primitive or reference). This operation must always be used as part of a `NamespaceOperation`.

  - ### SET

    public static final StandardOperation SET
    Set the value in a namespace defined on an object. Call sites with this operation should have a signature of `(receiver, name, value)→void` or `(receiver, value)→void` when used with `NamedOperation`, with all parameters and return type being of any type (either primitive or reference). This operation must always be used as part of a `NamespaceOperation`.

  - ### REMOVE

    public static final StandardOperation REMOVE
    Removes the value from a namespace defined on an object. Call sites with this operation should have a signature of `(receiver, name)→void` or `(receiver)→void` when used with `NamedOperation`, with all parameters being of any type (either primitive or reference). This operation must always be used as part of a `NamespaceOperation`.

  - ### CALL

    public static final StandardOperation CALL
    Call a callable object. Call sites with this operation should have a signature of `(callable, receiver, arguments...)→value`, with all parameters and return type being of any type (either primitive or reference). Typically, the callables are presumed to be methods of an object, so an explicit receiver value is always passed to the callable before the arguments. If a callable has no concept of a receiver, it is free to ignore the value of the receiver argument. The `CALL` operation is allowed to be used with a `NamedOperation` even though it does not take a name. Using it with a named operation won't affect its signature; the name is solely meant to be used as a diagnostic description for error messages.

  - ### NEW

    public static final StandardOperation NEW
    Call a constructor object. Call sites with this operation should have a signature of `(constructor, arguments...)→value`, with all parameters and return type being of any type (either primitive or reference). The `NEW` operation is allowed to be used with a `NamedOperation` even though it does not take a name. Using it with a named operation won't affect its signature; the name is solely meant to be used as a diagnostic description for error messages.

- ## Method Details

  - ### values

    public static StandardOperation[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    Returns:
      an array containing the constants of this enum type, in the order they are declared

  - ### valueOf

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