com.helger.security.messagedigest

Class MessageDigestValue

java.lang.Object

com.helger.security.messagedigest.MessageDigestValue

All Implemented Interfaces:

com.helger.commons.io.IHasByteArray, com.helger.commons.io.IHasInputStream, com.helger.commons.io.IHasInputStreamAndReader, com.helger.commons.lang.IHasSize

@Immutable
public class MessageDigestValue
extends Object
implements com.helger.commons.io.IHasByteArray

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

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_COPY_NEEDED

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
byte[]	bytes()
static MessageDigestValue	create(byte[] aBytes, EMessageDigestAlgorithm eAlgorithm) Create a new MessageDigestValue object based on the passed source byte array
static MessageDigestValue	create(InputStream aIS, EMessageDigestAlgorithm eAlgorithm) Create a new MessageDigestValue object based on the passed source InputStream.
boolean	equals(Object o)
EMessageDigestAlgorithm	getAlgorithm()
String	getHexEncodedDigestString()
int	getOffset()
int	hashCode()
boolean	isCopy()
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.io.IHasByteArray

getAllBytes, getBytesAsString, getHexEncoded, getInputStream, hasOffset, isEmpty, isNotEmpty, isReadMultiple, startsWith, writeTo

Methods inherited from interface com.helger.commons.io.IHasInputStreamAndReader

getBufferedReader, getReader

Methods inherited from interface com.helger.commons.io.IHasInputStream

getBufferedInputStream

Field Detail

DEFAULT_COPY_NEEDED

public static final boolean DEFAULT_COPY_NEEDED

See Also:

Constant Field Values

Constructor Detail

MessageDigestValue

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

MessageDigestValue

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

Method Detail

getAlgorithm

@Nonnull
public EMessageDigestAlgorithm getAlgorithm()

Returns:

The message digest algorithm used. Never null.

isCopy

public boolean isCopy()

Specified by:

isCopy in interface com.helger.commons.io.IHasByteArray

bytes

@Nonnull
 @Nonempty
 @ReturnsMutableObject
public byte[] bytes()

Specified by:

bytes in interface com.helger.commons.io.IHasByteArray

Returns:

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

Since:

9.1.3

size

@Nonnegative
public int size()

Specified by:

size in interface com.helger.commons.lang.IHasSize

getOffset

@Nonnegative
public int getOffset()

Specified by:

getOffset in interface com.helger.commons.io.IHasByteArray

getHexEncodedDigestString

@Nonnull
 @Nonempty
public String getHexEncodedDigestString()

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.

create

@Nonnull
public static MessageDigestValue create(@Nonnull @WillClose
                                                  InputStream aIS,
                                                  @Nonnull
                                                  EMessageDigestAlgorithm eAlgorithm)
                                           throws IOException

Create a new MessageDigestValue object based on the passed source InputStream.

Parameters:

aIS - The input stream to read from. May not be null.

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

Returns:

Never null.

Throws:

IOException - In case reading throws an IOException