Package com.helger.security.messagedigest

Enum EMessageDigestAlgorithm

java.lang.Object

java.lang.Enum<EMessageDigestAlgorithm>

com.helger.security.messagedigest.EMessageDigestAlgorithm

All Implemented Interfaces:

Serializable, Comparable<EMessageDigestAlgorithm>

public enum EMessageDigestAlgorithm
extends Enum<EMessageDigestAlgorithm>

A selection of common message digest (hash) algorithms.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant	Description
MD5
SHA_1
SHA_224
SHA_256
SHA_384
SHA_512

Method Summary

Modifier and Type	Method	Description
MessageDigest	createMessageDigest()
MessageDigest	createMessageDigest(Provider aSecurityProvider)
String	getAlgorithm()
static EMessageDigestAlgorithm	getFromStringIgnoreCase(String sAlgorithm)
static EMessageDigestAlgorithm	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EMessageDigestAlgorithm[]	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

Enum Constant Detail

MD5

public static final EMessageDigestAlgorithm MD5

SHA_1

public static final EMessageDigestAlgorithm SHA_1

SHA_224

public static final EMessageDigestAlgorithm SHA_224

SHA_256

public static final EMessageDigestAlgorithm SHA_256

SHA_384

public static final EMessageDigestAlgorithm SHA_384

SHA_512

public static final EMessageDigestAlgorithm SHA_512

Method Detail

values

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

Returns:

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

valueOf

public static EMessageDigestAlgorithm 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

getAlgorithm

@Nonnull
@Nonempty
public String getAlgorithm()

Returns:

The internal name of the message digest algorithm. Neither null nor empty.

createMessageDigest

@Nonnull
public MessageDigest createMessageDigest()

Returns:

A new message digest with this message digest algorithm using the default security provider.

Throws:

IllegalStateException - If this algorithm is not supported by this Java runtime.

createMessageDigest

@Nonnull
public MessageDigest createMessageDigest(@Nullable
                                         Provider aSecurityProvider)

Parameters:

aSecurityProvider - The security provider to use. May be null to use the default security provider.

Returns:

A new message digest with this message digest algorithm using the provided or the default security provider.

Throws:

IllegalStateException - If this algorithm is not supported by this Java runtime.

getFromStringIgnoreCase

@Nullable
public static EMessageDigestAlgorithm getFromStringIgnoreCase(@Nullable
                                                              String sAlgorithm)