ConfigObject (Groovy 4.0.0)

groovy.util.ConfigObject

All Implemented Interfaces and Traits:

Writable, Map, Cloneable
```
public class ConfigObject
extends GroovyObjectSupport
implements Writable, Map, Cloneable
```
A ConfigObject at a simple level is a Map that creates configuration entries (other ConfigObjects) when referencing them. This means that navigating to foo.bar.stuff will not return null but nested ConfigObjects which are of course empty maps The Groovy truth can be used to check for the existence of "real" entries.
Since:
1.5

Constructor Summary

Constructors
Constructor and description
`ConfigObject(URL file)`
`ConfigObject()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`clear()`
	`public ConfigObject`	`clone()` Returns a shallow copy of this ConfigObject, keys and configuration entries are not cloned.
	`public boolean`	`containsKey(Object key)`
	`public boolean`	`containsValue(Object value)`
	`public Set`	`entrySet()`
	`public Map`	`flatten()` A ConfigObject is a tree structure consisting of nested maps.
	`public Map`	`flatten(Map target)` Flattens this ConfigObject populating the results into the target Map
	`public Object`	`get(Object key)`
	`public URL`	`getConfigFile()`
	`public Object`	`getProperty(String name)` Overrides the default getProperty implementation to create nested ConfigObject instances on demand for non-existent keys
	`public boolean`	`isEmpty()`
	`public Boolean`	`isSet(String option)` Checks if a config option is set.
	`public Set`	`keySet()`
	`public Map`	`merge(ConfigObject other)` Merges the given map with this ConfigObject overriding any matching configuration entries in this ConfigObject
	`public String`	`prettyPrint()`
	`public Object`	`put(Object key, Object value)`
	`public void`	`putAll(Map m)`
	`public Object`	`remove(Object key)`
	`public void`	`setConfigFile(URL configFile)`
	`public int`	`size()`
	`public Properties`	`toProperties()` Converts this ConfigObject into a the java.util.Properties format, flattening the tree structure beforehand
	`public Properties`	`toProperties(String prefix)` Converts this ConfigObject ino the java.util.Properties format, flatten the tree and prefixing all entries with the given prefix
	`public String`	`toString()`
	`public Collection`	`values()`
	`public Writer`	`writeTo(Writer outArg)` Writes this config object into a String serialized representation which can later be parsed back using the parse() method

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class GroovyObjectSupport`	`getMetaClass, setMetaClass`

- Constructor Detail
  - public ConfigObject(URL file)
  - public ConfigObject()
- Method Detail
  - @Override public void clear()
  - @Override public ConfigObject clone()
    
    Returns a shallow copy of this ConfigObject, keys and configuration entries are not cloned.
    Returns:
    a shallow copy of this ConfigObject
  - @Override public boolean containsKey(Object key)
  - @Override public boolean containsValue(Object value)
  - @Override public Set entrySet()
  - public Map flatten()
    
    A ConfigObject is a tree structure consisting of nested maps. This flattens the maps into a single level structure like a properties file
  - public Map flatten(Map target)
    
    Flattens this ConfigObject populating the results into the target Map
    See Also:
    ConfigObject.flatten
  - @Override public Object get(Object key)
  - public URL getConfigFile()
  - @Override public Object getProperty(String name)
    
    Overrides the default getProperty implementation to create nested ConfigObject instances on demand for non-existent keys
  - @Override public boolean isEmpty()
  - public Boolean isSet(String option)
    
    Checks if a config option is set. Example usage:
```
 def config = new ConfigSlurper().parse("foo { password='' }")
 assert config.foo.isSet('password')
 assert config.foo.isSet('username') == false
 
```
    The check works only for options one block below the current block. E.g. config.isSet('foo.password') will always return false.
    Parameters:
    option - The name of the option
    Returns:
    true if the option is set false otherwise
    Since:
    2.3.0
  @Override public Set keySet()
  
  public Map merge(ConfigObject other)
  
  Merges the given map with this ConfigObject overriding any matching configuration entries in this ConfigObject
  Parameters:
  other - The ConfigObject to merge with
  Returns:
  The result of the merge
  
  public String prettyPrint()
  
  @Override public Object put(Object key, Object value)
  
  @Override public void putAll(Map m)
  
  @Override public Object remove(Object key)
  
  public void setConfigFile(URL configFile)
  
  @Override public int size()
  
  public Properties toProperties()
  
  Converts this ConfigObject into a the java.util.Properties format, flattening the tree structure beforehand
  Returns:
  A java.util.Properties instance
  
  public Properties toProperties(String prefix)
  
  Converts this ConfigObject ino the java.util.Properties format, flatten the tree and prefixing all entries with the given prefix
  Parameters:
  prefix - The prefix to append before property entries
  Returns:
  A java.util.Properties instance
  
  @Override public String toString()
  
  @Override public Collection values()
  
  @Override public Writer writeTo(Writer outArg)
  
  Writes this config object into a String serialized representation which can later be parsed back using the parse() method
  See Also:
  Writable.writeTo

Overview

Package

Class

Deprecated

Index

Help

Frames

No Frames

Summary:
Nested   Field
Constructor

Method


| Detail:
Field
Constructor

Method


Copyright © 2003-2022 The Apache Software Foundation. All rights reserved.

[Java] Class ConfigObject

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public ConfigObject(URL file)

public ConfigObject()

Method Detail

@Override public void clear()

@Override public ConfigObject clone()

@Override public boolean containsKey(Object key)

@Override public boolean containsValue(Object value)

@Override public Set entrySet()

public Map flatten()

public Map flatten(Map target)

@Override public Object get(Object key)

public URL getConfigFile()

@Override public Object getProperty(String name)

@Override public boolean isEmpty()

public Boolean isSet(String option)

@Override public Set keySet()

public Map merge(ConfigObject other)

public String prettyPrint()

@Override public Object put(Object key, Object value)

@Override public void putAll(Map m)

@Override public Object remove(Object key)

public void setConfigFile(URL configFile)

@Override public int size()

public Properties toProperties()

public Properties toProperties(String prefix)

@Override public String toString()

@Override public Collection values()

@Override public Writer writeTo(Writer outArg)