org.thales.punch.settings.api

Class SettingsListBuilder

java.lang.Object

org.thales.punch.settings.api.SettingsListBuilder

public class SettingsListBuilder
extends Object

Use this class to create new ISettingsList. Here are some examples :

    // Get a new empty settings list
    ISettingsList list = new SettingsListBuilder().build();
    
    //  Get a new filled list
    ISettingsList list = new SettingsListBuilder().add(1).add(2).add(3).build()
    
    // Get a list from the content of a string
    ISettingsList list = new SettingsListBuilder().fromString("[1,2,3]").build()
    
 

Constructor Summary

Constructors

Constructor and Description
SettingsListBuilder() get a new SettingsListBuilder, ths is the only official way to create from scratch a settings map.

Method Summary

Modifier and Type	Method and Description
SettingsListBuilder	add(Object value) Before getting your list, fill in some values.
SettingsListBuilder	addAll(Collection<?> c) Add an initial collection to the content of your list
ISettingsList	build() Build and get your ISettingsList.
SettingsListBuilder	fromFile(File file)
SettingsListBuilder	fromFile(Path path)
SettingsListBuilder	fromString(String content) load your list from a string content
SettingsListBuilder	setOriginatorName(String name) Associate a name to you setting list.

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingsListBuilder

public SettingsListBuilder()

get a new SettingsListBuilder, ths is the only official way to create from scratch a settings map.

Method Detail

setOriginatorName

public SettingsListBuilder setOriginatorName(String name)

Associate a name to you setting list. This is only a helper in case a property is missing, that name will be in the error message.

Parameters:

name - an arbitrary name

Returns:

this builder

add

public SettingsListBuilder add(Object value)

Before getting your list, fill in some values.

Parameters:

value - the property value

Returns:

this builder

build

public ISettingsList build()

Build and get your ISettingsList.

Returns:

your settings list

fromString

public SettingsListBuilder fromString(String content)
                               throws SettingsException

load your list from a string content

Parameters:

content - a string conatining a json list

Returns:

this builder

Throws:

SettingsException

fromFile

public SettingsListBuilder fromFile(File file)
                             throws IOException,
                                    ConfigurationException

Throws:

IOException

ConfigurationException

fromFile

public SettingsListBuilder fromFile(Path path)
                             throws ConfigurationException

Throws:

ConfigurationException

addAll

public SettingsListBuilder addAll(Collection<?> c)

Add an initial collection to the content of your list

Parameters:

c - the collection to add

Returns:

this builder