Package org.pgpainless.algorithm
Enum AEADAlgorithm
- java.lang.Object
-
- java.lang.Enum<AEADAlgorithm>
-
- org.pgpainless.algorithm.AEADAlgorithm
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<AEADAlgorithm>
public enum AEADAlgorithm extends java.lang.Enum<AEADAlgorithm>
List of AEAD algorithms defined in crypto-refresh-06.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AEADAlgorithm
fromId(int id)
Return theAEADAlgorithm
value that corresponds to the provided algorithm id.int
getAlgorithmId()
Return the ID of the AEAD algorithm.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 theAEADAlgorithm
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.
-
-
-
Enum Constant Detail
-
EAX
public static final AEADAlgorithm EAX
-
OCB
public static final AEADAlgorithm OCB
-
GCM
public static final AEADAlgorithm GCM
-
-
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 namejava.lang.NullPointerException
- if the argument is null
-
getAlgorithmId
public int getAlgorithmId()
Return the ID of the AEAD algorithm.- Returns:
- algorithm ID
-
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 theAEADAlgorithm
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 theAEADAlgorithm
value that corresponds to the provided algorithm id. If an invalid algorithm id was provided, throw aNoSuchElementException
.- Parameters:
id
- algorithm id- Returns:
- enum value
- Throws:
java.util.NoSuchElementException
- in case of an unknown algorithm id
-
-