org.dihedron.crypto.constants

Enum DigestAlgorithm

java.lang.Object

java.lang.Enum<DigestAlgorithm>

org.dihedron.crypto.constants.DigestAlgorithm

All Implemented Interfaces:

Serializable, Comparable<DigestAlgorithm>

public enum DigestAlgorithm
extends Enum<DigestAlgorithm>

An enumeration of supported digest algorithms.

Author:

Andrea Funto'

Enum Constant Summary

Enum Constants

Enum Constant and Description
MD5 MD5 digest algorithm.
SHA1 SHA-1 digest algorithm.
SHA224 SHA-224 digest algorithm.
SHA256 SHA-256 digest algorithm.
SHA384 SHA-384 digest algorithm.
SHA512 SHA-512 digest algorithm.

Method Summary

Methods

Modifier and Type	Method and Description
static DigestAlgorithm	fromAsn1Id(String asn1) Factory method: returns the Digest object corresponding to the given algorithm id (in ASN.1 format).
static DigestAlgorithm	fromBouncyCastleCode(String algorithmCode) Factory method: returns the Digest object corresponding to the given BouncyCastle algorithm id (e.g.
static DigestAlgorithm	fromDescription(String description) Factory method: returns the Digest object corresponding to the given text description.
String	getAsn1Id() Returns the numeric (in text form) id of the digest algorithm.
String	getBouncyCastleCode() Returns the BouncyCastle code for the given algorithm.
String	getDescription() Returns the text description of the digest algorithm.
String	toString() Formats the object as a string.
static DigestAlgorithm	valueOf(String name) Returns the enum constant of this type with the specified name.
static DigestAlgorithm[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SHA1

public static final DigestAlgorithm SHA1

SHA-1 digest algorithm.

SHA224

public static final DigestAlgorithm SHA224

SHA-224 digest algorithm.

SHA256

public static final DigestAlgorithm SHA256

SHA-256 digest algorithm.

SHA384

public static final DigestAlgorithm SHA384

SHA-384 digest algorithm.

SHA512

public static final DigestAlgorithm SHA512

SHA-512 digest algorithm.

MD5

public static final DigestAlgorithm MD5

MD5 digest algorithm.

Method Detail

values

public static DigestAlgorithm[] 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 (DigestAlgorithm c : DigestAlgorithm.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DigestAlgorithm valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromDescription

public static DigestAlgorithm fromDescription(String description)

Factory method: returns the Digest object corresponding to the given text description.

Parameters:

description - the algorithm description, e.g. "sha-1".

Returns:

the Digest object, or null if none found corresponding to the given algorithm description.

fromAsn1Id

public static DigestAlgorithm fromAsn1Id(String asn1)

Factory method: returns the Digest object corresponding to the given algorithm id (in ASN.1 format).

Parameters:

asn1 - the algorithm ASN.1 code, e.g. "1.3.26.1.13".

Returns:

the Digest object, or null if none found corresponding to the given algorithm id.

fromBouncyCastleCode

public static DigestAlgorithm fromBouncyCastleCode(String algorithmCode)

Factory method: returns the Digest object corresponding to the given BouncyCastle algorithm id (e.g. "SHA256").

Parameters:

algorithmCode - the BouncyCastle algorithm code, e.g. "MD5".

Returns:

the Digest object, or null if none found corresponding to the given algorithm code.

getDescription

public String getDescription()

Returns the text description of the digest algorithm.

Returns:

the text description of the digest algorithm.

getBouncyCastleCode

public String getBouncyCastleCode()

Returns the BouncyCastle code for the given algorithm.

Returns:

the BouncyCastle code for the given algorithm, e.g. "SHA256".

getAsn1Id

public String getAsn1Id()

Returns the numeric (in text form) id of the digest algorithm.

Returns:

the id of the digest algorithm.

toString

public String toString()

Formats the object as a string.

Overrides:

toString in class Enum<DigestAlgorithm>