class ConfigSlurper extends Object
ConfigSlurper is a utility class for reading configuration files defined in the form of Groovy scripts. Configuration settings can be defined using dot notation or scoped using closures:
grails.webflow.stateless = true
smtp {
mail.host = 'smtp.myisp.com'
mail.auth.user = 'server'
}
resources.URL = 'http://localhost:80/resources'
Settings can either be bound into nested maps or onto a specified JavaBean instance.
In the latter case, an error will be thrown if a property cannot be bound. Type | Name and description |
---|---|
GroovyClassLoader |
classLoader |
String |
environment |
Constructor and description |
---|
ConfigSlurper
() |
ConfigSlurper
(String env) Constructs a new ConfigSlurper instance using the given environment |
Type Params | Return Type | Name and description |
---|---|---|
|
Map<String, String> |
getConditionalBlockValues() |
|
String |
getEnvironment() |
|
ConfigObject |
parse(Properties properties) Parses a ConfigObject instances from an instance of java.util.Properties |
|
ConfigObject |
parse(String script) Parse the given script as a string and return the configuration object |
|
ConfigObject |
parse(Class scriptClass) Create a new instance of the given script class and parse a configuration object from it |
|
ConfigObject |
parse(Script script) Parse the given script into a configuration object (a Map) (This method creates a new class to parse the script each time it is called.) |
|
ConfigObject |
parse(URL scriptLocation) Parses a Script represented by the given URL into a ConfigObject |
|
ConfigObject |
parse(Script script, URL location) Parses the passed groovy.lang.Script instance using the second argument to allow the ConfigObject to retain an reference to the original location other Groovy script |
|
void |
registerConditionalBlock(String blockName, String blockValue) |
|
void |
setBinding(Map vars) Sets any additional variables that should be placed into the binding when evaluating Config scripts |
|
void |
setEnvironment(String environment) |
Constructs a new ConfigSlurper instance using the given environment
env
- The Environment to useParses a ConfigObject instances from an instance of java.util.Properties
The
- java.util.Properties instanceParse the given script as a string and return the configuration object
Create a new instance of the given script class and parse a configuration object from it
Parse the given script into a configuration object (a Map) (This method creates a new class to parse the script each time it is called.)
script
- The script to parseParses a Script represented by the given URL into a ConfigObject
scriptLocation
- The location of the script to parseParses the passed groovy.lang.Script instance using the second argument to allow the ConfigObject to retain an reference to the original location other Groovy script
script
- The groovy.lang.Script instancelocation
- The original location of the Script as a URLSets any additional variables that should be placed into the binding when evaluating Config scripts
Copyright © 2003-2020 The Apache Software Foundation. All rights reserved.