org.sw4j.tool.barcode.random.config

Class Config

java.lang.Object

org.sw4j.tool.barcode.random.config.Config

public class Config
extends Object

The top level class for configuring the whole application. This class includes the configuration for the input file, the output file(s) and the random number 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	Config.Builder This class is a Builder to build a Config programmatically.

Constructor Summary

Constructors

Constructor and Description
Config(FileConfig input, OutputConfig output, GenerationConfig random, GenerationConfig predefined) Create a new Config with the given part configurations.

Method Summary

Modifier and Type	Method and Description
static Config.Builder	builder() Return a Builder that can be used to build a config.
FileConfig	getInput() Return the input file configuration.
OutputConfig	getOutput() Return the output file(s) configuration.
GenerationConfig	getPredefined() Return the predefined presentation configuration.
GenerationConfig	getRandom() Return the random generation and presentation configuration.
static Config	readYamlConfig(File configFile) A factory method to create a configuration from a YAML file.

Methods inherited from class java.lang.Object

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

Constructor Detail

Config

public Config(FileConfig input,
              OutputConfig output,
              GenerationConfig random,
              GenerationConfig predefined)

Create a new Config with the given part configurations.

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

Parameters:

input - the input file configuration.

output - the output file(s) configuration.

random - the random generation and presentation configuration.

predefined - the predefined presentation configuration.

Throws:

IllegalArgumentException - if either input, output or random is null.

Method Detail

getInput

public FileConfig getInput()

Return the input file configuration.

Returns:

the input file configuration.

getOutput

public OutputConfig getOutput()

Return the output file(s) configuration.

Returns:

the output file(s) configuration.

getRandom

public GenerationConfig getRandom()

Return the random generation and presentation configuration.

Returns:

the random generation and presentation configuration.

getPredefined

public GenerationConfig getPredefined()

Return the predefined presentation configuration.

Returns:

the predefined presentation configuration.

readYamlConfig

public static Config readYamlConfig(File configFile)
                             throws IOException

A factory method to create a configuration from a YAML file.

Parameters:

configFile - the YAML file to read.

Returns:

the parsed configuration.

Throws:

IOException - if the reading of the file fails.

builder

public static Config.Builder builder()

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

Returns:

a Builder.