org.sw4j.tool.barcode.random.generator

Class RandomIdent

java.lang.Object

org.sw4j.tool.barcode.random.generator.RandomIdent

All Implemented Interfaces:

IdentValue

public class RandomIdent
extends Object
implements IdentValue

This class contains the random number and the encoded representations for a single ident.

This class is immutable.

Author:

Uwe Plonus <u.plonus@gmail.com>

Constructor Summary

Constructors

Constructor and Description
RandomIdent(String ident, int randomSize, Random rng, Set<EncodingConfig> encodings) Create a new RandomIdent and the random number for the ident.

Method Summary

Modifier and Type	Method and Description
String	getEncoded(EncodingConfig encoding) Return the random number in the given encoding.
String	getIdent() Return the ident number.
byte[]	getValue() Return the raw random number generated.

Methods inherited from class java.lang.Object

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

Constructor Detail

RandomIdent

public RandomIdent(String ident,
                   int randomSize,
                   Random rng,
                   Set<EncodingConfig> encodings)

Create a new RandomIdent and the random number for the ident. The random number has a size of randomSize bits (rounded down to the next whole byte). For the generation of the random number the given rng will be used. The generated random number will be encoded in all given encodings.

For high quality random numbers use an appropriate random number generator (e.g. SecureRandom).

Parameters:

ident - the ident for which the random number will be generated for.

randomSize - the size in bits (rounded down to the next byte).

rng - the random number generator to use.

encodings - the encodings that are used for the encoded representation of the random number.

Throws:

IllegalArgumentException - if no encoder for a given encoding can be found.

Method Detail

getIdent

public String getIdent()

Return the ident number.

Specified by:

getIdent in interface IdentValue

Returns:

the ident number.

getValue

public byte[] getValue()

Return the raw random number generated.

Specified by:

getValue in interface IdentValue

Returns:

the raw random number.

getEncoded

public String getEncoded(EncodingConfig encoding)

Return the random number in the given encoding. Only the encodings that were given during construction can be returned.

Specified by:

getEncoded in interface IdentValue

Parameters:

encoding - the encoding for which the encoded value should be returned.

Returns:

the encoded value or null if the encoding is unknown.