# Enum Class SyEventConsumed

java.lang.Object
java.lang.Enum<SyEventConsumed>
com.io7m.jsycamore.api.events.SyEventConsumed

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

public enum SyEventConsumed extends Enum<SyEventConsumed>
A value that indicates whether or not an event was consumed.

- ## Nested Class Summary

  ### Nested classes/interfaces inherited from class Enum

  `Enum.EnumDesc<E>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `EVENT_CONSUMED`
  An event was consumed.
  `EVENT_NOT_CONSUMED`
  An event was not consumed.

- ## Method Summary

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

  ### Methods inherited from class Enum

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

  ### Methods inherited from class Object

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

- ## Enum Constant Details

  - ### EVENT_CONSUMED

    public static final SyEventConsumed EVENT_CONSUMED
    An event was consumed.

  - ### EVENT_NOT_CONSUMED

    public static final SyEventConsumed EVENT_NOT_CONSUMED
    An event was not consumed.

- ## Method Details

  - ### values

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