Package org.codehaus.groovy.ast

# Enum Class MultipleAssignmentMetadata

java.lang.Object
java.lang.Enum<MultipleAssignmentMetadata>
org.codehaus.groovy.ast.MultipleAssignmentMetadata

All Implemented Interfaces:
  `Serializable`, `Comparable<MultipleAssignmentMetadata>`, `Constable`

public enum MultipleAssignmentMetadata extends Enum<MultipleAssignmentMetadata>
AST node metadata keys used by the multi-assignment destructuring pipeline introduced in GEP-20. Each key is attached to a `VariableExpression` appearing inside the `TupleExpression` on the LHS of a `DeclarationExpression`.

Since:
  6.0.0

- ## 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
  `MAP_KEY`
  Value is the key name (String) used for a map-style `key: ident` binder.
  `REST_BINDING`
  Marker on the rest binder (the `*ident` slot).

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static MultipleAssignmentMetadata`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static MultipleAssignmentMetadata[]`
  `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, toString, valueOf`

  ### Methods inherited from class java.lang.Object

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

- ## Enum Constant Details

  - ### REST_BINDING

    public static final MultipleAssignmentMetadata REST_BINDING
    Marker on the rest binder (the `*ident` slot). Value is `Boolean.TRUE`.

  - ### MAP_KEY

    public static final MultipleAssignmentMetadata MAP_KEY
    Value is the key name (String) used for a map-style `key: ident` binder.

- ## Method Details

  - ### values

    public static MultipleAssignmentMetadata[] 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 MultipleAssignmentMetadata 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