com.helger.commons.messagedigest

Class MessageDigestValue

java.lang.Object

com.helger.commons.messagedigest.MessageDigestValue

@Immutable
public final class MessageDigestValue
extends Object

Represents a single message digest value as the combination of the algorithm and the digest bytes.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
MessageDigestValue(EMessageDigestAlgorithm eAlgorithm, byte[] aDigestBytes)

Method Summary

Modifier and Type	Method and Description
static MessageDigestValue	create(byte[] aBytes, EMessageDigestAlgorithm eAlgorithm) Create a new MessageDigestValue object based on the passed source byte array
boolean	equals(Object o)
EMessageDigestAlgorithm	getAlgorithm()
byte[]	getDigestBytes()
String	getDigestString()
int	hashCode()
String	toString()
void	writeDigestBytes(OutputStream aOS) Write the digest bytes to the specified output stream.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageDigestValue

public MessageDigestValue(@Nonnull
                          EMessageDigestAlgorithm eAlgorithm,
                          @Nonnull @Nonempty
                          byte[] aDigestBytes)

Method Detail

getAlgorithm

@Nonnull
public EMessageDigestAlgorithm getAlgorithm()

Returns:

The message digest algorithm used. Never null.

getDigestBytes

@Nonnull
 @Nonempty
 @ReturnsMutableCopy
public byte[] getDigestBytes()

Returns:

A copy of the message digest bytes. The length depends on the used algorithm. Never null.

writeDigestBytes

public void writeDigestBytes(@Nonnull @WillNotClose
                             OutputStream aOS)
                      throws IOException

Write the digest bytes to the specified output stream.

Parameters:

aOS - The output stream to write to. May not be null.

Throws:

IOException - In case of a write error

getDigestString

@Nonnull
 @Nonempty
public String getDigestString()

Returns:

The hex-encoded String of the message digest bytes. Never null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

create

@Nonnull
public static MessageDigestValue create(@Nonnull
                                                  byte[] aBytes,
                                                  @Nonnull
                                                  EMessageDigestAlgorithm eAlgorithm)

Create a new MessageDigestValue object based on the passed source byte array

Parameters:

aBytes - The byte array to create the hash value from. May not be null.

eAlgorithm - The algorithm to be used. May not be null.

Returns:

Never null.