Package com.io7m.cardant.database.api

# Enum Class CADatabaseRole

java.lang.Object
java.lang.Enum<CADatabaseRole>
com.io7m.cardant.database.api.CADatabaseRole

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

public enum CADatabaseRole extends Enum<CADatabaseRole>
The roles used by the server database.

- ## 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
  `CARDANT`
  The main cardant role.
  `CARDANT_READ_ONLY`
  The read-only cardant role.
  `NONE`
  The null role; has no privileges and cannot do anything.

- ## Method Summary

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

  - ### CARDANT

    public static final CADatabaseRole CARDANT
    The main cardant role.

  - ### CARDANT_READ_ONLY

    public static final CADatabaseRole CARDANT_READ_ONLY
    The read-only cardant role.

  - ### NONE

    public static final CADatabaseRole NONE
    The null role; has no privileges and cannot do anything.

- ## Method Details

  - ### values

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