Package groovy.util
Class ConfigObject
java.lang.Object
groovy.lang.GroovyObjectSupport
groovy.util.ConfigObject
- All Implemented Interfaces:
GroovyObject,Writable,Cloneable,Map
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
-
Nested Class Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()clone()Returns a shallow copy of this ConfigObject, keys and configuration entries are not cloned.booleancontainsKey(Object key) booleancontainsValue(Object value) entrySet()flatten()A ConfigObject is a tree structure consisting of nested maps.Flattens this ConfigObject populating the results into the target MapgetProperty(String name) Overrides the default getProperty implementation to create nested ConfigObject instances on demand for non-existent keysbooleanisEmpty()Checks if a config option is set.keySet()merge(ConfigObject other) Merges the given map with this ConfigObject overriding any matching configuration entries in this ConfigObjectvoidvoidsetConfigFile(URL configFile) intsize()Converts this ConfigObject into the java.util.Properties format, flattening the tree structure beforehandtoProperties(String prefix) Converts this ConfigObject ino the java.util.Properties format, flatten the tree and prefixing all entries with the given prefixtoString()values()Writes this config object into a String serialized representation which can later be parsed back using the parse() methodMethods inherited from class groovy.lang.GroovyObjectSupport
getMetaClass, setMetaClassMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface groovy.lang.GroovyObject
invokeMethod, setPropertyMethods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Constructor Details
-
ConfigObject
-
ConfigObject
public ConfigObject()
-
-
Method Details
-
getConfigFile
-
setConfigFile
-
writeTo
Writes this config object into a String serialized representation which can later be parsed back using the parse() method- Specified by:
writeToin interfaceWritable- Parameters:
outArg- the Writer to which this Writable should output its data.- Returns:
- the Writer that was passed
- Throws:
IOException- if an error occurred while outputting data to the writer- See Also:
-
getProperty
Overrides the default getProperty implementation to create nested ConfigObject instances on demand for non-existent keys- Specified by:
getPropertyin interfaceGroovyObject- Parameters:
name- the name of the property of interest- Returns:
- the given property
-
flatten
A ConfigObject is a tree structure consisting of nested maps. This flattens the maps into a single level structure like a properties file -
flatten
Flattens this ConfigObject populating the results into the target Map- See Also:
-
merge
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
-
toProperties
Converts this ConfigObject into the java.util.Properties format, flattening the tree structure beforehand- Returns:
- A java.util.Properties instance
-
toProperties
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
-
size
public int size() -
isEmpty
public boolean isEmpty() -
containsKey
- Specified by:
containsKeyin interfaceMap
-
containsValue
- Specified by:
containsValuein interfaceMap
-
get
-
put
-
remove
-
putAll
-
clear
public void clear() -
keySet
-
values
-
entrySet
-
clone
Returns a shallow copy of this ConfigObject, keys and configuration entries are not cloned. -
isSet
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') == falseThe 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:
trueif the option is setfalseotherwise- Since:
- 2.3.0
-
prettyPrint
-
toString
-