org.sw4j.tool.barcode.random.config

Class FileConfig

java.lang.Object

org.sw4j.tool.barcode.random.config.FileConfig

public class FileConfig
extends Object

This class configures a file.

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static FileConfig.Builder	builder() Return a Builder that can be used to build a config.
String	getName() The name of the file configured.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileConfig

public FileConfig(String name)

Create a new FileConfig 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:

name - the name of the file configuration.

Throws:

IllegalArgumentException - if name is null.

Method Detail

getName

public String getName()

The name of the file configured.

Returns:

the name of the file.

builder

public static FileConfig.Builder builder()

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

Returns:

a Builder.