org.apache.tamaya.format

Class ConfigurationDataBuilder

java.lang.Object

org.apache.tamaya.format.ConfigurationDataBuilder

public final class ConfigurationDataBuilder
extends Object

Builder for creating ConfigurationData instances. This class is not thread-safe.

Method Summary

Modifier and Type	Method and Description
ConfigurationDataBuilder	addDefaultProperties(Map<String,String> properties) Adds the given entries to the default section, all existing values will be overridden.
ConfigurationDataBuilder	addDefaultProperty(String key, String value) Adds a single entry to the default section.
ConfigurationDataBuilder	addProperties(Map<String,String> properties) Deprecated. Use addDefaultProperties(Map) instead of.
ConfigurationDataBuilder	addProperty(String key, String value) Deprecated. Use addDefaultProperty(String, String) instead of.
ConfigurationDataBuilder	addSectionProperties(String section, Map<String,String> properties) Adds the given entries to the given section, all existing values will be overridden.
ConfigurationDataBuilder	addSectionProperty(String section, String key, String value) Adds a single entry to a target section.
ConfigurationDataBuilder	addSections(String... sections) Adds (empty) sections,if they are not yet existing.
ConfigurationData	build() Builds a new ConfigurationData instance.
Set<String>	getSectionNames() Access the current named sections, if not present a new instance is initialized.
static ConfigurationDataBuilder	of(ConfigurationData data) Creates a new instance.
static ConfigurationDataBuilder	of(String resource, ConfigurationFormat format) Creates a new instance.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static ConfigurationDataBuilder of(String resource,
                                          ConfigurationFormat format)

Creates a new instance.

Parameters:

resource - the configuration resource URL, not null.

format - the format that read this data, not null.

Returns:

new instance of this class.

of

public static ConfigurationDataBuilder of(ConfigurationData data)

Creates a new instance.

Parameters:

data - an existing ConfigurationData instances used to initialize the builder.

Returns:

new instance of this class from the given configuration.

addSections

public ConfigurationDataBuilder addSections(String... sections)

Adds (empty) sections,if they are not yet existing. Already existing sections will not be touched.

Parameters:

sections - the new sections to put.

Returns:

the builder for chaining.

addSectionProperty

public ConfigurationDataBuilder addSectionProperty(String section,
                                                   String key,
                                                   String value)

Adds a single entry to a target section.

Parameters:

section - the target section (will be created if not existing).

key - the entry's key

value - the entry's value

Returns:

the builder for chaining.

addDefaultProperty

public ConfigurationDataBuilder addDefaultProperty(String key,
                                                   String value)

Adds a single entry to the default section.

Parameters:

key - the entry's key

value - the entry's value

Returns:

the builder for chaining.

addProperty

@Deprecated
public ConfigurationDataBuilder addProperty(String key,
                                                        String value)

Deprecated. Use addDefaultProperty(String, String) instead of.

Adds a single entry to the default section.

Parameters:

key - the entry's key

value - the entry's value

Returns:

the builder for chaining.

addSectionProperties

public ConfigurationDataBuilder addSectionProperties(String section,
                                                     Map<String,String> properties)

Adds the given entries to the given section, all existing values will be overridden.

Parameters:

section - the target section (will be created if not existing).

properties - the entry's data

Returns:

the builder for chaining.

addProperties

@Deprecated
public ConfigurationDataBuilder addProperties(Map<String,String> properties)

Deprecated. Use addDefaultProperties(Map) instead of.

Adds the given entries to the default section, all existing values will be overridden.

Parameters:

properties - the entry's data

Returns:

the builder for chaining.

addDefaultProperties

public ConfigurationDataBuilder addDefaultProperties(Map<String,String> properties)

Adds the given entries to the default section, all existing values will be overridden.

Parameters:

properties - the entry's data

Returns:

the builder for chaining.

getSectionNames

public Set<String> getSectionNames()

Access the current named sections, if not present a new instance is initialized.

Returns:

the current named sections, never null.

build

public ConfigurationData build()

Builds a new ConfigurationData instance.

Returns:

a new ConfigurationData instance, not null.

toString

public String toString()

Overrides:

toString in class Object