com.foreach.common.spring.code

Class CodeGenerator

java.lang.Object

com.foreach.common.spring.code.CodeGenerator

public class CodeGenerator
extends Object

Generator that creates unique codes using an underlying MappedStringEncoder. Codes are first generated as random numbers that are uniformly distributed across the possible number range. The numbers are subsequently encoded to strings using the encoder. Use forCodeLength(int) to create a code generator with a default MappedStringEncoder.

The length of the code as well as the number of codes generated will determine the statistical probability of guessing a code.

Note that there is no uniqueness of codes between calls to the generator.

Author:

Arne Vandamme

See Also:

forCodeLength(int)

Constructor Summary

Constructors

Constructor and Description
CodeGenerator(MappedStringEncoder encoder)

Method Summary

Modifier and Type	Method and Description
static CodeGenerator	forCodeLength(int length) Create a CodeGenerator that generates random codes with a specified length.
List<String>	generate(int numberOfCodes) Generates a number of random codes that are all the same - full - length.
List<String>	generate(int numberOfCodes, boolean padToLength) Generates a number of random codes.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeGenerator

public CodeGenerator(MappedStringEncoder encoder)

Method Detail

generate

public List<String> generate(int numberOfCodes)

Generates a number of random codes that are all the same - full - length.

Parameters:

numberOfCodes - Number of codes to generate.

Returns:

List of codes.

Throws:

IllegalArgumentException - if the number of codes is too large for the configured encoder.

generate

public List<String> generate(int numberOfCodes,
                             boolean padToLength)

Generates a number of random codes.

Parameters:

numberOfCodes - Number of codes to generate.

padToLength - True if codes should all be the same - full -length.

Returns:

List of codes.

Throws:

IllegalArgumentException - if the number of codes is too large for the configured encoder.

forCodeLength

public static CodeGenerator forCodeLength(int length)

Create a CodeGenerator that generates random codes with a specified length.

Parameters:

length - Length of a code.

Returns:

CodeGenerator.