org.bremersee.utils

Class CodingUtils

java.lang.Object

org.bremersee.utils.CodingUtils

public abstract class CodingUtils
extends Object

Some coding utilities for generating hashes, encoding and decoding.

Author:

Christian Bremer

Method Summary

Modifier and Type	Method and Description
static byte[]	digestSilently(MessageDigest md, byte[] bytes) Calculates a hash value.
static byte[]	digestSilently(MessageDigest md, byte[] bytes, InputStreamListener listener) Calculates a hash value.
static byte[]	digestSilently(MessageDigest md, InputStream inputStream, boolean closeInputStream) Calculates a hash value.
static byte[]	digestSilently(MessageDigest md, InputStream inputStream, boolean closeInputStream, InputStreamListener listener) Calculates a hash value.
static MessageDigest	getMessageDigestSilently(String algorithm) Returns a MessageDigest object that implements the specified digest algorithm.
static MessageDigest	getMessageDigestSilently(String algorithm, Provider provider) Returns a MessageDigest object that implements the specified digest algorithm.
static MessageDigest	getMessageDigestSilently(String algorithm, String provider) Returns a MessageDigest object that implements the specified digest algorithm.
static byte[]	toBytesSilently(String text, Charset charset) Encodes the specified string into a sequence of bytes using the named charset, storing the result into a new byte array.
static byte[]	toBytesSilently(String text, String charsetName) Encodes the specified string into a sequence of bytes using the named charset, storing the result into a new byte array.
static String	toHex(byte[] bytes) Returns a string with the hex values of the specified byte array.
static String	toHex(byte[] bytes, boolean upperCase) Returns a string with the hex values of the specified byte array.
static String	toStringSilently(byte[] bytes, Charset charset) Constructs a new String by decoding the specified array of bytes using the specified charset.
static String	toStringSilently(byte[] bytes, String charsetName) Constructs a new String by decoding the specified array of bytes using the specified charset.

Methods inherited from class java.lang.Object

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

Method Detail

getMessageDigestSilently

public static MessageDigest getMessageDigestSilently(String algorithm)

Returns a MessageDigest object that implements the specified digest algorithm.

Parameters:

algorithm - the name of the algorithm requested

Returns:

a MessageDigest object that implements the specified algorithm

Throws:

CodingException - if a MessageDigestSpi implementation for the specified algorithm is not available

getMessageDigestSilently

public static MessageDigest getMessageDigestSilently(String algorithm,
                                                     String provider)

Returns a MessageDigest object that implements the specified digest algorithm.

Parameters:

algorithm - the name of the algorithm requested

provider - the provider (may be null)

Returns:

a MessageDigest object that implements the specified algorithm

Throws:

CodingException - if a MessageDigestSpi implementation for the specified algorithm is not available from the specified Provider object

getMessageDigestSilently

public static MessageDigest getMessageDigestSilently(String algorithm,
                                                     Provider provider)

Returns a MessageDigest object that implements the specified digest algorithm.

Parameters:

algorithm - the name of the algorithm requested

provider - the provider (may be null)

Returns:

a MessageDigest object that implements the specified algorithm

Throws:

CodingException - if a MessageDigestSpi implementation for the specified algorithm is not available from the specified Provider object

digestSilently

public static byte[] digestSilently(MessageDigest md,
                                    byte[] bytes)

Calculates a hash value.

Parameters:

md - the MessageDigest

bytes - a byte array

Returns:

the array of bytes for the hash value

Throws:

IllegalArgumentException - if message digest or bytes are null

CodingException - if calculation of the hash fails

digestSilently

public static byte[] digestSilently(MessageDigest md,
                                    byte[] bytes,
                                    InputStreamListener listener)

Calculates a hash value.

Parameters:

md - the MessageDigest

bytes - a byte array

listener - an input stream listener (may be null)

Returns:

the array of bytes for the hash value

Throws:

IllegalArgumentException - if message digest or bytes is null

CodingException - if calculation of the hash fails

digestSilently

public static byte[] digestSilently(MessageDigest md,
                                    InputStream inputStream,
                                    boolean closeInputStream)

Calculates a hash value.

Parameters:

md - the MessageDigest

inputStream - an input stream

closeInputStream - if true the input stream will be closed, otherwise it will stay open

Returns:

the array of bytes for the hash value

Throws:

IllegalArgumentException - if message digest or input stream is null

CodingException - if calculation of the hash fails

digestSilently

public static byte[] digestSilently(MessageDigest md,
                                    InputStream inputStream,
                                    boolean closeInputStream,
                                    InputStreamListener listener)

Calculates a hash value.

Parameters:

md - the MessageDigest

inputStream - an input stream

closeInputStream - if true the input stream will be closed, otherwise it will stay open

listener - an input stream listener (may be null)

Returns:

the array of bytes for the hash value

Throws:

IllegalArgumentException - if message digest or input stream is null

CodingException - if calculation of the hash fails

toHex

public static String toHex(byte[] bytes)

Returns a string with the hex values of the specified byte array.

Parameters:

bytes - a byte array (may be null

Returns:

a string (lower case) with the hex values of the specified byte array or null if the the byte array is null

toHex

public static String toHex(byte[] bytes,
                           boolean upperCase)

Returns a string with the hex values of the specified byte array.

Parameters:

bytes - a byte array (may be null

upperCase - should the result by upper case?

Returns:

a string with the hex values of the specified byte array or null if the the byte array is null

toBytesSilently

public static byte[] toBytesSilently(String text,
                                     String charsetName)

Encodes the specified string into a sequence of bytes using the named charset, storing the result into a new byte array.

Parameters:

text - the string

charsetName - the charset name

Returns:

the resultant byte array or null if the string is null

Throws:

CodingException - if the named charset is not supported

toBytesSilently

public static byte[] toBytesSilently(String text,
                                     Charset charset)

Encodes the specified string into a sequence of bytes using the named charset, storing the result into a new byte array.

Parameters:

text - the string

charset - the charset

Returns:

the resultant byte array or null if the string is null

toStringSilently

public static String toStringSilently(byte[] bytes,
                                      String charsetName)

Constructs a new String by decoding the specified array of bytes using the specified charset.

Parameters:

bytes - the bytes

charsetName - the name of the charset

Returns:

the string or null if the bytes are null

Throws:

CodingException - if the named charset is not supported

toStringSilently

public static String toStringSilently(byte[] bytes,
                                      Charset charset)

Constructs a new String by decoding the specified array of bytes using the specified charset.

Parameters:

bytes - the bytes

charset - the charset

Returns:

the string or null if the bytes are null