Enum Class SymmetricKeyAlgorithm

java.lang.Object
java.lang.Enum<SymmetricKeyAlgorithm>
org.pgpainless.algorithm.SymmetricKeyAlgorithm
All Implemented Interfaces:
Serializable, Comparable<SymmetricKeyAlgorithm>, Constable

public enum SymmetricKeyAlgorithm extends Enum<SymmetricKeyAlgorithm>
Enumeration of possible symmetric encryption algorithms.
See Also:
  • Enum Constant Details

  • Method Details

    • values

      public static SymmetricKeyAlgorithm[] 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 SymmetricKeyAlgorithm 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
    • fromId

      @Nullable public static SymmetricKeyAlgorithm fromId(int id)
      Return the SymmetricKeyAlgorithm enum that corresponds to the provided numeric id. If an invalid id is provided, null is returned.
      Parameters:
      id - numeric algorithm id
      Returns:
      symmetric key algorithm enum
    • requireFromId

      @Nonnull public static SymmetricKeyAlgorithm requireFromId(int id)
      Return the SymmetricKeyAlgorithm enum that corresponds to the provided numeric id. If an invalid id is provided, throw a NoSuchElementException.
      Parameters:
      id - numeric algorithm id
      Returns:
      symmetric key algorithm enum
      Throws:
      NoSuchElementException - if an unmatched id is provided
    • getAlgorithmId

      public int getAlgorithmId()
      Return the numeric algorithm id of the enum.
      Returns:
      numeric id