Package org.pgpainless.algorithm

Enum AEADAlgorithm

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EAX  
      GCM  
      OCB  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static AEADAlgorithm fromId​(int id)
      Return the AEADAlgorithm value that corresponds to the provided algorithm id.
      int getAlgorithmId()  
      int getIvLength()
      Return the length (in octets) of the IV.
      int getTagLength()
      Return the length (in octets) of the authentication tag.
      static AEADAlgorithm requireFromId​(int id)
      Return the AEADAlgorithm value that corresponds to the provided algorithm id.
      static AEADAlgorithm valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AEADAlgorithm[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static AEADAlgorithm[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (AEADAlgorithm c : AEADAlgorithm.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AEADAlgorithm valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getAlgorithmId

        public int getAlgorithmId()

      • getIvLength

        public int getIvLength()
        Return the length (in octets) of the IV.
        Returns:
        iv length

      • getTagLength

        public int getTagLength()
        Return the length (in octets) of the authentication tag.
        Returns:
        tag length

      • fromId

        @Nullable
public static AEADAlgorithm fromId​(int id)
        Return the AEADAlgorithm value that corresponds to the provided algorithm id. If an invalid algorithm id was provided, null is returned.
        Parameters:
        id - numeric id
        Returns:
        enum value

      • requireFromId

        @Nonnull
public static AEADAlgorithm requireFromId​(int id)
        Return the AEADAlgorithm value that corresponds to the provided algorithm id. If an invalid algorithm id was provided, throw a NoSuchElementException.
        Parameters:
        id - algorithm id
        Returns:
        enum value
        Throws:
        java.util.NoSuchElementException - in case of an unknown algorithm id