cz.d1x.dxcrypto.hash

Class HashingAlgorithmBuilder

java.lang.Object

cz.d1x.dxcrypto.hash.HashingAlgorithmBuilder

Direct Known Subclasses:

DigestAlgorithmBuilder

public abstract class HashingAlgorithmBuilder
extends Object

Base builder for all hashing algorithms. You should use HashingAlgorithms factory for creating instances.

Author:

Zdenek Obst, zdenek.obst-at-gmail.com

See Also:

DigestAlgorithm

Field Summary

Fields

Modifier and Type	Field and Description
protected BytesRepresentation	bytesRepresentation
protected String	encoding

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HashingAlgorithmBuilder()

Method Summary

Modifier and Type	Method and Description
abstract HashingAlgorithm	build() Builds final hashing algorithm instance.
HashingAlgorithmBuilder	bytesRepresentation(BytesRepresentation bytesRepresentation) Sets how byte arrays will be represented in strings.
HashingAlgorithmBuilder	encoding(String encoding) Sets encoding for strings of input and output.
RepeatingDecoratorBuilder	repeated(int repeats) Builds a hashing algorithm and wraps it into repeating decorator builder.
SaltingAdapterBuilder	salted() Builds a hashing algorithm and wraps it by salting adapter builder.
SaltingAdapterBuilder	salted(Combining combining) Builds a hashing algorithm and wraps it by salting adapter builder with custom combine algorithm.

Methods inherited from class java.lang.Object

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

Field Detail

bytesRepresentation

protected BytesRepresentation bytesRepresentation

encoding

protected String encoding

Constructor Detail

HashingAlgorithmBuilder

protected HashingAlgorithmBuilder()

Method Detail

bytesRepresentation

public HashingAlgorithmBuilder bytesRepresentation(BytesRepresentation bytesRepresentation)
                                            throws IllegalArgumentException

Sets how byte arrays will be represented in strings. By default HexRepresentation is used.

Parameters:

bytesRepresentation - byte array representation strategy

Returns:

this instance

Throws:

IllegalArgumentException - exception if passed key BytesRepresentation is null

encoding

public HashingAlgorithmBuilder encoding(String encoding)
                                 throws IllegalArgumentException

Sets encoding for strings of input and output.

Parameters:

encoding - encoding to be set

Returns:

this instance

Throws:

IllegalArgumentException - exception if given encoding is null or not supported

salted

public SaltingAdapterBuilder salted()

Builds a hashing algorithm and wraps it by salting adapter builder. Salting adapter automatically gets the same encoding as hashing algorithm.

Note that you should call this method when you are finished with properties of hashing algorithm.

Returns:

salting adapter builder

salted

public SaltingAdapterBuilder salted(Combining combining)
                             throws IllegalArgumentException

Builds a hashing algorithm and wraps it by salting adapter builder with custom combine algorithm. Salting adapter automatically gets the same encoding as hashing algorithm.

Note that you should call this method when you are finished with properties of hashing algorithm.

Parameters:

combining - combine algorithm for input text and salt

Returns:

salting adapter builder

Throws:

IllegalArgumentException - exception if passed key Combining is null

repeated

public RepeatingDecoratorBuilder repeated(int repeats)
                                   throws IllegalArgumentException

Builds a hashing algorithm and wraps it into repeating decorator builder.

Note that you should call this method when you are finished with properties of hashing algorithm.

Parameters:

repeats - count of repeats

Returns:

repeating decorator builder

Throws:

IllegalArgumentException - exception if passed repeats are lower than 1

build

public abstract HashingAlgorithm build()

Builds final hashing algorithm instance.

Returns:

hashing algorithm instance