Enum Class PublicKeyAlgorithm

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

public enum PublicKeyAlgorithm extends Enum<PublicKeyAlgorithm>
Enumeration of public key algorithms as defined in RFC4880.
See Also:
  • Enum Constant Details

  • Method Details

    • values

      public static PublicKeyAlgorithm[] 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 PublicKeyAlgorithm 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 PublicKeyAlgorithm fromId(int id)
      Return the PublicKeyAlgorithm that corresponds to the provided algorithm id. If an invalid id is provided, null is returned.
      Parameters:
      id - numeric algorithm id
      Returns:
      algorithm or null
    • requireFromId

      @Nonnull public static PublicKeyAlgorithm requireFromId(int id)
      Return the PublicKeyAlgorithm that corresponds to the provided algorithm id. If an invalid id is provided, throw a NoSuchElementException.
      Parameters:
      id - numeric algorithm id
      Returns:
      algorithm
      Throws:
      NoSuchElementException - in case of an unmatched algorithm id
    • getAlgorithmId

      public int getAlgorithmId()
      Return the numeric identifier of the public key algorithm.
      Returns:
      id
    • isSigningCapable

      public boolean isSigningCapable()
      Return true if this public key algorithm is able to create signatures.
      Returns:
      true if the algorithm can sign
    • isEncryptionCapable

      public boolean isEncryptionCapable()
      Return true if this public key algorithm can be used as an encryption algorithm.
      Returns:
      true if the algorithm can encrypt