org.sw4j.tool.barcode.random.config

Class GenerationConfig

java.lang.Object

org.sw4j.tool.barcode.random.config.GenerationConfig

public class GenerationConfig
extends Object

This class configures the generation and presentation.

To create a new instance programmatically use the Builder which can be obtained by the method builder().

This class is immutable.

Author:

Uwe Plonus <u.plonus@gmail.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenerationConfig.Builder This class is a Builder to build a RandomConfig programmatically.

Constructor Summary

Constructors

Constructor and Description
GenerationConfig(int size, EncodingConfig encoding, List<CodeConfig> codes, List<EncodingConfig> encodings) Create a new GenerationConfig with the given random size (in bits) or source encoding, barcode formats and additional representations.

Method Summary

Modifier and Type	Method and Description
static GenerationConfig.Builder	builder() Return a Builder that can be used to build a config.
List<CodeConfig>	getCodes() Return the configurations of the barcodes to create.
EncodingConfig	getEncoding() Return the encoding of the predefined values.
List<EncodingConfig>	getEncodings() Return the configurations of the additional encoding of the random number to create.
int	getSize() Return the size of the random number to be created.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerationConfig

public GenerationConfig(int size,
                        EncodingConfig encoding,
                        List<CodeConfig> codes,
                        List<EncodingConfig> encodings)

Create a new GenerationConfig with the given random size (in bits) or source encoding, barcode formats and additional representations. If the encoding is set the random size is ignored.

This constructor is annotated so that a YAML or JSON parsed with jackson fasterxml can create an instance directly.

Parameters:

size - the size of the random number generated (must be positive and a multiple of 8).

encoding - the encoding of the predefined codes.

codes - the configuration of the barcodes generated.

encodings - the configuration of the additional encodings generated.

Throws:

IllegalArgumentException - if size is either negative or not a multiple of 8, or code and encodings is both null.

Method Detail

getSize

public int getSize()

Return the size of the random number to be created.

Returns:

the size of the random number.

getEncoding

public EncodingConfig getEncoding()

Return the encoding of the predefined values.

Returns:

the encoding.

getCodes

public List<CodeConfig> getCodes()

Return the configurations of the barcodes to create.

Returns:

the configuration of the barcodes to create.

getEncodings

public List<EncodingConfig> getEncodings()

Return the configurations of the additional encoding of the random number to create.

Returns:

the configuration of the additional encodings.

builder

public static GenerationConfig.Builder builder()

Return a Builder that can be used to build a config.

Returns:

a Builder.