com.phloc.commons.messagedigest

Class AbstractMessageDigestGenerator

java.lang.Object

com.phloc.commons.messagedigest.AbstractMessageDigestGenerator

All Implemented Interfaces:

IMessageDigestGenerator

Direct Known Subclasses:

MessageDigestGenerator, NonBlockingMessageDigestGenerator

public abstract class AbstractMessageDigestGenerator
extends Object
implements IMessageDigestGenerator

Base class for creating a cryptographic hash value. Don't mix it up with the HashCodeGenerator which is used to generate hash values for Java objects.

Author:

Philip Helger

Field Summary

Fields inherited from interface com.phloc.commons.messagedigest.IMessageDigestGenerator

DEFAULT_ALGORITHM

Constructor Summary

Constructors

Constructor and Description
AbstractMessageDigestGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDigestHexString() This method converts the current hash digest to a hex string.
long	getDigestLong() This method finalizes the hash generation and creates the index.
IMessageDigestGenerator	update(byte[] aValue) Update the hash with the given byte array.
IMessageDigestGenerator	update(String aValue, Charset aCharset) Update the hash with the bytes of the given string in the given charset.
IMessageDigestGenerator	update(String aValue, String sCharset) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.phloc.commons.messagedigest.IMessageDigestGenerator

getAlgorithmName, getDigest, getDigest, getDigestLength, reset, update, update

Constructor Detail

AbstractMessageDigestGenerator

public AbstractMessageDigestGenerator()

Method Detail

update

@Nonnull
@Deprecated
public final IMessageDigestGenerator update(@Nonnull
                                                String aValue,
                                                @Nonnull@Nonempty
                                                String sCharset)

Deprecated.

Description copied from interface: IMessageDigestGenerator

Update the hash with the bytes of the given string in the given charset. After calling IMessageDigestGenerator.getDigest() once, no further update is possible.

Specified by:

update in interface IMessageDigestGenerator

Parameters:

aValue - The string value to update the hash. May not be null.

sCharset - The charset to be used for extraction of the bytes. May not be null.

Returns:

this

update

@Nonnull
public final IMessageDigestGenerator update(@Nonnull
                                     String aValue,
                                     @Nonnull
                                     Charset aCharset)

Description copied from interface: IMessageDigestGenerator

Update the hash with the bytes of the given string in the given charset. After calling IMessageDigestGenerator.getDigest() once, no further update is possible.

Specified by:

update in interface IMessageDigestGenerator

Parameters:

aValue - The string value to update the hash. May not be null.

aCharset - The charset to be used for extraction of the bytes. May not be null.

Returns:

this

update

@Nonnull
public final IMessageDigestGenerator update(@Nonnull
                                     byte[] aValue)

Description copied from interface: IMessageDigestGenerator

Update the hash with the given byte array. After calling IMessageDigestGenerator.getDigest() once, no further update is possible.

Specified by:

update in interface IMessageDigestGenerator

Parameters:

aValue - The byte array to update the hash. May not be null.

Returns:

this

getDigestLong

public final long getDigestLong()

Description copied from interface: IMessageDigestGenerator

This method finalizes the hash generation and creates the index. Calls IMessageDigestGenerator.getDigest() internally so no further update is possible after this method is called.

Specified by:

getDigestLong in interface IMessageDigestGenerator

Returns:

the generated hash value.

getDigestHexString

@Nonnull
public final String getDigestHexString()

Description copied from interface: IMessageDigestGenerator

This method converts the current hash digest to a hex string. Calls IMessageDigestGenerator.getDigest() internally so no further update is possible after this method is called.

Specified by:

getDigestHexString in interface IMessageDigestGenerator

Returns:

The hex value of the hash digest. Never null.