Top Description Fields Constructors Methods
groovy.util

public Class ConfigObject

extends GroovyObjectSupport
implements Writable, Map, Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable, java.util.Map, groovy.lang.Writable
Imports
groovy.lang.GroovyObjectSupport, .GroovyRuntimeException, .Writable, org.apache.groovy.io.StringBuilderWriter, org.codehaus.groovy.runtime.DefaultGroovyMethods, .InvokerHelper, .StringGroovyMethods, org.codehaus.groovy.syntax.Types, java.io.BufferedWriter, .IOException, .Writer, java.net.URL, java.util.Collection, .HashMap, .LinkedHashMap, .Map, .Properties, .Set
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

Field Summary

Modifier and TypeField and Description
private URL
configFile

The config file that was used when parsing this ConfigObject

private HashMap<K, V>
delegateMap

pack-priv static final Collection<String>
KEYWORDS

pack-priv static final String
TAB_CHARACTER

Constructor Summary

AccessConstructor and Description
public
ConfigObject(URL file)

public
ConfigObject()

Method Summary

Modifier and TypeMethod and Description
public void
clear()

Implements java.util.Map.clear.

Removes all of the mappings from this map (optional operation).
public ConfigObject

Returns:

a shallow copy of this ConfigObject
clone()

Overrides java.lang.Object.clone.

Returns a shallow copy of this ConfigObject, keys and configuration entries are not cloned.
public boolean
containsKey(Object
key whose presence in this map is to be tested
key)

Implements java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key.
public boolean
containsValue(Object
value whose presence in this map is to be tested
value)

Implements java.util.Map.containsValue.

Returns true if this map maps one or more keys to the specified value.
private static Properties
convertValuesToString(Map<K, V> props)

private Map<K, V>
doMerge(Map<K, V> config, Map<K, V> other)

public Set<E>
entrySet()

Implements java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map.
public Map<K, V>
flatten()

A ConfigObject is a tree structure consisting of nested maps.

public Map<K, V>
flatten(Map<K, V> target)

Flattens this ConfigObject populating the results into the target Map

public Object
get(Object
the key whose associated value is to be returned
key)

Implements java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
public URL
getConfigFile()

public Object
getProperty(String
the name of the property of interest
name)

Overrides default groovy.lang.GroovyObject.getProperty.

Overrides the default getProperty implementation to create nested ConfigObject instances on demand for non-existent keys
public boolean
isEmpty()

Implements java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.
public Boolean

Returns:

true if the option is set false otherwise
isSet(String
The name of the option
option)

Checks if a config option is set.</v>

public Set<E>
keySet()

Implements java.util.Map.keySet.

Returns a Set view of the keys contained in this map.
public Map<K, V>

Returns:

The result of the merge
merge(ConfigObject
The ConfigObject to merge with
other)

Merges the given map with this ConfigObject overriding any matching configuration entries in this ConfigObject

private void
populate(String suffix, Map<K, V> config, Map<K, V> map)

public String
prettyPrint()

public Object
put(Object
key with which the specified value is to be associated
key, Object
value to be associated with the specified key
value)

Implements java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation).
public void
putAll(Map<K, V>
mappings to be stored in this map
m)

Implements java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation).
public Object
remove(Object
key whose mapping is to be removed from the map
key)

Implements java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation).
public void
setConfigFile(URL configFile)

public int
size()

Implements java.util.Map.size.

Returns the number of key-value mappings in this map.
public Properties

Returns:

A java.util.Properties instance
toProperties()

Converts this ConfigObject into a the java.util.Properties format, flattening the tree structure beforehand

public Properties

Returns:

A java.util.Properties instance
toProperties(String
The prefix to append before property entries
prefix)

Converts this ConfigObject ino the java.util.Properties format, flatten the tree and prefixing all entries with the given prefix

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public Collection<E>
values()

Implements java.util.Map.values.

Returns a Collection view of the values contained in this map.
private void
writeConfig(String prefix, ConfigObject map, BufferedWriter out, int tab, boolean apply)

private void
writeNode(String key, String space, int tab, ConfigObject value, BufferedWriter out)

public Writer
writeTo(Writer
the Writer to which this Writable should output its data.
outArg)

Implements groovy.lang.Writable.writeTo.

Writes this config object into a String serialized representation which can later be parsed back using the parse() method
private static void
writeValue(String key, String space, String prefix, Object value, BufferedWriter out)

Inherited from groovy.lang.GroovyObjectSupport:
getMetaClasssetMetaClass

Field Detail

configFileback to summary
private URL configFile

The config file that was used when parsing this ConfigObject

delegateMapback to summary
private HashMap<K, V> delegateMap
KEYWORDSback to summary
pack-priv static final Collection<String> KEYWORDS
TAB_CHARACTERback to summary
pack-priv static final String TAB_CHARACTER

Constructor Detail

ConfigObjectback to summary
public ConfigObject(URL file)
ConfigObjectback to summary
public ConfigObject()

Method Detail

clearback to summary
public void clear()

Implements java.util.Map.clear.

Doc from java.util.Map.clear.

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

cloneback to summary
public ConfigObject clone()

Overrides java.lang.Object.clone.

Returns a shallow copy of this ConfigObject, keys and configuration entries are not cloned.

Returns:ConfigObject

a shallow copy of this ConfigObject

containsKeyback to summary
public boolean containsKey(Object key)

Implements java.util.Map.containsKey.

Doc from java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters
key:Object

key whose presence in this map is to be tested

Returns:boolean

true if this map contains a mapping for the specified key

containsValueback to summary
public boolean containsValue(Object value)

Implements java.util.Map.containsValue.

Doc from java.util.Map.containsValue.

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that Objects.equals(value, v). This operation will probably require time linear in the map size for most implementations of the Map interface.

Parameters
value:Object

value whose presence in this map is to be tested

Returns:boolean

true if this map maps one or more keys to the specified value

convertValuesToStringback to summary
private static Properties convertValuesToString(Map<K, V> props)
doMergeback to summary
private Map<K, V> doMerge(Map<K, V> config, Map<K, V> other)
entrySetback to summary
public Set<E> entrySet()

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Set<E>

a set view of the mappings contained in this map

flattenback to summary
public Map<K, V> flatten()

A ConfigObject is a tree structure consisting of nested maps. This flattens the maps into a single level structure like a properties file

flattenback to summary
public Map<K, V> flatten(Map<K, V> target)

Flattens this ConfigObject populating the results into the target Map

See Also
ConfigObject#flatten()
getback to summary
public Object get(Object key)

Implements java.util.Map.get.

Doc from java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters
key:Object

the key whose associated value is to be returned

Returns:Object

the value to which the specified key is mapped, or null if this map contains no mapping for the key

getConfigFileback to summary
public URL getConfigFile()
getPropertyback to summary
public Object getProperty(String name)

Overrides default groovy.lang.GroovyObject.getProperty.

Overrides the default getProperty implementation to create nested ConfigObject instances on demand for non-existent keys

Parameters
name:String

Doc from groovy.lang.GroovyObject.getProperty.

the name of the property of interest

Returns:Object

Doc from groovy.lang.GroovyObject.getProperty.

the given property

isEmptyback to summary
public boolean isEmpty()

Implements java.util.Map.isEmpty.

Doc from java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

Returns:boolean

true if this map contains no key-value mappings

isSetback to summary
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:String

The name of the option

Returns:Boolean

true if the option is set false otherwise

Since
2.3.0
keySetback to summary
public Set<E> keySet()

Implements java.util.Map.keySet.

Doc from java.util.Map.keySet.

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:Set<E>

a set view of the keys contained in this map

mergeback to summary
public Map<K, V> merge(ConfigObject other)

Merges the given map with this ConfigObject overriding any matching configuration entries in this ConfigObject

Parameters
other:ConfigObject

The ConfigObject to merge with

Returns:Map<K, V>

The result of the merge

populateback to summary
private void populate(String suffix, Map<K, V> config, Map<K, V> map)
prettyPrintback to summary
public String prettyPrint()
putback to summary
public Object put(Object key, Object value)

Implements java.util.Map.put.

Doc from java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters
key:Object

key with which the specified value is to be associated

value:Object

value to be associated with the specified key

Returns:Object

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

putAllback to summary
public void putAll(Map<K, V> m)

Implements java.util.Map.putAll.

Doc from java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order.

Parameters
m:Map<K, V>

mappings to be stored in this map

removeback to summary
public Object remove(Object key)

Implements java.util.Map.remove.

Doc from java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters
key:Object

key whose mapping is to be removed from the map

Returns:Object

the previous value associated with key, or null if there was no mapping for key.

setConfigFileback to summary
public void setConfigFile(URL configFile)
sizeback to summary
public int size()

Implements java.util.Map.size.

Doc from java.util.Map.size.

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of key-value mappings in this map

toPropertiesback to summary
public Properties toProperties()

Converts this ConfigObject into a the java.util.Properties format, flattening the tree structure beforehand

Returns:Properties

A java.util.Properties instance

toPropertiesback to summary
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:String

The prefix to append before property entries

Returns:Properties

A java.util.Properties instance

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
valuesback to summary
public Collection<E> values()

Implements java.util.Map.values.

Doc from java.util.Map.values.

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Collection<E>

a collection view of the values contained in this map

writeConfigback to summary
private void writeConfig(String prefix, ConfigObject map, BufferedWriter out, int tab, boolean apply) throws IOException
writeNodeback to summary
private void writeNode(String key, String space, int tab, ConfigObject value, BufferedWriter out) throws IOException
writeToback to summary
public Writer writeTo(Writer outArg) throws IOException

Implements groovy.lang.Writable.writeTo.

Writes this config object into a String serialized representation which can later be parsed back using the parse() method

Parameters
outArg:Writer

Doc from groovy.lang.Writable.writeTo.

the Writer to which this Writable should output its data.

Returns:Writer

Doc from groovy.lang.Writable.writeTo.

the Writer that was passed

Exceptions
IOException:

Doc from groovy.lang.Writable.writeTo.

if an error occurred while outputting data to the writer

See Also
groovy.lang.Writable#writeTo(java.io.Writer)
writeValueback to summary
private static void writeValue(String key, String space, String prefix, Object value, BufferedWriter out) throws IOException