ConstrettoBuilder (Constretto :: Core implementation

java.lang.Object
- org.constretto.ConstrettoBuilder

```
public class ConstrettoBuilder
extends Object
```
Provides a fluent Java api to build a constretto configuration object.

Author:

Kaare Nilsen

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`ConstrettoBuilder.EncryptedPropertiesStoreBuilder`
`class`	`ConstrettoBuilder.IniFileConfigurationStoreBuilder`
`class`	`ConstrettoBuilder.JsonStoreBuilder`
`class`	`ConstrettoBuilder.ObjectConfigurationStoreBuilder`
`class`	`ConstrettoBuilder.PropertiesStoreBuilder`
`class`	`ConstrettoBuilder.WrappedLdapConfigurationStoreBuilder`
`class`	`ConstrettoBuilder.YamlStoreBuilder`

Field Summary

Fields
Modifier and Type Field and Description

static String OVERRIDES

Fields
Modifier and Type	Field and Description
`static String`	`OVERRIDES`

Constructor Summary

Constructors
Constructor and Description
`ConstrettoBuilder()` Deprecated. use the factory method @link{#empty} instead
`ConstrettoBuilder(boolean enableSystemProps)` Deprecated. use the factory method @link{#empty(boolean)} instead
`ConstrettoBuilder(ConfigurationContextResolver configurationContextResolver, boolean enableSystemProps)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConstrettoBuilder`	`addConfigurationStore(ConfigurationStore configurationStore)` Add configuration store to the builder
`ConstrettoBuilder`	`addCurrentTag(String tag)`
`ConstrettoBuilder`	`addExistingConfiguration(ConstrettoConfiguration constrettoConfiguration)` Adds an existing configuration to be used as a configuration source
`ConstrettoBuilder.EncryptedPropertiesStoreBuilder`	`createEncryptedPropertiesStore(String passwordProperty)`
`ConstrettoBuilder.IniFileConfigurationStoreBuilder`	`createIniFileConfigurationStore()`
`ConstrettoBuilder.JsonStoreBuilder`	`createJsonConfigurationStore()`
`ConstrettoBuilder.WrappedLdapConfigurationStoreBuilder`	`createLdapConfigurationStore(DirContext dirContext)`
`ConstrettoBuilder.ObjectConfigurationStoreBuilder`	`createObjectConfigurationStore()`
`ConstrettoBuilder.PropertiesStoreBuilder`	`createPropertiesStore()`
`ConstrettoBuilder`	`createSystemPropertiesStore()`
`ConstrettoBuilder.YamlStoreBuilder`	`createYamlConfigurationStore()`
`static ConstrettoBuilder`	`empty()` Creates an empty ConstrettoBuilder using the DefaultConfigurationContextResolver to resolve the configuration context
`static ConstrettoBuilder`	`empty(ConfigurationContextResolver configurationContextResolver)` Creates an empty ConstrettoBuilder
`static ConstrettoBuilder`	`fromExistingConfiguration(ConstrettoConfiguration constrettoConfiguration)` Creates a new ConstrettoBuilder instance based on an existing constrettoConfiguration using the default ConfigurationContextResolver
`static ConstrettoBuilder`	`fromExistingConfiguration(ConstrettoConfiguration constrettoConfiguration, ConfigurationContextResolver configurationContextResolver)` Creates a new ConstrettoBuilder instance based on an existing configuration.
`ConstrettoConfiguration`	`getConfiguration()`
`static ConstrettoBuilder`	`withSystemProperties()` Creates a new ConstrettoBuilder with a system properties store added and using the DefaultConfigurationContextResolver to resolve configuration context
`static ConstrettoBuilder`	`withSystemProperties(ConfigurationContextResolver contextResolver)` Creates a new ConstrettoBuilder with a system properties store added

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OVERRIDES
```
public static final String OVERRIDES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ConstrettoBuilder
```
@Deprecated
public ConstrettoBuilder()
```
    Deprecated. use the factory method @link{#empty} instead
  - ConstrettoBuilder
```
@Deprecated
public ConstrettoBuilder(boolean enableSystemProps)
```
    Deprecated. use the factory method @link{#empty(boolean)} instead
    
    Parameters:
    
    enableSystemProps - a boolean that decides whether system properties are added to the configuration or not
  - ConstrettoBuilder
```
public ConstrettoBuilder(ConfigurationContextResolver configurationContextResolver,
                         boolean enableSystemProps)
```
- Method Detail
  - withSystemProperties
```
public static ConstrettoBuilder withSystemProperties(ConfigurationContextResolver contextResolver)
```
    Creates a new ConstrettoBuilder with a system properties store added
    
    Parameters:
    
    contextResolver - the contextResolver implementation to use to find out what the context should be
    
    Returns:
    
    a new ConstrettoBuilder instance
  - withSystemProperties
```
public static ConstrettoBuilder withSystemProperties()
```
    Creates a new ConstrettoBuilder with a system properties store added and using the DefaultConfigurationContextResolver to resolve configuration context
    
    Returns:
    
    a new ConstrettoBuilder instance
  - empty
```
public static ConstrettoBuilder empty()
```
    Creates an empty ConstrettoBuilder using the DefaultConfigurationContextResolver to resolve the configuration context
    
    Returns:
    
    a new ConstrettoBuilder
  - empty
```
public static ConstrettoBuilder empty(ConfigurationContextResolver configurationContextResolver)
```
    Creates an empty ConstrettoBuilder
    
    Parameters:
    
    configurationContextResolver - the ConfigurationContextResolver to use to resolve the context
    
    Returns:
    
    a new ConstrettoBuilder
  - fromExistingConfiguration
```
public static ConstrettoBuilder fromExistingConfiguration(ConstrettoConfiguration constrettoConfiguration,
                                                          ConfigurationContextResolver configurationContextResolver)
```
    Creates a new ConstrettoBuilder instance based on an existing configuration. Configuration keys are considered be tagged with the default tag
    
    Parameters:
    
    constrettoConfiguration - an existing constrettoConfiguration instance
    
    configurationContextResolver - the configurationContextResolver to use for the resulting constrettoConfiguration
    
    Returns:
    
    a new builder with the existing configuration added
  - fromExistingConfiguration
```
public static ConstrettoBuilder fromExistingConfiguration(ConstrettoConfiguration constrettoConfiguration)
```
    Creates a new ConstrettoBuilder instance based on an existing constrettoConfiguration using the default ConfigurationContextResolver
    
    Parameters:
    
    constrettoConfiguration - an existing constrettoConfiguration instance
    
    Returns:
    
    a new builder with the existing configuration added
  - getConfiguration
```
public ConstrettoConfiguration getConfiguration()
```
  - addCurrentTag
```
public ConstrettoBuilder addCurrentTag(String tag)
```
  - addConfigurationStore
```
public ConstrettoBuilder addConfigurationStore(ConfigurationStore configurationStore)
```
    Add configuration store to the builder
    
    Parameters:
    
    configurationStore - the store to added
    
    Returns:
    
    the same ConstrettoBuilder with the given ConfigurationStore added
  - addExistingConfiguration
```
public ConstrettoBuilder addExistingConfiguration(ConstrettoConfiguration constrettoConfiguration)
```
    Adds an existing configuration to be used as a configuration source
    
    Parameters:
    
    constrettoConfiguration - the configuration to be added
    
    Returns:
  - createPropertiesStore
```
public ConstrettoBuilder.PropertiesStoreBuilder createPropertiesStore()
```
  - createEncryptedPropertiesStore
```
public ConstrettoBuilder.EncryptedPropertiesStoreBuilder createEncryptedPropertiesStore(String passwordProperty)
```
  - createIniFileConfigurationStore
```
public ConstrettoBuilder.IniFileConfigurationStoreBuilder createIniFileConfigurationStore()
```
  - createJsonConfigurationStore
```
public ConstrettoBuilder.JsonStoreBuilder createJsonConfigurationStore()
```
  - createSystemPropertiesStore
```
public ConstrettoBuilder createSystemPropertiesStore()
```
  - createObjectConfigurationStore
```
public ConstrettoBuilder.ObjectConfigurationStoreBuilder createObjectConfigurationStore()
```
  - createLdapConfigurationStore
```
public ConstrettoBuilder.WrappedLdapConfigurationStoreBuilder createLdapConfigurationStore(DirContext dirContext)
```
  - createYamlConfigurationStore
```
public ConstrettoBuilder.YamlStoreBuilder createYamlConfigurationStore()
```

Class ConstrettoBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OVERRIDES

Constructor Detail

ConstrettoBuilder

ConstrettoBuilder

ConstrettoBuilder

Method Detail

withSystemProperties

withSystemProperties

empty

empty

fromExistingConfiguration

fromExistingConfiguration

getConfiguration

addCurrentTag

addConfigurationStore

addExistingConfiguration

createPropertiesStore

createEncryptedPropertiesStore

createIniFileConfigurationStore

createJsonConfigurationStore

createSystemPropertiesStore

createObjectConfigurationStore

createLdapConfigurationStore

createYamlConfigurationStore