ConfigurationBuilder (Grace Data

org.grails.datastore.mapping.config.ConfigurationBuilder

```
@CompileStatic
@Slf4j
abstract class ConfigurationBuilder<B, C>
extends Object
```
A generic configuration builder that implementers can implement to construct the configuration from the source PropertyResolver
Type Parameters:
B - The builder type (examples are MongoClientSettings.Builder or Neo4j Bolt's Config.ConfigBuilder
C - The finalized configuration constructions from the builder (examples are MongoClientSettings or Neo4j Bolt's Config)
Authors:
Graeme Rocher
Michael Yan

Field Summary

Fields
Modifiers	Name	Description
`protected B`	`rootBuilder`

Properties Summary

Properties
Type	Name and description
`String`	`builderMethodPrefix`
`String`	`configurationPrefix`
`Object`	`fallBackConfiguration`
`PropertyResolver`	`propertyResolver`

Constructor Summary

Constructors
Constructor and description
`ConfigurationBuilder(PropertyResolver propertyResolver, String configurationPrefix, String builderMethodPrefix)` Parameters: `propertyResolver` - The property resolver
`ConfigurationBuilder(PropertyResolver propertyResolver, String configurationPrefix, Object fallBackConfiguration, String builderMethodPrefix)` Parameters: `propertyResolver` - The property resolver

Methods Summary

Methods
Type Params	Return Type	Name and description
	`C`	`build()`
	`protected void`	`buildRecurse(Object builder, Object fallBackConfig, String startingPrefix)` deprecated: use ConfigurationBuilder.buildRecurse instead
	`protected void`	`buildRecurse(Object builder, List<Class> builderQueue, Object fallBackConfig, String startingPrefix)`
	`protected abstract B`	`createBuilder()` Creates the native builder
	`protected Object`	`getFallBackValue(Object fallBackConfig, String methodName)`
	`protected void`	`newChildBuilder(Object builder, String configurationPath)` Subclasses can override for when a new child builder is created
	`protected Object`	`newChildBuilderForFallback(Object childBuilder, Object fallbackConfig)`
	`protected void`	`startBuild(Object builder, String configurationPath)` Subclasses can override for when building starts for the given builder
	`protected abstract C`	`toConfiguration(B builder)` Convert the builder to the final configuration

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - protected B rootBuilder
- Property Detail
  - final String builderMethodPrefix
  - final String configurationPrefix
  - final Object fallBackConfiguration
  - final PropertyResolver propertyResolver
- Constructor Detail
  - @CompileDynamic
    ConfigurationBuilder(PropertyResolver propertyResolver, String configurationPrefix, String builderMethodPrefix)
    
    Parameters:
    propertyResolver - The property resolver
    configurationPrefix - The prefix to resolve settings from within the configuration. Example "grails.gorm.neo4j" or "grails.gorm.mongodb"
    builderMethodPrefix - The prefix to builder method calls. Default is null which results in builder methods like "foo(...)". Setting a prefix of "with" results in "withFoo(..)"
  - @CompileDynamic
    ConfigurationBuilder(PropertyResolver propertyResolver, String configurationPrefix, Object fallBackConfiguration, String builderMethodPrefix)
    
    Parameters:
    propertyResolver - The property resolver
    configurationPrefix - The prefix to resolve settings from within the configuration. Example "grails.gorm.neo4j" or "grails.gorm.mongodb"
    builderMethodPrefix - The prefix to builder method calls. Default is null which results in builder methods like "foo(...)". Setting a prefix of "with" results in "withFoo(..)"
    fallBackConfiguration - An object to read the fallback configuration from
- Method Detail
  - C build()
  - protected void buildRecurse(Object builder, Object fallBackConfig, String startingPrefix)
    
    deprecated:
    use ConfigurationBuilder.buildRecurse instead
  - protected void buildRecurse(Object builder, List<Class> builderQueue, Object fallBackConfig, String startingPrefix)
  - protected abstract B createBuilder()
    
    Creates the native builder
    Returns:
    The native builder
  - protected Object getFallBackValue(Object fallBackConfig, String methodName)
  - protected void newChildBuilder(Object builder, String configurationPath)
    
    Subclasses can override for when a new child builder is created
    Parameters:
    builder - The builder
    configurationPath - The configuration path
  - protected Object newChildBuilderForFallback(Object childBuilder, Object fallbackConfig)
  - protected void startBuild(Object builder, String configurationPath)
    
    Subclasses can override for when building starts for the given builder
    Parameters:
    builder - The current builder
    configurationPath - The configuration path
  - protected abstract C toConfiguration(B builder)
    
    Convert the builder to the final configuration
    Parameters:
    builder - The builder
    Returns:
    The final configuration

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class ConfigurationBuilder<B, C>

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected B rootBuilder

Property Detail

final String builderMethodPrefix

final String configurationPrefix

final Object fallBackConfiguration

final PropertyResolver propertyResolver

Constructor Detail

@CompileDynamic
ConfigurationBuilder(PropertyResolver propertyResolver, String configurationPrefix, String builderMethodPrefix)

@CompileDynamic
ConfigurationBuilder(PropertyResolver propertyResolver, String configurationPrefix, Object fallBackConfiguration, String builderMethodPrefix)

Method Detail

C build()

protected void buildRecurse(Object builder, Object fallBackConfig, String startingPrefix)

protected void buildRecurse(Object builder, List<Class> builderQueue, Object fallBackConfig, String startingPrefix)

protected abstract B createBuilder()

protected Object getFallBackValue(Object fallBackConfig, String methodName)

protected void newChildBuilder(Object builder, String configurationPath)

protected Object newChildBuilderForFallback(Object childBuilder, Object fallbackConfig)

protected void startBuild(Object builder, String configurationPath)

protected abstract C toConfiguration(B builder)

[Groovy] Class ConfigurationBuilder<B, C>

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected B rootBuilder

Property Detail

final String builderMethodPrefix

final String configurationPrefix

final Object fallBackConfiguration

final PropertyResolver propertyResolver

Constructor Detail

@CompileDynamicConfigurationBuilder(PropertyResolver propertyResolver, String configurationPrefix, String builderMethodPrefix)

@CompileDynamicConfigurationBuilder(PropertyResolver propertyResolver, String configurationPrefix, Object fallBackConfiguration, String builderMethodPrefix)

Method Detail

C build()

protected void buildRecurse(Object builder, Object fallBackConfig, String startingPrefix)

protected void buildRecurse(Object builder, List<Class> builderQueue, Object fallBackConfig, String startingPrefix)

protected abstract B createBuilder()

protected Object getFallBackValue(Object fallBackConfig, String methodName)

protected void newChildBuilder(Object builder, String configurationPath)

protected Object newChildBuilderForFallback(Object childBuilder, Object fallbackConfig)

protected void startBuild(Object builder, String configurationPath)

protected abstract C toConfiguration(B builder)

@CompileDynamic
ConfigurationBuilder(PropertyResolver propertyResolver, String configurationPrefix, String builderMethodPrefix)

@CompileDynamic
ConfigurationBuilder(PropertyResolver propertyResolver, String configurationPrefix, Object fallBackConfiguration, String builderMethodPrefix)