Configuration (Confectory Core 0.2.0 API)

java.lang.Object
- net.obvj.confectory.Configuration<T>

Type Parameters:

T - the target configuration type

All Implemented Interfaces:

ConfigurationDataRetriever<T>, ConfigurationMetadataRetriever<T>
```
public final class Configuration<T>
extends Object
implements ConfigurationDataRetriever<T>, ConfigurationMetadataRetriever<T>
```
An immutable object that contains configuration data from a specific source, as well as related metadata.
A Configuration may also be defined as a combination of a Source and a Mapper, producing either a properties list, a JSON object, or a user-defined bean.
Each Configuration may be assigned a namespace and precedence number, which determines an order of importance. So, once stored in a common configuration container, the object with the highest precedence value will be chosen first, taking precedence over the other ones in the same namespace.
A Configuration may also be optional, which means that the configuration will be loaded quietly.
Note: Use a ConfigurationBuilder to create a Configuration object. A builder instance can be retrieved by calling builder(). For example:
```
  Configuration<Properties> config = Configuration.<Properties>builder()
          .source(new ClasspathFileSource<>("my.properties"))
          .mapper(new PropertiesMapper())
          .namespace("my-properties")
          .precedence(10)
          .build();
 
```
Since:

0.1.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

See Also:

Source, Mapper, ConfigurationBuilder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> ConfigurationBuilder<T>`	`builder()` Creates a new configuration builder.
`boolean`	`equals(Object other)` Indicates whether some other object is "equal to" this one.
`Optional<T>`	`getBean()` Returns the target configuration object used by this data retriever, typically for manual handling and/or troubleshooting purposes.
`boolean`	`getBoolean(String key)` Returns the `boolean` value associated with the specified `key`.
`double`	`getDouble(String key)` Returns the `double` value associated with the specified `key`.
`ConfigurationHelper<T>`	`getHelper()` Returns the `ConfigurationHelper` associated with this `Configuration`.
`int`	`getInt(String key)` Returns the `int` value associated with the specified `key`.
`long`	`getLong(String key)` Returns the `long` value associated with the specified `key`.
`Mapper<T>`	`getMapper()` Returns the `Mapper` object associated with this `Configuration`.
`String`	`getNamespace()` Returns the namespace defined for this `Configuration` object.
`NullValueProvider`	`getNullValueProvider()` Returns the `NullValueProvider` associated with this `Configuration`.
`int`	`getPrecedence()` Returns the precedence value defined for this `Configuration` object.
`Source<T>`	`getSource()` Returns the `Source` object associated with this `Configuration`.
`String`	`getString(String key)` Returns the `String` value associated with the specified `key`.
`int`	`hashCode()`
`boolean`	`isOptional()` Returns a flag indicating whether this `Configuration` is optional.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - builder
```
public static <T> ConfigurationBuilder<T> builder()
```
    Creates a new configuration builder.
    
    Type Parameters:
    
    T - the target configuration type
    
    Returns:
    
    a new ConfigurationBuilder
  - getNamespace
```
public String getNamespace()
```
    Description copied from interface: ConfigurationMetadataRetriever
    
    Returns the namespace defined for this Configuration object.
    
    Specified by:
    
    getNamespace in interface ConfigurationMetadataRetriever<T>
    
    Returns:
    
    the namespace defined for this Configuration
  - getPrecedence
```
public int getPrecedence()
```
    Description copied from interface: ConfigurationMetadataRetriever
    
    Returns the precedence value defined for this Configuration object.
    In a common container, objects with higher-precedence may be selected first in case of key collision.
    
    Specified by:
    
    getPrecedence in interface ConfigurationMetadataRetriever<T>
    
    Returns:
    
    an integer number representing the order of importance given to this Configuration
  - getSource
```
public Source<T> getSource()
```
    Description copied from interface: ConfigurationMetadataRetriever
    
    Returns the Source object associated with this Configuration.
    
    Specified by:
    
    getSource in interface ConfigurationMetadataRetriever<T>
    
    Returns:
    
    a Source instance
  - getMapper
```
public Mapper<T> getMapper()
```
    Description copied from interface: ConfigurationMetadataRetriever
    
    Returns the Mapper object associated with this Configuration.
    
    Specified by:
    
    getMapper in interface ConfigurationMetadataRetriever<T>
    
    Returns:
    
    a Mapper instance
  - isOptional
```
public boolean isOptional()
```
    Description copied from interface: ConfigurationMetadataRetriever
    
    Returns a flag indicating whether this Configuration is optional.
    An optional Configuration object may behave quietly in the event of a failure to load the data.
    
    Specified by:
    
    isOptional in interface ConfigurationMetadataRetriever<T>
    
    Returns:
    
    true if this Configuration setup is optional; false, otherwise
  - getNullValueProvider
```
public NullValueProvider getNullValueProvider()
```
    Description copied from interface: ConfigurationMetadataRetriever
    
    Returns the NullValueProvider associated with this Configuration.
    
    Specified by:
    
    getNullValueProvider in interface ConfigurationMetadataRetriever<T>
    
    Returns:
    
    a NullValueProvider instance
  - getHelper
```
public ConfigurationHelper<T> getHelper()
```
    Returns the ConfigurationHelper associated with this Configuration.
    
    Returns:
    
    the ConfigurationHelper
  - getBean
```
public Optional<T> getBean()
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the target configuration object used by this data retriever, typically for manual handling and/or troubleshooting purposes.
    
    Specified by:
    
    getBean in interface ConfigurationDataRetriever<T>
    
    Returns:
    
    an Optional, possibly containing the target configuration object
  - getBoolean
```
public boolean getBoolean(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the boolean value associated with the specified key.
    
    Specified by:
    
    getBoolean in interface ConfigurationDataRetriever<T>
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the boolean value associated with the specified key
  - getInt
```
public int getInt(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the int value associated with the specified key.
    
    Specified by:
    
    getInt in interface ConfigurationDataRetriever<T>
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the int value associated with the specified key
  - getLong
```
public long getLong(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the long value associated with the specified key.
    
    Specified by:
    
    getLong in interface ConfigurationDataRetriever<T>
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the long value associated with the specified key
  - getDouble
```
public double getDouble(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the double value associated with the specified key.
    
    Specified by:
    
    getDouble in interface ConfigurationDataRetriever<T>
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the double value associated with the specified key
  - getString
```
public String getString(String key)
```
    Description copied from interface: ConfigurationDataRetriever
    
    Returns the String value associated with the specified key.
    
    Specified by:
    
    getString in interface ConfigurationDataRetriever<T>
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the String value associated with the specified key
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Indicates whether some other object is "equal to" this one.
    Two Configuration objects can be considered equal if both share the same namespace and Source.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - the other object with which to compare
    
    Returns:
    
    true if this object is the same as the one specified in the argument; false otherwise.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Configuration<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

getNamespace

getPrecedence

getSource

getMapper

isOptional

getNullValueProvider

getHelper

getBean

getBoolean

getInt

getLong

getDouble

getString

hashCode

equals

toString