ConfigBuilder (Apache Juneau 7.2.2)

java.lang.Object
- org.apache.juneau.ContextBuilder
- - org.apache.juneau.config.ConfigBuilder

```
public class ConfigBuilder
extends ContextBuilder
```
Builder for creating instances of Configs.
Example:

Config cf = Config.create().name("MyConfig.cfg").build(); String setting = cf.getString("MySection/mysetting");

See Also:
- Overview > juneau-config

Field Summary
- Fields inherited from class org.apache.juneau.ContextBuilder
  psb

Constructor Summary

Constructors
Constructor and Description

ConfigBuilder()
Constructor, default settings.

ConfigBuilder(PropertyStore ps)
Constructor.

Constructors
Constructor and Description
`ConfigBuilder()` Constructor, default settings.
`ConfigBuilder(PropertyStore ps)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ConfigBuilder`	`add(Map<String,Object> properties)` Adds multiple configuration properties on this object.
`ConfigBuilder`	`addTo(String name, Object value)` Adds a value to a SET or LIST property.
`ConfigBuilder`	`addTo(String name, String key, Object value)` Adds or overwrites a value to a SET, LIST, or MAP property.
`ConfigBuilder`	`apply(PropertyStore copyFrom)` Copies the settings from the specified property store into this builder.
`ConfigBuilder`	`binaryFormat(BinaryFormat value)` Configuration property: Binary value format.
`ConfigBuilder`	`binaryFormat(String value)` Deprecated. Use `binaryFormat(BinaryFormat)`
`ConfigBuilder`	`binaryLineLength(int value)` Configuration property: Binary value line length.
`Config`	`build()` Build the object.
`ConfigBuilder`	`encoder(Class<? extends ConfigEncoder> value)` Configuration property: Value encoder.
`ConfigBuilder`	`encoder(ConfigEncoder value)` Configuration property: Value encoder.
`ConfigBuilder`	`memStore()` Configuration property: Configuration store.
`ConfigBuilder`	`multiLineValuesOnSeparateLines()` Configuration property: Multi-line values on separate lines.
`ConfigBuilder`	`name(String value)` Configuration property: Configuration name.
`ConfigBuilder`	`parser(Class<? extends ReaderParser> value)` Configuration property: POJO parser.
`ConfigBuilder`	`parser(ReaderParser value)` Configuration property: POJO parser.
`ConfigBuilder`	`readOnly()` Configuration property: Beans on separate lines.
`ConfigBuilder`	`removeFrom(String name, Object value)` Removes a value from a SET, LIST, or MAP property.
`ConfigBuilder`	`serializer(Class<? extends WriterSerializer> value)` Configuration property: POJO serializer.
`ConfigBuilder`	`serializer(WriterSerializer value)` Configuration property: POJO serializer.
`ConfigBuilder`	`set(boolean append, String name, Object value)` Sets or adds to a SET or LIST property.
`ConfigBuilder`	`set(Map<String,Object> properties)` Sets multiple configuration properties on this object.
`ConfigBuilder`	`set(String name, Object value)` Sets a configuration property on this object.
`ConfigBuilder`	`store(ConfigStore value)` Configuration property: Configuration store.
`ConfigBuilder`	`varResolver(Class<? extends VarResolver> value)` Configuration property: SVL variable resolver.
`ConfigBuilder`	`varResolver(VarResolver value)` Configuration property: SVL variable resolver.

Methods inherited from class org.apache.juneau.ContextBuilder
build, getPropertyStore, getPropertyStoreBuilder

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

- Constructor Detail
  - ConfigBuilder
```
public ConfigBuilder()
```
    Constructor, default settings.
  - ConfigBuilder
```
public ConfigBuilder(PropertyStore ps)
```
    Constructor.
    
    Parameters:
    
    ps - The initial configuration settings for this builder.
- Method Detail
  - build
```
public Config build()
```
    Description copied from class: ContextBuilder
    
    Build the object.
    
    Specified by:
    
    build in class ContextBuilder
    
    Returns:
    
    The built object. Subsequent calls to this method will create new instances.
  - name
```
public ConfigBuilder name(String value)
```
    Configuration property: Configuration name.
    Specifies the configuration name.
    This is typically the configuration file name, although the name can be anything identifiable by the ConfigStore used for retrieving and storing the configuration.
    
    Parameters:
    
    value - The new value for this property.
    The default is "Configuration".
    
    Returns:
    
    This object (for method chaining).
  - store
```
public ConfigBuilder store(ConfigStore value)
```
    Configuration property: Configuration store.
    The configuration store used for retrieving and storing configurations.
    
    Parameters:
    
    value - The new value for this property.
    The default is ConfigFileStore.DEFAULT.
    
    Returns:
    
    This object (for method chaining).
  - memStore
```
public ConfigBuilder memStore()
```
    Configuration property: Configuration store.
    Convenience method for calling store(ConfigMemoryStore.DEFAULT).
    
    Returns:
    
    This object (for method chaining).
  - serializer
```
public ConfigBuilder serializer(WriterSerializer value)
```
    Configuration property: POJO serializer.
    The serializer to use for serializing POJO values.
    
    Parameters:
    
    value - The new value for this property.
    The default is SimpleJsonSerializer.DEFAULT.
    
    Returns:
    
    This object (for method chaining).
  - serializer
```
public ConfigBuilder serializer(Class<? extends WriterSerializer> value)
```
    Configuration property: POJO serializer.
    The serializer to use for serializing POJO values.
    
    Parameters:
    
    value - The new value for this property.
    The default is SimpleJsonSerializer.DEFAULT.
    
    Returns:
    
    This object (for method chaining).
  - parser
```
public ConfigBuilder parser(ReaderParser value)
```
    Configuration property: POJO parser.
    The parser to use for parsing values to POJOs.
    
    Parameters:
    
    value - The new value for this property.
    The default is JsonParser.DEFAULT.
    
    Returns:
    
    This object (for method chaining).
  - parser
```
public ConfigBuilder parser(Class<? extends ReaderParser> value)
```
    Configuration property: POJO parser.
    The parser to use for parsing values to POJOs.
    
    Parameters:
    
    value - The new value for this property.
    The default is JsonParser.DEFAULT.
    
    Returns:
    
    This object (for method chaining).
  - encoder
```
public ConfigBuilder encoder(ConfigEncoder value)
```
    Configuration property: Value encoder.
    The encoder to use for encoding encoded configuration values.
    
    Parameters:
    
    value - The new value for this property.
    The default is ConfigXorEncoder.INSTANCE.
    
    Returns:
    
    This object (for method chaining).
  - encoder
```
public ConfigBuilder encoder(Class<? extends ConfigEncoder> value)
```
    Configuration property: Value encoder.
    The encoder to use for encoding encoded configuration values.
    
    Parameters:
    
    value - The new value for this property.
    The default is ConfigXorEncoder.INSTANCE.
    
    Returns:
    
    This object (for method chaining).
  - varResolver
```
public ConfigBuilder varResolver(VarResolver value)
```
    Configuration property: SVL variable resolver.
    The resolver to use for resolving SVL variables.
    
    Parameters:
    
    value - The new value for this property.
    The default is VarResolver.DEFAULT.
    
    Returns:
    
    This object (for method chaining).
  - varResolver
```
public ConfigBuilder varResolver(Class<? extends VarResolver> value)
```
    Configuration property: SVL variable resolver.
    The resolver to use for resolving SVL variables.
    
    Parameters:
    
    value - The new value for this property.
    The default is VarResolver.DEFAULT.
    
    Returns:
    
    This object (for method chaining).
  - binaryLineLength
```
public ConfigBuilder binaryLineLength(int value)
```
    Configuration property: Binary value line length.
    When serializing binary values, lines will be split after this many characters.
    Use -1 to represent no line splitting.
    
    Parameters:
    
    value - The new value for this property.
    The default is -1.
    
    Returns:
    
    This object (for method chaining).
  - binaryFormat
```
public ConfigBuilder binaryFormat(BinaryFormat value)
```
    Configuration property: Binary value format.
    The format to use when persisting byte arrays.
    Possible values:
    - BinaryFormat.BASE64 - BASE64-encoded string.
    - BinaryFormat.HEX - Hexadecimal.
    - BinaryFormat.SPACED_HEX - Hexadecimal with spaces between bytes.
    Parameters:
    
    value - The new value for this property.
    The default is BinaryFormat.BASE64.
    
    Returns:
    
    This object (for method chaining).
  - multiLineValuesOnSeparateLines
```
public ConfigBuilder multiLineValuesOnSeparateLines()
```
    Configuration property: Multi-line values on separate lines.
    When enabled, multi-line values will always be placed on a separate line from the key.
    
    Returns:
    
    This object (for method chaining).
  - readOnly
```
public ConfigBuilder readOnly()
```
    Configuration property: Beans on separate lines.
    When enabled, attempts to call any setters on this object will throw an UnsupportedOperationException.
    
    Returns:
    
    This object (for method chaining).
  - set
```
public ConfigBuilder set(String name,
                         Object value)
```
    Description copied from class: ContextBuilder
    
    Sets a configuration property on this object.
    
    Overrides:
    
    set in class ContextBuilder
    
    Parameters:
    
    name - The property name.
    
    value - The property value.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.set(String, Object)
  - set
```
public ConfigBuilder set(boolean append,
                         String name,
                         Object value)
```
    Description copied from class: ContextBuilder
    
    Sets or adds to a SET or LIST property.
    
    Overrides:
    
    set in class ContextBuilder
    
    Parameters:
    
    append - If true, the previous value is appended to. Otherwise, the previous value is replaced.
    
    name - The property name.
    
    value - The property value.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.set(String, Object)
  - set
```
public ConfigBuilder set(Map<String,Object> properties)
```
    Description copied from class: ContextBuilder
    
    Sets multiple configuration properties on this object.
    
    Overrides:
    
    set in class ContextBuilder
    
    Parameters:
    
    properties - The properties to set on this class.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.set(java.util.Map)
  - add
```
public ConfigBuilder add(Map<String,Object> properties)
```
    Description copied from class: ContextBuilder
    
    Adds multiple configuration properties on this object.
    
    Overrides:
    
    add in class ContextBuilder
    
    Parameters:
    
    properties - The properties to set on this class.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.add(java.util.Map)
  - addTo
```
public ConfigBuilder addTo(String name,
                           Object value)
```
    Description copied from class: ContextBuilder
    
    Adds a value to a SET or LIST property.
    
    Overrides:
    
    addTo in class ContextBuilder
    
    Parameters:
    
    name - The property name.
    
    value - The new value to add to the SET property.
    
    Returns:
    
    This object (for method chaining).
  - addTo
```
public ConfigBuilder addTo(String name,
                           String key,
                           Object value)
```
    Description copied from class: ContextBuilder
    
    Adds or overwrites a value to a SET, LIST, or MAP property.
    
    Overrides:
    
    addTo in class ContextBuilder
    
    Parameters:
    
    name - The property name.
    
    key - The property value map key.
    
    value - The property value map value.
    
    Returns:
    
    This object (for method chaining).
  - removeFrom
```
public ConfigBuilder removeFrom(String name,
                                Object value)
```
    Description copied from class: ContextBuilder
    
    Removes a value from a SET, LIST, or MAP property.
    
    Overrides:
    
    removeFrom in class ContextBuilder
    
    Parameters:
    
    name - The property name.
    
    value - The property value in the SET property.
    
    Returns:
    
    This object (for method chaining).
  - apply
```
public ConfigBuilder apply(PropertyStore copyFrom)
```
    Description copied from class: ContextBuilder
    
    Copies the settings from the specified property store into this builder.
    
    Overrides:
    
    apply in class ContextBuilder
    
    Parameters:
    
    copyFrom - The factory whose settings are being copied.
    
    Returns:
    
    This object (for method chaining).
  - binaryFormat
```
@Deprecated
public ConfigBuilder binaryFormat(String value)
```
    Deprecated. Use binaryFormat(BinaryFormat)

Class ConfigBuilder

Example:

See Also:

Field Summary

Fields inherited from class org.apache.juneau.ContextBuilder

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.ContextBuilder

Methods inherited from class java.lang.Object

Constructor Detail

ConfigBuilder

ConfigBuilder

Method Detail

build

name

store

memStore

serializer

serializer

parser

parser

encoder

encoder

varResolver

varResolver

binaryLineLength

binaryFormat

multiLineValuesOnSeparateLines

readOnly

set

set

set

add

addTo

addTo

removeFrom

apply

binaryFormat