EnvironmentBuilder (ogham 3.1.0-SNAPSHOT API)

Type Parameters:

P - the type of the parent builder (when calling Parent.and() method)

All Superinterfaces:

Builder<PropertyResolver>, Parent

All Known Implementing Classes:

EnvironmentBuilderDelegate, SimpleEnvironmentBuilder
```
public interface EnvironmentBuilder
extends Parent, Builder<PropertyResolver>
```
Builder that configures how configuration properties are handled.
The user can use either system properties or custom properties or properties loaded from a file. The user can also mix them. For example, he can use system properties and custom properties.

The user can also configure how conversions are applied to properties (converting a string that comes from properties into an integer for example).

Finally, the user can also use a custom PropertyResolver (the property resolver is the abstraction used to read properties).

Built PropertyResolver will then be used in almost every builder to evaluate property keys (in the form of "${custom.property}").

Author:

Aurélien Baudet

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ConverterBuilder<EnvironmentBuilder<P>>`	`converter()` Configure how conversions are applied on properties.
`EnvironmentBuilder<P>`	`override()` Overrides any previously defined properties.
`PropertiesBuilder<EnvironmentBuilder<P>>`	`properties()` Provide custom properties using fluent API.
`PropertiesBuilder<EnvironmentBuilder<P>>`	`properties(int priority)` Provide custom properties using fluent API.
`EnvironmentBuilder<P>`	`properties(Properties properties)` Provide custom properties.
`EnvironmentBuilder<P>`	`properties(Properties properties, int priority)` Provide custom properties.
`EnvironmentBuilder<P>`	`properties(String path)` Load a property file using its path.
`EnvironmentBuilder<P>`	`properties(String path, int priority)` Load a property file using its path.
`EnvironmentBuilder<P>`	`resolver(PropertyResolver resolver)` Defined a custom `PropertyResolver` instead of the default one.
`EnvironmentBuilder<P>`	`systemProperties()` Use system properties.
`EnvironmentBuilder<P>`	`systemProperties(int priority)` Use system properties.

Methods inherited from interface fr.sii.ogham.core.fluent.Parent
and

Methods inherited from interface fr.sii.ogham.core.builder.Builder
build

- Method Detail
 - override
```
EnvironmentBuilder override()
```
 Overrides any previously defined properties. For example:
```
 
 .properties("foo.properties")
 .properties(myProperties)
 .systemProperties()
 .override()
 .properties()
 .set("foo", "bar")
 
 
```
 The three first lines won't be taken into account. Only the properties defined after are used.
 Returns:
 
 this instance for fluent chaining
 - properties
```
EnvironmentBuilder properties(String path)
```
 Load a property file using its path. The properties are mixed with other registered properties taking into account the priority. The path may contain a lookup prefix:
 - classpath:conf/myprops.properties: loads a file named "myprops.properties" in the classpath
 - file:/home/foo/myprops.properties: loads a file named "myprops.properties" from the file system
 - conf/myprops.properties: loads a file named "myprops.properties" in the classpath
 The path may contain a ? character. It means that the path is optional and it doesn't fail if the file doesn't exist.
 The priority of the registered properties depends on if the file is loaded from the classpath or from the filesystem. The priority is used to order all registered properties. Registered properties with higher priorities are used first. It means that when requesting for a property value the highest priority is requested first to get the value if it exists. If it doesn't exist, the second is requested and so on. If several properties are registered with the same priority, then the registration order is used.
 The default priorities are:
 - using system properties = 100000
 - load properties from file from the filesystem = 90000
 - using custom Properties object = 80000
 - using custom properties through properties() fluent API = 80000
 - load properties from file in the classpath (inside the application) = 70000
 Parameters:
 
 path - the path to the property file
 
 Returns:
 
 this instance for fluent chaining
 - properties
```
EnvironmentBuilder properties(String path,
 int priority)
```
 Load a property file using its path. The properties are mixed with other registered properties taking into account the priority. The path may contain a lookup prefix:
 - classpath:conf/myprops.properties: loads a file named "myprops.properties" in the classpath
 - file:/home/foo/myprops.properties: loads a file named "myprops.properties" from the file system
 - conf/myprops.properties: loads a file named "myprops.properties" in the classpath
 The path may contain a ? character. It means that the path is optional and it doesn't fail if the file doesn't exist.
 Indicates the priority of the registered properties. The priority is used to order all registered properties. Registered properties with higher priorities are used first. It means that when requesting for a property value the highest priority is requested first to get the value if it exists. If it doesn't exist, the second is requested and so on. If several properties are registered with the same priority, then the registration order is used.
 Parameters:
 
 path - the path to the property file
 
 priority - the priority of the properties
 
 Returns:
 
 this instance for fluent chaining
 - properties
```
EnvironmentBuilder properties(Properties properties)
```
 Provide custom properties.
 The priority of the registered properties is 80000. The priority is used to order all registered properties. Registered properties with higher priorities are used first. It means that when requesting for a property value the highest priority is requested first to get the value if it exists. If it doesn't exist, the second is requested and so on. If several properties are registered with the same priority, then the registration order is used.
 The default priorities are:
 - using system properties = 100000
 - load properties from file from the filesystem = 90000
 - using custom Properties object = 80000
 - using custom properties through properties() fluent API = 80000
 - load properties from file in the classpath (inside the application) = 70000
 Parameters:
 
 properties - the custom properties
 
 Returns:
 
 this instance for fluent chaining
 - properties
```
EnvironmentBuilder properties(Properties properties,
 int priority)
```
 Provide custom properties. The properties are mixed with other registered properties taking into account the priority.
 Indicates the priority of the registered properties. The priority is used to order all registered properties. Registered properties with higher priorities are used first. It means that when requesting for a property value the highest priority is requested first to get the value if it exists. If it doesn't exist, the second is requested and so on. If several properties are registered with the same priority, then the registration order is used.
 
 Parameters:
 
 properties - the custom properties
 
 priority - the priority of the properties
 
 Returns:
 
 this instance for fluent chaining
 - properties
```
PropertiesBuilder<EnvironmentBuilder> properties()
```
 Provide custom properties using fluent API. The properties are mixed with other registered properties taking into account the priority.
 The priority of the registered properties is 80000. The priority is used to order all registered properties. Registered properties with higher priorities are used first. It means that when requesting for a property value the highest priority is requested first to get the value if it exists. If it doesn't exist, the second is requested and so on. If several properties are registered with the same priority, then the registration order is used.
 The default priorities are:
 - using system properties = 100000
 - load properties from file from the filesystem = 90000
 - using custom Properties object = 80000
 - using custom properties through properties() fluent API = 80000
 - load properties from file in the classpath (inside the application) = 70000
 Returns:
 
 the builder to configure properties
 - properties
```
PropertiesBuilder<EnvironmentBuilder> properties(int priority)
```
 Provide custom properties using fluent API. The properties are mixed with other registered properties taking into account the priority.
 Indicates the priority of the registered properties. The priority is used to order all registered properties. Registered properties with higher priorities are used first. It means that when requesting for a property value the highest priority is requested first to get the value if it exists. If it doesn't exist, the second is requested and so on. If several properties are registered with the same priority, then the registration order is used.
 
 Parameters:
 
 priority - the priority of the properties
 
 Returns:
 
 the builder to configure properties
 - systemProperties
```
EnvironmentBuilder systemProperties()
```
 Use system properties. The properties are mixed with other registered properties taking into account the priority.
 The priority of the registered properties is 100000. The priority is used to order all registered properties. Registered properties with higher priorities are used first. It means that when requesting for a property value the highest priority is requested first to get the value if it exists. If it doesn't exist, the second is requested and so on. If several properties are registered with the same priority, then the registration order is used.
 The default priorities are:
 - using system properties = 100000
 - load properties from file from the filesystem = 90000
 - using custom Properties object = 80000
 - using custom properties through properties() fluent API = 80000
 - load properties from file in the classpath (inside the application) = 70000
 Returns:
 
 this instance for fluent chaining
 - systemProperties
```
EnvironmentBuilder systemProperties(int priority)
```
 Use system properties. The properties are mixed with other registered properties taking into account the priority.
 Indicates the priority of the registered properties. The priority is used to order all registered properties. Registered properties with higher priorities are used first. It means that when requesting for a property value the highest priority is requested first to get the value if it exists. If it doesn't exist, the second is requested and so on. If several properties are registered with the same priority, then the registration order is used.
 
 Parameters:
 
 priority - the priority of the properties
 
 Returns:
 
 this instance for fluent chaining
 - converter
```
ConverterBuilder<EnvironmentBuilder> converter()
```
 Configure how conversions are applied on properties.
 Properties are like a map with a string key and often a string value. In an application, you need to work with real objects (not always strings). The converter will be used to transform a string value that comes from properties into a real object.
 
 Using the ConverterBuilder is useful to register custom converters.
 
 Returns:
 
 the converter builder
 - resolver
```
EnvironmentBuilder resolver(PropertyResolver resolver)
```
 Defined a custom PropertyResolver instead of the default one.
 Using a custom PropertyResolver may be useful when default implementation doesn't fit your needs. For example, when using Spring, Ogham will automatically register a property resolver that uses Spring Environment concept.
 
 Parameters:
 
 resolver - the custom resolver
 
 Returns:
 
 this instance for fluent chaining

Interface EnvironmentBuilder<P>

Method Summary

Methods inherited from interface fr.sii.ogham.core.fluent.Parent

Methods inherited from interface fr.sii.ogham.core.builder.Builder

Method Detail

override

properties

properties

properties

properties

properties

properties

systemProperties

systemProperties

converter

resolver