org.thales.punch.settings.api

Class SettingsMapBuilder

java.lang.Object

org.thales.punch.settings.api.SettingsMapBuilder

public class SettingsMapBuilder
extends Object

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

    // Get a new empty settings map
    SettingsMap map = new SettingsMapImpl().build();
    
    //  Get a new filled SettingsMap
    SettingsMap map = new SettingsMapBuilder().add("port", 80).add("host", "localhost").build()
    
    // Get a SettingsMap from the content of a whole file directory
    SettingsMap map = new SettingsMapBuilder().fromDirectory("/tmp/conf").build()
    
 

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SettingsMapBuilder	addNestedProperty(Object value, String... keys) Add an initial nested property.
SettingsMapBuilder	addProperty(String key, Object value) Before getting your map, fill in some values.
ISettingsMap	build() Build and get your ISettingsMap.
protected static String	convertYamlToJson(String yaml)
static ISettingsMap	from(byte[] content) Simplify from()
SettingsMapBuilder	fromBytes(byte[] content) build your settings map from bytes
SettingsMapBuilder	fromDirectory(String pathDir) build your settings map from the content of a directory.
SettingsMapBuilder	fromFile(File file)
SettingsMapBuilder	fromFile(Path path) Return a builder for a yml, yaml json or hjson file.
SettingsMapBuilder	fromFile(String path) Return a builder for a simple json or hjson file.
SettingsMapBuilder	fromString(String str) build your settings map from a String
SettingsMapBuilder	fromYaml(String str) build your settings map from YAML as String
SettingsMapBuilder	putAll(Map<? extends String,? extends Object> m) Add an initial collection to the content of your list
SettingsMapBuilder	setJsonDecoding(boolean b) By default files read from zookeeper of from the local file system are automatically decoded as json (if, of course, thier content is json compatible).
SettingsMapBuilder	setName(String name) Associate a name to you setting map.

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingsMapBuilder

public SettingsMapBuilder()

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

Method Detail

setName

public SettingsMapBuilder setName(String name)

Associate a name to you setting map. 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

addProperty

public SettingsMapBuilder addProperty(String key,
                                      Object value)

Before getting your map, fill in some values.

Parameters:

key - the property key

value - the property value

Returns:

this builder

addNestedProperty

public SettingsMapBuilder addNestedProperty(Object value,
                                            String... keys)

Add an initial nested property.

For example :

 ISettingsMap map = new SettingsMapBuilder()
   .addNestedProperty("kafka", "metricset", "type")
   .addNestedProperty("broker", "metricset", "name")
   .build();
 

Parameters:

value - the value. Calling this with a null value has no effect; null is considered not compatible.

keys - the list of keys

Returns:

this builder

build

public ISettingsMap build()

Build and get your ISettingsMap.

Returns:

your settings map

fromString

public SettingsMapBuilder fromString(String str)

build your settings map from a String

Parameters:

str - your json string

Returns:

this builder

fromBytes

public SettingsMapBuilder fromBytes(byte[] content)

build your settings map from bytes

Parameters:

content - your byte array

Returns:

this builder

fromFile

public SettingsMapBuilder fromFile(String path)
                            throws IOException,
                                   ConfigurationException

Return a builder for a simple json or hjson file.

Parameters:

path - the absolute file path

Returns:

a builder instance

Throws:

IOException - in case of problem

ConfigurationException

fromFile

public SettingsMapBuilder fromFile(File file)
                            throws IOException,
                                   ConfigurationException

Throws:

IOException

ConfigurationException

convertYamlToJson

protected static String convertYamlToJson(String yaml)
                                   throws com.fasterxml.jackson.databind.JsonMappingException,
                                          com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonProcessingException

fromFile

public SettingsMapBuilder fromFile(Path path)
                            throws ConfigurationException

Return a builder for a yml, yaml json or hjson file.

Parameters:

path - the map path

Returns:

the settings map builder

Throws:

IllegalArgumentException - if you provide a null path

IOException - if the file cannot be open

ConfigurationException - if the input file is not a correct yaml json or hjson file

fromDirectory

public SettingsMapBuilder fromDirectory(String pathDir)
                                 throws IOException

build your settings map from the content of a directory. This gives you a map where inner files are represented by a file handle (i.e. a file inode) that you can later on access using the settings map api. Either as raw content or as a parsed inner map if the corresponding file contains a json compatible content.

Parameters:

pathDir - your directory

Returns:

this builder

Throws:

IOException - if a problem reading the directory occured

fromYaml

public SettingsMapBuilder fromYaml(String str)

build your settings map from YAML as String

Parameters:

str - your yaml string

Returns:

this builder

setJsonDecoding

public SettingsMapBuilder setJsonDecoding(boolean b)

By default files read from zookeeper of from the local file system are automatically decoded as json (if, of course, thier content is json compatible).

Use this to request no decoding. You will then get FileHandle instead.

Parameters:

b - true or false.

Returns:

this builder

putAll

public SettingsMapBuilder putAll(Map<? extends String,? extends Object> m)

Add an initial collection to the content of your list

Parameters:

m - the initial map to add

Returns:

this builder

from

public static ISettingsMap from(byte[] content)

Simplify from()

Parameters:

content - to parse

Returns:

ISettingsMap