Package io.axoniq.dataprotection.api

## Enum Scope

- java.lang.Object
- - java.lang.Enum<Scope>
  - - io.axoniq.dataprotection.api.Scope

- All Implemented Interfaces:
    `Serializable`, `Comparable<Scope>`

      public enum Scope
      extends Enum<Scope>

  Enum that determines the scope of one of the other Axon Data Protection Module annotations. On regular fields, the value will always be `DEFAULT`. The reason that this enum exists, is that scope may be different on `Map` fields - in this case, an annotation may apply to the key, value or both sides of the `Map`.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant | Description
    --- | ---
    `BOTH` | Indicates that an annotation applies to both the keys and the values in the `Map`.
    `DEFAULT` | Used for all non-`Map` fields.
    `KEY` | Indicates that an annotation applies to the keys in the `Map`.
    `VALUE` | Indicates that an annotation applies to the values in the `Map`.

  - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Scope` | `valueOf​(String name)` | Returns the enum constant of this type with the specified name.
    `static Scope[]` | `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, toString, valueOf`

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

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

- - ### Enum Constant Detail

    - #### DEFAULT

          public static final Scope DEFAULT

      Used for all non-`Map` fields.

    - #### KEY

          public static final Scope KEY

      Indicates that an annotation applies to the keys in the `Map`.

    - #### VALUE

          public static final Scope VALUE

      Indicates that an annotation applies to the values in the `Map`.

    - #### BOTH

          public static final Scope BOTH

      Indicates that an annotation applies to both the keys and the values in the `Map`.

  - ### Method Detail

    - #### values

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

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

    - #### valueOf

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