org.sw4j.tool.barcode.random.config

Class OutputConfig

java.lang.Object

org.sw4j.tool.barcode.random.config.OutputConfig

public class OutputConfig
extends Object

This class configures the output file(s).

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	OutputConfig.Builder This class is a Builder to build a OutputConfig programmatically.

Constructor Summary

Constructors

Constructor and Description
OutputConfig(String folder, FileConfig file) Create a new OutputConfig with the given file name.

Method Summary

Modifier and Type	Method and Description
static OutputConfig.Builder	builder() Return a Builder that can be used to build a config.
FileConfig	getFile() Return the output csv file.
String	getFolder() Return the folder of the output files.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputConfig

public OutputConfig(String folder,
                    FileConfig file)

Create a new OutputConfig with the given file name.

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

Parameters:

folder - the name of the file configuration.

file - the name of the output csv file.

Throws:

IllegalArgumentException - if either folder or file is null.

Method Detail

getFolder

public String getFolder()

Return the folder of the output files.

Returns:

the folder of the output files.

getFile

public FileConfig getFile()

Return the output csv file.

Returns:

the output csv file.

builder

public static OutputConfig.Builder builder()

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

Returns:

a Builder.