Config (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.Context
- - org.apache.juneau.config.Config

All Implemented Interfaces:

ConfigEventListener, Writable
```
public final class Config
extends Context
implements ConfigEventListener, Writable
```
Main configuration API class.
See Also:
- Overview > juneau-config

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONFIG_binaryFormat` Configuration property: Binary value format.
`static String`	`CONFIG_binaryLineLength` Configuration property: Binary value line length.
`static String`	`CONFIG_encoder` Configuration property: Value encoder.
`static String`	`CONFIG_multiLineValuesOnSeparateLines` Configuration property: Multi-line values should always be on separate lines.
`static String`	`CONFIG_name` Configuration property: Configuration name.
`static String`	`CONFIG_parser` Configuration property: POJO parser.
`static String`	`CONFIG_readOnly` Configuration property: Read-only.
`static String`	`CONFIG_serializer` Configuration property: POJO serializer.
`static String`	`CONFIG_store` Configuration property: Configuration store.
`static String`	`CONFIG_varResolver` Configuration property: SVL variable resolver.

Constructor Summary

Constructors
Constructor and Description

Config(PropertyStore ps)
Constructor.

Constructors
Constructor and Description
`Config(PropertyStore ps)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Config`	`addListener(ConfigEventListener listener)` Add a listener to this config to react to modification events.
`ObjectMap`	`asMap()` Returns the values in this config map as a map of maps.
`ConfigBuilder`	`builder()` Creates a builder from this context object.
`void`	`close()` Closes this configuration object by unregistering it from the underlying config map.
`Config`	`commit()` Commit the changes in this config to the store.
`static ConfigBuilder`	`create()` Instantiates a new clean-slate `ConfigBuilder` object.
`static ConfigBuilder`	`create(String name)` Same as `create()` but initializes the builder with the specified config name.
`SessionArgs`	`createDefaultSessionArgs()` Unused.
`Session`	`createSession(SessionArgs args)` Unused.
`Config`	`encodeEntries()` Encodes and unencoded entries in this config.
`boolean`	`exists(String key)` Returns true if this section contains the specified key and the key has a non-blank value.
`protected void`	`finalize()`
`String`	`get(String key)` Returns the specified value as a string from the config file.
`boolean`	`getBoolean(String key)` Convenience method for getting boolean config values.
`boolean`	`getBoolean(String key, boolean def)` Convenience method for getting boolean config values.
`byte[]`	`getBytes(String key)` Convenience method for getting byte array config values.
`byte[]`	`getBytes(String key, byte[] def)` Same as `getBytes(String)` but with a default value if the entry doesn't exist.
`double`	`getDouble(String key)` Convenience method for getting double config values.
`double`	`getDouble(String key, double def)` Same as `getDouble(String)` but returns a default value if not set.
`float`	`getFloat(String key)` Convenience method for getting float config values.
`float`	`getFloat(String key, float def)` Same as `getFloat(String)` but returns a default value if not set.
`int`	`getInt(String key)` Convenience method for getting int config values.
`int`	`getInt(String key, int def)` Same as `getInt(String)` but returns a default value if not set.
`Set<String>`	`getKeys(String section)` Returns the keys of the entries in the specified section.
`long`	`getLong(String key)` Convenience method for getting long config values.
`long`	`getLong(String key, long def)` Same as `getLong(String)` but returns a default value if not set.
`MediaType`	`getMediaType()` Returns the serialized media type for this resource (e.g.
`<T> T`	`getObject(String key, Class<T> type)` Same as `getObject(String, Type, Type...)` except optimized for a non-parameterized class.
`<T> T`	`getObject(String key, Parser parser, Class<T> type)` Same as `getObject(String, Class)` but allows you to specify the parser to use to parse the value.
`<T> T`	`getObject(String key, Parser parser, Type type, Type... args)` Same as `getObject(String, Type, Type...)` but allows you to specify the parser to use to parse the value.
`<T> T`	`getObject(String key, Type type, Type... args)` Gets the entry with the specified key and converts it to the specified value.
`<T> T`	`getObjectWithDefault(String key, Parser parser, T def, Class<T> type)` Same as `getObjectWithDefault(String, Object, Class)` but allows you to specify the parser to use to parse the value.
`<T> T`	`getObjectWithDefault(String key, Parser parser, T def, Type type, Type... args)` Same as `getObjectWithDefault(String, Object, Type, Type...)` but allows you to specify the parser to use to parse the value.
`<T> T`	`getObjectWithDefault(String key, T def, Class<T> type)` Gets the entry with the specified key and converts it to the specified value.
`<T> T`	`getObjectWithDefault(String key, T def, Type type, Type... args)` Gets the entry with the specified key and converts it to the specified value.
`<T> T`	`getSectionAsBean(String section, Class<T> c)` Shortcut for calling `getSectionAsBean(sectionName, c, false)`.
`<T> T`	`getSectionAsBean(String section, Class<T> c, boolean ignoreUnknownProperties)` Converts this config file section to the specified bean instance.
`<T> T`	`getSectionAsInterface(String section, Class<T> c)` Wraps a config file section inside a Java interface so that values in the section can be read and write using getters and setters.
`ObjectMap`	`getSectionAsMap(String section)` Returns a section of this config copied into an `ObjectMap`.
`String`	`getString(String key)` Gets the entry with the specified key.
`String`	`getString(String key, String def)` Gets the entry with the specified key.
`String[]`	`getStringArray(String key)` Gets the entry with the specified key, splits the value on commas, and returns the values as trimmed strings.
`String[]`	`getStringArray(String key, String[] def)` Same as `getStringArray(String)` but returns a default value if the value cannot be found.
`Config`	`load(Map<String,Map<String,Object>> m)` Loads the contents of the specified map of maps into this config.
`Config`	`load(Reader contents, boolean synchronous)` Overwrites the contents of the config file.
`Config`	`load(String contents, boolean synchronous)` Overwrites the contents of the config file.
`void`	`onConfigChange(List<ConfigEvent> events)` Gets called immediately after a config file has been loaded.
`Config`	`remove(String key)` Removes an entry with the specified key.
`Config`	`removeListener(ConfigEventListener listener)` Removes a listener from this config.
`Config`	`removeSection(String name)` Removes the section with the specified name.
`Config`	`resolving(VarResolverSession varSession)` Creates a copy of this config using the specified var session for resolving variables.
`Config`	`rollback()` Does a rollback of any changes on this config currently in memory.
`Config`	`set(String key, Object value)` Adds or replaces an entry with the specified key with a POJO serialized to a string using the registered serializer.
`Config`	`set(String key, Object value, Serializer serializer)` Same as `set(String, Object)` but allows you to specify the serializer to use to serialize the value.
`Config`	`set(String key, Object value, Serializer serializer, ConfigMod[] modifiers, String comment, List<String> preLines)` Same as `set(String, Object)` but allows you to specify all aspects of a value.
`Config`	`set(String key, Object value, Serializer serializer, ConfigMod modifier, String comment, List<String> preLines)` Same as `set(String, Object)` but allows you to specify all aspects of a value.
`Config`	`set(String key, String value)` Sets a value in this config.
`Config`	`setSection(String name, List<String> preLines)` Creates the specified section if it doesn't exist.
`Config`	`setSection(String name, List<String> preLines, Map<String,Object> contents)` Creates the specified section if it doesn't exist.
`String`	`toString()`
`Config`	`writeProperties(String section, Object bean, boolean ignoreUnknownProperties)` Copies the entries in a section to the specified bean by calling the public setters on that bean.
`Writer`	`writeTo(Writer w)` Saves this config file to the specified writer as an INI file.

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

- Field Detail
  - CONFIG_name
```
public static final String CONFIG_name
```
    Configuration property: Configuration name.
    Property:
    - Name: "Config.name.s"
    - Data type: String
    - Default: "Configuration.cfg"
    - Methods:
      
      ConfigBuilder.name(String)
    Description:
    
    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.
    See Also:
    
    Constant Field Values
  - CONFIG_store
```
public static final String CONFIG_store
```
    Configuration property: Configuration store.
    Property:
    - Name: "Config.store.o"
    - Data type: ConfigStore
    - Default: ConfigFileStore.DEFAULT
    - Methods:
      
      ConfigBuilder.store(ConfigStore)
    Description:
    
    The configuration store used for retrieving and storing configurations.
    See Also:
    
    Constant Field Values
  - CONFIG_serializer
```
public static final String CONFIG_serializer
```
    Configuration property: POJO serializer.
    Property:
    - Name: "Config.serializer.o"
    - Data type: WriterSerializer
    - Default: JsonSerializer.DEFAULT_LAX
    - Methods:
      
      ConfigBuilder.serializer(Class)
      ConfigBuilder.serializer(WriterSerializer)
    Description:
    
    The serializer to use for serializing POJO values.
    See Also:
    
    Constant Field Values
  - CONFIG_parser
```
public static final String CONFIG_parser
```
    Configuration property: POJO parser.
    Property:
    - Name: "Config.parser.o"
    - Data type: ReaderParser
    - Default: JsonParser.DEFAULT
    - Methods:
      
      ConfigBuilder.parser(Class)
      ConfigBuilder.parser(ReaderParser)
    Description:
    
    The parser to use for parsing values to POJOs.
    See Also:
    
    Constant Field Values
  - CONFIG_encoder
```
public static final String CONFIG_encoder
```
    Configuration property: Value encoder.
    Property:
    - Name: "Config.encoder.o"
    - Data type: ConfigEncoder
    - Default: ConfigXorEncoder.INSTANCE
    - Methods:
      
      ConfigBuilder.encoder(Class)
      ConfigBuilder.encoder(ConfigEncoder)
    Description:
    
    The encoder to use for encoding encoded configuration values.
    See Also:
    
    Constant Field Values
  - CONFIG_varResolver
```
public static final String CONFIG_varResolver
```
    Configuration property: SVL variable resolver.
    Property:
    - Name: "Config.varResolver.o"
    - Data type: VarResolver
    - Default: VarResolver.DEFAULT
    - Methods:
      
      ConfigBuilder.varResolver(Class)
      ConfigBuilder.varResolver(VarResolver)
    Description:
    
    The resolver to use for resolving SVL variables.
    See Also:
    
    Constant Field Values
  - CONFIG_binaryLineLength
```
public static final String CONFIG_binaryLineLength
```
    Configuration property: Binary value line length.
    Property:
    - Name: "Config.binaryLineLength.i"
    - Data type: Integer
    - Default: -1
    - Methods:
      
      ConfigBuilder.binaryLineLength(int)
    Description:
    
    When serializing binary values, lines will be split after this many characters.
    Use -1 to represent no line splitting.
    See Also:
    
    Constant Field Values
  - CONFIG_binaryFormat
```
public static final String CONFIG_binaryFormat
```
    Configuration property: Binary value format.
    Property:
    - Name: "Config.binaryFormat.s"
    - Data type: String
    - Default: "BASE64"
    - Methods:
      
      ConfigBuilder.binaryFormat(String)
    Description:
    
    The format to use when persisting byte arrays.
    Possible values:
    - "BASE64" - BASE64-encoded string.
    - "HEX" - Hexadecimal.
    - "SPACED_HEX" - Hexadecimal with spaces between bytes.
    See Also:
    
    Constant Field Values
  - CONFIG_multiLineValuesOnSeparateLines
```
public static final String CONFIG_multiLineValuesOnSeparateLines
```
    Configuration property: Multi-line values should always be on separate lines.
    Property:
    - Name: "Config.multiLineValuesOnSeparateLines.b"
    - Data type: Boolean
    - Default: false
    - Methods:
      
      ConfigBuilder.multiLineValuesOnSeparateLines()
    Description:
    
    When enabled, multi-line values will always be placed on a separate line from the key.
    See Also:
    
    Constant Field Values
  - CONFIG_readOnly
```
public static final String CONFIG_readOnly
```
    Configuration property: Read-only.
    Property:
    - Name: "Config.readOnly.b"
    - Data type: Boolean
    - Default: false
    - Methods:
      
      ConfigBuilder.readOnly()
    Description:
    
    When enabled, attempts to call any setters on this object will throw an UnsupportedOperationException.
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Config
```
public Config(PropertyStore ps)
       throws IOException
```
    Constructor.
    
    Parameters:
    
    ps - The property store containing all the settings for this object.
    
    Throws:
    
    IOException
- Method Detail
  - create
```
public static ConfigBuilder create()
```
    Instantiates a new clean-slate ConfigBuilder object.
    This is equivalent to simply calling new ConfigBuilder().
    
    Returns:
    
    A new ConfigBuilder object.
  - create
```
public static ConfigBuilder create(String name)
```
    Same as create() but initializes the builder with the specified config name.
    This is equivalent to simply calling new ConfigBuilder().name(name).
    
    Parameters:
    
    name - The configuration name.
    
    Returns:
    
    A new ConfigBuilder object.
  - builder
```
public ConfigBuilder builder()
```
    Description copied from class: Context
    
    Creates a builder from this context object.
    Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.
    
    Overrides:
    
    builder in class Context
    
    Returns:
    
    A new ContextBuilder object.
  - resolving
```
public Config resolving(VarResolverSession varSession)
```
    Creates a copy of this config using the specified var session for resolving variables.
    This creates a shallow copy of the config but replacing the variable resolver.
    
    Parameters:
    
    varSession - The var session used for resolving string variables.
    
    Returns:
    
    A new config object.
  - get
```
public String get(String key)
```
    Returns the specified value as a string from the config file.
    Unlike getString(String), this method doesn't replace SVL variables.
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    The value, or null if the section or value doesn't exist.
  - set
```
public Config set(String key,
                  String value)
```
    Sets a value in this config.
    
    Parameters:
    
    key - The key.
    
    value - The value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    UnsupportedOperationException - If configuration is read only.
  - set
```
public Config set(String key,
                  Object value)
           throws SerializeException
```
    Adds or replaces an entry with the specified key with a POJO serialized to a string using the registered serializer.
    Equivalent to calling put(key, value, isEncoded(key)).
    
    Parameters:
    
    key - The key.
    
    value - The new value POJO.
    
    Returns:
    
    The previous value, or null if the section or key did not previously exist.
    
    Throws:
    
    SerializeException - If serializer could not serialize the value or if a serializer is not registered with this config file.
    
    UnsupportedOperationException - If configuration is read only.
  - set
```
public Config set(String key,
                  Object value,
                  Serializer serializer)
           throws SerializeException
```
    Same as set(String, Object) but allows you to specify the serializer to use to serialize the value.
    
    Parameters:
    
    key - The key.
    
    value - The new value.
    
    serializer - The serializer to use for serializing the object. If null, then uses the predefined serializer on the config file.
    
    Returns:
    
    The previous value, or null if the section or key did not previously exist.
    
    Throws:
    
    SerializeException - If serializer could not serialize the value or if a serializer is not registered with this config file.
    
    UnsupportedOperationException - If configuration is read only.
  - set
```
public Config set(String key,
                  Object value,
                  Serializer serializer,
                  ConfigMod modifier,
                  String comment,
                  List<String> preLines)
           throws SerializeException
```
    Same as set(String, Object) but allows you to specify all aspects of a value.
    
    Parameters:
    
    key - The key.
    
    value - The new value.
    
    serializer - The serializer to use for serializing the object. If null, then uses the predefined serializer on the config file.
    
    modifier - Optional modifier to apply to the value.
    If null, then previous value will not be replaced.
    
    comment - Optional same-line comment to add to this value.
    If null, then previous value will not be replaced.
    
    preLines - Optional comment or blank lines to add before this entry.
    If null, then previous value will not be replaced.
    
    Returns:
    
    The previous value, or null if the section or key did not previously exist.
    
    Throws:
    
    SerializeException - If serializer could not serialize the value or if a serializer is not registered with this config file.
    
    UnsupportedOperationException - If configuration is read only.
  - set
```
public Config set(String key,
                  Object value,
                  Serializer serializer,
                  ConfigMod[] modifiers,
                  String comment,
                  List<String> preLines)
           throws SerializeException
```
    Same as set(String, Object) but allows you to specify all aspects of a value.
    
    Parameters:
    
    key - The key.
    
    value - The new value.
    
    serializer - The serializer to use for serializing the object. If null, then uses the predefined serializer on the config file.
    
    modifiers - Optional modifiers to apply to the value.
    If null, then previous value will not be replaced.
    
    comment - Optional same-line comment to add to this value.
    If null, then previous value will not be replaced.
    
    preLines - Optional comment or blank lines to add before this entry.
    If null, then previous value will not be replaced.
    
    Returns:
    
    The previous value, or null if the section or key did not previously exist.
    
    Throws:
    
    SerializeException - If serializer could not serialize the value or if a serializer is not registered with this config file.
    
    UnsupportedOperationException - If configuration is read only.
  - remove
```
public Config remove(String key)
```
    Removes an entry with the specified key.
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    The previous value, or null if the section or key did not previously exist.
    
    Throws:
    
    UnsupportedOperationException - If configuration is read only.
  - encodeEntries
```
public Config encodeEntries()
```
    Encodes and unencoded entries in this config.
    If any entries in the config are marked as encoded but not actually encoded, this will encode them.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    UnsupportedOperationException - If configuration is read only.
  - getString
```
public String getString(String key)
```
    Gets the entry with the specified key.
    The key can be in one of the following formats...
    - "key" - A value in the default section (i.e. defined above any [section] header).
    - "section/key" - A value from the specified section.
    Parameters:
    
    key - The key.
    
    Returns:
    
    The value, or null if the section or key does not exist.
  - getString
```
public String getString(String key,
                        String def)
```
    Gets the entry with the specified key.
    The key can be in one of the following formats...
    - "key" - A value in the default section (i.e. defined above any [section] header).
    - "section/key" - A value from the specified section.
    Parameters:
    
    key - The key.
    
    def - The default value if the value does not exist.
    
    Returns:
    
    The value, or the default value if the section or key does not exist.
  - getStringArray
```
public String[] getStringArray(String key)
```
    Gets the entry with the specified key, splits the value on commas, and returns the values as trimmed strings.
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    The value, or an empty array if the section or key does not exist.
  - getStringArray
```
public String[] getStringArray(String key,
                               String[] def)
```
    Same as getStringArray(String) but returns a default value if the value cannot be found.
    
    Parameters:
    
    key - The key.
    
    def - The default value if the value does not exist.
    
    Returns:
    
    The value, or the default value if the section or key does not exist or is blank.
  - getInt
```
public int getInt(String key)
```
    Convenience method for getting int config values.
    "K", "M", and "G" can be used to identify kilo, mega, and giga.
    Example:
    - "100K" => 1024000
    - "100M" => 104857600
    Uses Integer.decode(String) underneath, so any of the following integer formats are supported:
    - "0x..."
    - "0X..."
    - "#..."
    - "0..."
    Parameters:
    
    key - The key.
    
    Returns:
    
    The value, or 0 if the value does not exist or the value is empty.
  - getInt
```
public int getInt(String key,
                  int def)
```
    Same as getInt(String) but returns a default value if not set.
    
    Parameters:
    
    key - The key.
    
    def - The default value if the value does not exist.
    
    Returns:
    
    The value, or the default value if the value does not exist or the value is empty.
  - getBoolean
```
public boolean getBoolean(String key)
```
    Convenience method for getting boolean config values.
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    The value, or false if the section or key does not exist or cannot be parsed as a boolean.
  - getBoolean
```
public boolean getBoolean(String key,
                          boolean def)
```
    Convenience method for getting boolean config values.
    
    Parameters:
    
    key - The key.
    
    def - The default value if the value does not exist.
    
    Returns:
    
    The value, or the default value if the section or key does not exist or cannot be parsed as a boolean.
  - getLong
```
public long getLong(String key)
```
    Convenience method for getting long config values.
    "K", "M", and "G" can be used to identify kilo, mega, and giga.
    Example:
    - "100K" => 1024000
    - "100M" => 104857600
    Uses Long.decode(String) underneath, so any of the following number formats are supported:
    - "0x..."
    - "0X..."
    - "#..."
    - "0..."
    Parameters:
    
    key - The key.
    
    Returns:
    
    The value, or 0 if the value does not exist or the value is empty.
  - getLong
```
public long getLong(String key,
                    long def)
```
    Same as getLong(String) but returns a default value if not set.
    
    Parameters:
    
    key - The key.
    
    def - The default value if the value does not exist.
    
    Returns:
    
    The value, or the default value if the value does not exist or the value is empty.
  - getDouble
```
public double getDouble(String key)
```
    Convenience method for getting double config values.
    Uses Double.valueOf(String) underneath, so any of the following number formats are supported:
    - "0x..."
    - "0X..."
    - "#..."
    - "0..."
    Parameters:
    
    key - The key.
    
    Returns:
    
    The value, or 0 if the value does not exist or the value is empty.
  - getDouble
```
public double getDouble(String key,
                        double def)
```
    Same as getDouble(String) but returns a default value if not set.
    
    Parameters:
    
    key - The key.
    
    def - The default value if the value does not exist.
    
    Returns:
    
    The value, or the default value if the value does not exist or the value is empty.
  - getFloat
```
public float getFloat(String key)
```
    Convenience method for getting float config values.
    Uses Float.valueOf(String) underneath, so any of the following number formats are supported:
    - "0x..."
    - "0X..."
    - "#..."
    - "0..."
    Parameters:
    
    key - The key.
    
    Returns:
    
    The value, or 0 if the value does not exist or the value is empty.
  - getFloat
```
public float getFloat(String key,
                      float def)
```
    Same as getFloat(String) but returns a default value if not set.
    
    Parameters:
    
    key - The key.
    
    def - The default value if the value does not exist.
    
    Returns:
    
    The value, or the default value if the value does not exist or the value is empty.
  - getBytes
```
public byte[] getBytes(String key)
                throws ParseException
```
    Convenience method for getting byte array config values.
    This is equivalent to calling the following:
    byte[] b = config.getObject(key, byte[].class);
    Byte arrays are stored as encoded strings, typically BASE64, but dependent on the CONFIG_binaryFormat setting.
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    The value, or null if the section or key does not exist.
    
    Throws:
    
    ParseException - If value could not be converted to a byte array.
  - getBytes
```
public byte[] getBytes(String key,
                       byte[] def)
                throws ParseException
```
    Same as getBytes(String) but with a default value if the entry doesn't exist.
    
    Parameters:
    
    key - The key.
    
    def - The default value if the value does not exist.
    
    Returns:
    
    The value, or the default value if the section or key does not exist.
    
    Throws:
    
    ParseException - If value could not be converted to a byte array.
  - getObject
```
public <T> T getObject(String key,
                       Type type,
                       Type... args)
                throws ParseException
```
    Gets the entry with the specified key and converts it to the specified value.
    The key can be in one of the following formats...
    - "key" - A value in the default section (i.e. defined above any [section] header).
    - "section/key" - A value from the specified section.
    The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).
    Examples:
    
    Config cf = Config.create().name("MyConfig.cfg").build(); // Parse into a linked-list of strings. List l = cf.getObject("MySection/myListOfStrings", LinkedList.class, String.class); // Parse into a linked-list of beans. List l = cf.getObject("MySection/myListOfBeans", LinkedList.class, MyBean.class); // Parse into a linked-list of linked-lists of strings. List l = cf.getObject("MySection/my2dListOfStrings", LinkedList.class, LinkedList.class, String.class); // Parse into a map of string keys/values. Map m = cf.getObject("MySection/myMap", TreeMap.class, String.class, String.class); // Parse into a map containing string keys and values of lists containing beans. Map m = cf.getObject("MySection/myMapOfListsOfBeans", TreeMap.class, String.class, List.class, MyBean.class);
    
    Collection classes are assumed to be followed by zero or one objects indicating the element type.
    Map classes are assumed to be followed by zero or two meta objects indicating the key and value types.
    The array can be arbitrarily long to indicate arbitrarily complex data structures.
    Notes:
    - Use the getObject(String, Class) method instead if you don't need a parameterized map/collection.
    Parameters:
    
    key - The key.
    
    type - The object type to create.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    
    args - The type arguments of the class if it's a collection or map.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    Ignored if the main type is not a map or collection.
    
    Returns:
    
    The value, or null if the section or key does not exist.
    
    Throws:
    
    ParseException - If parser could not parse the value or if a parser is not registered with this config file.
  - getObject
```
public <T> T getObject(String key,
                       Parser parser,
                       Type type,
                       Type... args)
                throws ParseException
```
    Same as getObject(String, Type, Type...) but allows you to specify the parser to use to parse the value.
    
    Parameters:
    
    key - The key.
    
    parser - The parser to use for parsing the object. If null, then uses the predefined parser on the config file.
    
    type - The object type to create.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    
    args - The type arguments of the class if it's a collection or map.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    Ignored if the main type is not a map or collection.
    
    Returns:
    
    The value, or null if the section or key does not exist.
    
    Throws:
    
    ParseException - If parser could not parse the value or if a parser is not registered with this config file.
  - getObject
```
public <T> T getObject(String key,
                       Class<T> type)
                throws ParseException
```
    Same as getObject(String, Type, Type...) except optimized for a non-parameterized class.
    This is the preferred parse method for simple types since you don't need to cast the results.
    Examples:
    
    Config cf = Config.create().name("MyConfig.cfg").build(); // Parse into a string. String s = cf.getObject("MySection/mySimpleString", String.class); // Parse into a bean. MyBean b = cf.getObject("MySection/myBean", MyBean.class); // Parse into a bean array. MyBean[] b = cf.getObject("MySection/myBeanArray", MyBean[].class); // Parse into a linked-list of objects. List l = cf.getObject("MySection/myList", LinkedList.class); // Parse into a map of object keys/values. Map m = cf.getObject("MySection/myMap", TreeMap.class);
    
    Type Parameters:
    
    T - The class type of the object being created.
    
    Parameters:
    
    key - The key.
    
    type - The object type to create.
    
    Returns:
    
    The parsed object.
    
    Throws:
    
    ParseException - If the input contains a syntax error or is malformed, or is not valid for the specified type.
    
    See Also:
    
    for argument syntax for maps and collections.
  - getObject
```
public <T> T getObject(String key,
                       Parser parser,
                       Class<T> type)
                throws ParseException
```
    Same as getObject(String, Class) but allows you to specify the parser to use to parse the value.
    
    Type Parameters:
    
    T - The class type of the object being created.
    
    Parameters:
    
    key - The key.
    
    parser - The parser to use for parsing the object. If null, then uses the predefined parser on the config file.
    
    type - The object type to create.
    
    Returns:
    
    The parsed object.
    
    Throws:
    
    ParseException - If the input contains a syntax error or is malformed, or is not valid for the specified type.
    
    See Also:
    
    for argument syntax for maps and collections.
  - getObjectWithDefault
```
public <T> T getObjectWithDefault(String key,
                                  T def,
                                  Class<T> type)
                           throws ParseException
```
    Gets the entry with the specified key and converts it to the specified value.
    Same as getObject(String, Class), but with a default value.
    
    Parameters:
    
    key - The key.
    
    def - The default value if the value does not exist.
    
    type - The class to convert the value to.
    
    Returns:
    
    The value, or null if the section or key does not exist.
    
    Throws:
    
    ParseException - If parser could not parse the value or if a parser is not registered with this config file.
  - getObjectWithDefault
```
public <T> T getObjectWithDefault(String key,
                                  Parser parser,
                                  T def,
                                  Class<T> type)
                           throws ParseException
```
    Same as getObjectWithDefault(String, Object, Class) but allows you to specify the parser to use to parse the value.
    
    Parameters:
    
    key - The key.
    
    parser - The parser to use for parsing the object. If null, then uses the predefined parser on the config file.
    
    def - The default value if the value does not exist.
    
    type - The class to convert the value to.
    
    Returns:
    
    The value, or null if the section or key does not exist.
    
    Throws:
    
    ParseException - If parser could not parse the value or if a parser is not registered with this config file.
  - getObjectWithDefault
```
public <T> T getObjectWithDefault(String key,
                                  T def,
                                  Type type,
                                  Type... args)
                           throws ParseException
```
    Gets the entry with the specified key and converts it to the specified value.
    Same as getObject(String, Type, Type...), but with a default value.
    
    Parameters:
    
    key - The key.
    
    def - The default value if the value does not exist.
    
    type - The object type to create.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    
    args - The type arguments of the class if it's a collection or map.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    Ignored if the main type is not a map or collection.
    
    Returns:
    
    The value, or null if the section or key does not exist.
    
    Throws:
    
    ParseException - If parser could not parse the value or if a parser is not registered with this config file.
  - getObjectWithDefault
```
public <T> T getObjectWithDefault(String key,
                                  Parser parser,
                                  T def,
                                  Type type,
                                  Type... args)
                           throws ParseException
```
    Same as getObjectWithDefault(String, Object, Type, Type...) but allows you to specify the parser to use to parse the value.
    
    Parameters:
    
    key - The key.
    
    parser - The parser to use for parsing the object. If null, then uses the predefined parser on the config file.
    
    def - The default value if the value does not exist.
    
    type - The object type to create.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    
    args - The type arguments of the class if it's a collection or map.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    Ignored if the main type is not a map or collection.
    
    Returns:
    
    The value, or null if the section or key does not exist.
    
    Throws:
    
    ParseException - If parser could not parse the value or if a parser is not registered with this config file.
  - getKeys
```
public Set<String> getKeys(String section)
```
    Returns the keys of the entries in the specified section.
    
    Parameters:
    
    section - The section name to write from.
    If empty, refers to the default section.
    Must not be null.
    
    Returns:
    
    An unmodifiable set of keys, or an empty set if the section doesn't exist.
  - writeProperties
```
public Config writeProperties(String section,
                              Object bean,
                              boolean ignoreUnknownProperties)
                       throws ParseException,
                              IllegalArgumentException,
                              IllegalAccessException,
                              InvocationTargetException
```
    Copies the entries in a section to the specified bean by calling the public setters on that bean.
    
    Parameters:
    
    section - The section name to write from.
    If empty, refers to the default section.
    Must not be null.
    
    bean - The bean to set the properties on.
    
    ignoreUnknownProperties - If true, don't throw an IllegalArgumentException if this section contains a key that doesn't correspond to a setter method.
    
    Returns:
    
    An object map of the changes made to the bean.
    
    Throws:
    
    ParseException - If parser was not set on this config file or invalid properties were found in the section.
    
    IllegalArgumentException
    
    IllegalAccessException
    
    InvocationTargetException
    
    UnsupportedOperationException - If configuration is read only.
  - getSectionAsBean
```
public <T> T getSectionAsBean(String section,
                              Class<T> c)
                       throws ParseException
```
    Shortcut for calling getSectionAsBean(sectionName, c, false).
    
    Parameters:
    
    section - The section name to write from.
    If empty, refers to the default section.
    Must not be null.
    
    c - The bean class to create.
    
    Returns:
    
    A new bean instance.
    
    Throws:
    
    ParseException
  - getSectionAsBean
```
public <T> T getSectionAsBean(String section,
                              Class<T> c,
                              boolean ignoreUnknownProperties)
                       throws ParseException
```
    Converts this config file section to the specified bean instance.
    Key/value pairs in the config file section get copied as bean property values to the specified bean class.
    Example config file
    
    [MyAddress] name = John Smith street = 123 Main Street city = Anywhere state = NY zip = 12345
    
    Example bean
    
    public class Address { public String name, street, city; public StateEnum state; public int zip; }
    
    Example usage
    
    Config cf = Config.create().name("MyConfig.cfg").build(); Address myAddress = cf.getSectionAsBean("MySection", Address.class);
    
    Parameters:
    
    section - The section name to write from.
    If empty, refers to the default section.
    Must not be null.
    
    c - The bean class to create.
    
    ignoreUnknownProperties - If false, throws a ParseException if the section contains an entry that isn't a bean property name.
    
    Returns:
    
    A new bean instance, or null if the section doesn't exist.
    
    Throws:
    
    ParseException
  - getSectionAsMap
```
public ObjectMap getSectionAsMap(String section)
                          throws ParseException
```
    Returns a section of this config copied into an ObjectMap.
    
    Parameters:
    
    section - The section name to write from.
    If empty, refers to the default section.
    Must not be null.
    
    Returns:
    
    A new ObjectMap, or null if the section doesn't exist.
    
    Throws:
    
    ParseException
  - getSectionAsInterface
```
public <T> T getSectionAsInterface(String section,
                                   Class<T> c)
```
    Wraps a config file section inside a Java interface so that values in the section can be read and write using getters and setters.
    Example config file
    
    [MySection] string = foo int = 123 enum = ONE bean = {foo:'bar',baz:123} int3dArray = [[[123,null],null],null] bean1d3dListMap = {key:[[[[{foo:'bar',baz:123}]]]]}
    
    Example interface
    
    public interface MyConfigInterface { String getString(); void setString(String x); int getInt(); void setInt(int x); MyEnum getEnum(); void setEnum(MyEnum x); MyBean getBean(); void setBean(MyBean x); int[][][] getInt3dArray(); void setInt3dArray(int[][][] x); Map<String,List<MyBean[][][]>> getBean1d3dListMap(); void setBean1d3dListMap(Map<String,List<MyBean[][][]>> x); }
    
    Example usage
    
    Config cf = Config.create().name("MyConfig.cfg").build(); MyConfigInterface ci = cf.getSectionAsInterface("MySection", MyConfigInterface.class); int myInt = ci.getInt(); ci.setBean(new MyBean()); cf.save();
    
    Notes
    - Calls to setters when the configuration is read-only will cause UnsupportedOperationException to be thrown.
    Parameters:
    
    section - The section name to write from.
    If empty, refers to the default section.
    Must not be null.
    
    c - The proxy interface class.
    
    Returns:
    
    The proxy interface.
  - exists
```
public boolean exists(String key)
```
    Returns true if this section contains the specified key and the key has a non-blank value.
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    true if this section contains the specified key and the key has a non-blank value.
  - setSection
```
public Config setSection(String name,
                         List<String> preLines)
```
    Creates the specified section if it doesn't exist.
    Returns the existing section if it already exists.
    
    Parameters:
    
    name - The section name.
    Must not be null.
    Use blank for the default section.
    
    preLines - Optional comment and blank lines to add immediately before the section.
    If null, previous pre-lines will not be replaced.
    
    Returns:
    
    The appended or existing section.
    
    Throws:
    
    UnsupportedOperationException - If configuration is read only.
  - setSection
```
public Config setSection(String name,
                         List<String> preLines,
                         Map<String,Object> contents)
                  throws SerializeException
```
    Creates the specified section if it doesn't exist.
    
    Parameters:
    
    name - The section name.
    Must not be null.
    Use blank for the default section.
    
    preLines - Optional comment and blank lines to add immediately before the section.
    If null, previous pre-lines will not be replaced.
    
    contents - Values to set in the new section.
    Can be null.
    
    Returns:
    
    The appended or existing section.
    
    Throws:
    
    SerializeException
    
    UnsupportedOperationException - If configuration is read only.
  - removeSection
```
public Config removeSection(String name)
```
    Removes the section with the specified name.
    
    Parameters:
    
    name - The name of the section to remove
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    UnsupportedOperationException - If configuration is read only.
  - load
```
public Config load(Map<String,Map<String,Object>> m)
            throws SerializeException
```
    Loads the contents of the specified map of maps into this config.
    
    Parameters:
    
    m - The maps to load.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    SerializeException
  - commit
```
public Config commit()
              throws IOException
```
    Commit the changes in this config to the store.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    IOException
    
    UnsupportedOperationException - If configuration is read only.
  - writeTo
```
public Writer writeTo(Writer w)
               throws IOException
```
    Saves this config file to the specified writer as an INI file.
    The writer will automatically be closed.
    
    Specified by:
    
    writeTo in interface Writable
    
    Parameters:
    
    w - The writer to send the output to.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    IOException - If a problem occurred trying to send contents to the writer.
  - addListener
```
public Config addListener(ConfigEventListener listener)
```
    Add a listener to this config to react to modification events.
    Listeners should be removed using removeListener(ConfigEventListener).
    
    Parameters:
    
    listener - The new listener to add.
    
    Returns:
    
    This object (for method chaining).
  - removeListener
```
public Config removeListener(ConfigEventListener listener)
```
    Removes a listener from this config.
    
    Parameters:
    
    listener - The listener to remove.
    
    Returns:
    
    This object (for method chaining).
  - close
```
public void close()
           throws IOException
```
    Closes this configuration object by unregistering it from the underlying config map.
    
    Throws:
    
    IOException
  - load
```
public Config load(Reader contents,
                   boolean synchronous)
            throws IOException,
                   InterruptedException
```
    Overwrites the contents of the config file.
    
    Parameters:
    
    contents - The new contents of the config file.
    
    synchronous - Wait until the change has been persisted before returning this map.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    IOException
    
    InterruptedException
    
    UnsupportedOperationException - If configuration is read only.
  - load
```
public Config load(String contents,
                   boolean synchronous)
            throws IOException,
                   InterruptedException
```
    Overwrites the contents of the config file.
    
    Parameters:
    
    contents - The new contents of the config file.
    
    synchronous - Wait until the change has been persisted before returning this map.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    IOException
    
    InterruptedException
    
    UnsupportedOperationException - If configuration is read only.
  - rollback
```
public Config rollback()
```
    Does a rollback of any changes on this config currently in memory.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    UnsupportedOperationException - If configuration is read only.
  - asMap
```
public ObjectMap asMap()
```
    Returns the values in this config map as a map of maps.
    This is considered a snapshot copy of the config map.
    The returned map is modifiable, but modifications to the returned map are not reflected in the config map.
    
    Overrides:
    
    asMap in class Context
    
    Returns:
    
    A copy of this config as a map of maps.
  - createSession
```
public Session createSession(SessionArgs args)
```
    Unused.
    
    Specified by:
    
    createSession in class Context
    
    Parameters:
    
    args - The session arguments.
    
    Returns:
    
    A new session object.
  - createDefaultSessionArgs
```
public SessionArgs createDefaultSessionArgs()
```
    Unused.
    
    Specified by:
    
    createDefaultSessionArgs in class Context
    
    Returns:
    
    A SessionArgs object, possibly a read-only reusable instance.
  - onConfigChange
```
public void onConfigChange(List<ConfigEvent> events)
```
    Description copied from interface: ConfigEventListener
    
    Gets called immediately after a config file has been loaded.
    
    Specified by:
    
    onConfigChange in interface ConfigEventListener
    
    Parameters:
    
    events - The change events.
  - getMediaType
```
public MediaType getMediaType()
```
    Description copied from interface: Writable
    
    Returns the serialized media type for this resource (e.g. "text/html")
    
    Specified by:
    
    getMediaType in interface Writable
    
    Returns:
    
    The media type, or null if the media type is not known.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Context
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable

Class Config

See Also:

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.Context

Methods inherited from class java.lang.Object

Field Detail

CONFIG_name

Property:

Description:

CONFIG_store

Property:

Description:

CONFIG_serializer

Property:

Description:

CONFIG_parser

Property:

Description:

CONFIG_encoder

Property:

Description:

CONFIG_varResolver

Property:

Description:

CONFIG_binaryLineLength

Property:

Description:

CONFIG_binaryFormat

Property:

Description:

CONFIG_multiLineValuesOnSeparateLines

Property:

Description:

CONFIG_readOnly

Property:

Description:

Constructor Detail

Config

Method Detail

create

create

builder

resolving

get

set

set

set

set

set

remove

encodeEntries

getString

getString

getStringArray

getStringArray

getInt

Example:

getInt

getBoolean

getBoolean

getLong

Example:

getLong

getDouble

getDouble

getFloat

getFloat

getBytes

getBytes

getObject

Examples:

Notes:

getObject

getObject

Examples:

getObject

getObjectWithDefault

getObjectWithDefault