Package com.norconex.commons.lang.encrypt

# Enum Class EncryptionKey.Source

java.lang.Object
java.lang.Enum<EncryptionKey.Source>
com.norconex.commons.lang.encrypt.EncryptionKey.Source

All Implemented Interfaces:
  `Serializable`, `Comparable<EncryptionKey.Source>`, `Constable`

Enclosing class:
  EncryptionKey

public static enum EncryptionKey.Source extends Enum<EncryptionKey.Source>

- ## 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
  `ENVIRONMENT`
  Value is the name of an environment variable containing the key.
  `FILE`
  Value is the path to a file containing the key.
  `KEY`
  Value is the actual key.
  `PROPERTY`
  Value is the name of a JVM system property containing the key.

- ## Method Summary

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

  - ### KEY

    public static final EncryptionKey.Source KEY
    Value is the actual key.

  - ### FILE

    public static final EncryptionKey.Source FILE
    Value is the path to a file containing the key.

  - ### ENVIRONMENT

    public static final EncryptionKey.Source ENVIRONMENT
    Value is the name of an environment variable containing the key.

  - ### PROPERTY

    public static final EncryptionKey.Source PROPERTY
    Value is the name of a JVM system property containing the key.

- ## Method Details

  - ### values

    public static EncryptionKey.Source[] 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 EncryptionKey.Source 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