Configuration (Coopr Server 0.9.9 API)

java.lang.Object
- co.cask.coopr.common.conf.Configuration

All Implemented Interfaces:

Iterable<Map.Entry<String,String>>
```
public class Configuration
extends Object
implements Iterable<Map.Entry<String,String>>
```
Provides access to configuration parameters.
Resources

Configurations are specified by resources. A resource contains a set of name/value pairs as XML data. Each resource is named by a String. If named by a String, then the classpath is examined for a file with that name. If named by a Path, then the local filesystem is examined directly, without referring to the classpath.
Unless explicitly turned off, Hadoop by default specifies two resources, loaded in-order from the classpath:
1. core-default.xml: Read-only defaults for Hadoop
2. core-site.xml: Site-specific configuration for a given Hadoop installation
Applications may add additional resources, which are loaded subsequent to these resources in the order they are added.
Final Parameters

Configuration parameters may be declared final. Once a resource declares a value final, no subsequently-loaded resource can alter that value. For example, one might define a final parameter with:
```
 <property>
 <name>dfs.client.buffer.dir</name>
 <value>/tmp/hadoop/dfs/client</value>
 <final>true</final>
 </property>
```
Administrators typically define parameters as final in core-site.xml for values that user applications may not alter.
Variable Expansion

Value strings are first processed for variable expansion. The available properties are:
1. Other properties defined in this Configuration; and, if a name is undefined here,
2. Properties in System.getProperties().
For example, if a configuration resource contains the following property definitions:
```
 <property>
 <name>basedir</name>
 <value>/user/${user.name}</value>
 </property>

 <property>
 <name>tempdir</name>
 <value>${basedir}/tmp</value>
 </property>
```
When conf.get("tempdir") is called, then ${basedir} will be resolved to another property in this Configuration, while ${user.name} would then ordinarily be resolved to the value of the System property with that name.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Configuration.IntegerRanges
A class that represents a set of positive integer ranges.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Configuration.IntegerRanges` A class that represents a set of positive integer ranges.

Constructor Summary

Constructors
Constructor and Description

Configuration()
A new configuration.

Configuration(Configuration other)
A new configuration with the same settings cloned from another.

Constructors
Constructor and Description
`Configuration()` A new configuration.
`Configuration(Configuration other)` A new configuration with the same settings cloned from another.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addResource(InputStream in)` Add a configuration resource.
`void`	`addResource(String name)` Add a configuration resource.
`void`	`addResource(URL url)` Add a configuration resource.
`void`	`clear()` Clears all keys from the configuration.
`static Configuration`	`create()` Creates an instance of configuration with default and site values.
`static void`	`dumpConfiguration(Configuration config, Writer out)` Writes out all the parameters and their properties (final and resource) to the given `Writer` The format of the output would be { "properties" : [ {key1,value1,key1.isFinal,key1.resource}, {key2,value2, key2.isFinal,key2.resource}...
`String`	`get(String name)` Get the value of the `name` property, `null` if no such property exists.
`String`	`get(String name, String defaultValue)` Get the value of the `name`.
`boolean`	`getBoolean(String name)` Get the value of the `name` property as a `boolean`.
`boolean`	`getBoolean(String name, boolean defaultValue)` Get the value of the `name` property as a `boolean`.
`Class<?>`	`getClass(String name, Class<?> defaultValue)` Get the value of the `name` property as a `Class`.
`<U> Class<? extends U>`	`getClass(String name, Class<? extends U> defaultValue, Class<U> xface)` Get the value of the `name` property as a `Class` implementing the interface specified by `xface`.
`Class<?>`	`getClassByName(String name)` Load a class by name.
`Class<?>`	`getClassByNameOrNull(String name)` Load a class by name, returning null rather than throwing an exception if it couldn't be loaded.
`Class<?>[]`	`getClasses(String name, Class<?>... defaultValue)` Get the value of the `name` property as an array of `Class`.
`ClassLoader`	`getClassLoader()` Get the `ClassLoader` for this job.
`InputStream`	`getConfResourceAsInputStream(String name)` Get an input stream attached to the configuration resource with the given `name`.
`Reader`	`getConfResourceAsReader(String name)` Get a `Reader` attached to the configuration resource with the given `name`.
`<T extends Enum<T>> T`	`getEnum(String name, Class<T> declaringClass)` Return value matching this enumerated type.
`<T extends Enum<T>> T`	`getEnum(String name, T defaultValue)` Return value matching this enumerated type.
`File`	`getFile(String dirsProp, String path)` Get a local file name under a directory named in dirsProp with the given path.
`float`	`getFloat(String name)` Get the value of the `name` property as a `float`.
`float`	`getFloat(String name, float defaultValue)` Get the value of the `name` property as a `float`.
`<U> List<U>`	`getInstances(String name, Class<U> xface)` Get the value of the `name` property as a `List` of objects implementing the interface specified by `xface`.
`int`	`getInt(String name)` Get the value of the `name` configuration property as an `int`.
`int`	`getInt(String name, int defaultValue)` Get the value of the `name` property as an `int`.
`long`	`getLong(String name)` Get the value of the `name` configuration property as a `long`.
`long`	`getLong(String name, long defaultValue)` Get the value of the `name` property as a `long`.
`long`	`getLongBytes(String name)` Get the value of the `name` property as a `long` or human readable format.
`long`	`getLongBytes(String name, long defaultValue)` Get the value of the `name` property as a `long` or human readable format.
`Pattern`	`getPattern(String name)` Get the value of the `name` property as a `Pattern`.
`Pattern`	`getPattern(String name, Pattern defaultValue)` Get the value of the `name` property as a `Pattern`.
`protected Properties`	`getProps()`
`Configuration.IntegerRanges`	`getRange(String name)` Parse the given attribute as a set of integer ranges.
`Configuration.IntegerRanges`	`getRange(String name, String defaultValue)` Parse the given attribute as a set of integer ranges.
`String`	`getRaw(String name)` Get the value of the `name` property, without doing variable expansion.If the key is deprecated, it returns the value of the first key which replaces the deprecated key and is not null.
`URL`	`getResource(String name)` Get the `URL` for the named resource.
`Collection<String>`	`getStringCollection(String name)` Get the comma delimited values of the `name` property as a collection of `String`s.
`String[]`	`getStrings(String name)` Get the comma delimited values of the `name` property as an array of `String`s.
`String[]`	`getStrings(String name, String... defaultValue)` Get the comma delimited values of the `name` property as an array of `String`s.
`String`	`getTrimmed(String name)` Get the value of the `name` property as a trimmed `String`, `null` if no such property exists.
`Collection<String>`	`getTrimmedStringCollection(String name)` Get the comma delimited values of the `name` property as a collection of `String`s, trimmed of the leading and trailing whitespace.
`String[]`	`getTrimmedStrings(String name)` Get the comma delimited values of the `name` property as an array of `String`s, trimmed of the leading and trailing whitespace.
`String[]`	`getTrimmedStrings(String name, String... defaultValue)` Get the comma delimited values of the `name` property as an array of `String`s, trimmed of the leading and trailing whitespace.
`Map<String,String>`	`getValByRegex(String regex)` get keys matching the the regex.
`static boolean`	`isDeprecated(String key)` checks whether the given `key` is deprecated.
`Iterator<Map.Entry<String,String>>`	`iterator()`
`static void`	`main(String[] args)` For debugging.
`void`	`reloadConfiguration()` Reload configuration from previously added resources.
`void`	`set(String name, String value)` Set the `value` of the `name` property.
`void`	`setBoolean(String name, boolean value)` Set the value of the `name` property to a `boolean`.
`void`	`setBooleanIfUnset(String name, boolean value)` Set the given property, if it is currently unset.
`void`	`setClass(String name, Class<?> theClass, Class<?> xface)` Set the value of the `name` property to the name of a `theClass` implementing the given interface `xface`.
`void`	`setClassLoader(ClassLoader classLoader)` Set the class loader that will be used to load the various objects.
`<T extends Enum<T>> void`	`setEnum(String name, T value)` Set the value of the `name` property to the given type.
`void`	`setFloat(String name, float value)` Set the value of the `name` property to a `float`.
`void`	`setIfUnset(String name, String value)` Sets a property if it is currently unset.
`void`	`setInt(String name, int value)` Set the value of the `name` property to an `int`.
`void`	`setLong(String name, long value)` Set the value of the `name` property to a `long`.
`void`	`setPattern(String name, Pattern pattern)` Set the given property to `Pattern`.
`void`	`setQuietMode(boolean quietmode)` Set the quietness-mode.
`void`	`setStrings(String name, String... values)` Set the array of string values for the `name` property as as comma delimited values.
`int`	`size()` Return the number of keys in the configuration.
`String`	`toString()`
`void`	`unset(String name)` Unset a previously set property.
`void`	`writeXml(OutputStream out)` Write out the non-default properties in this configuration to the given `OutputStream`.
`void`	`writeXml(Writer out)` Write out the non-default properties in this configuration to the given `Writer`.

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

- Constructor Detail
 - Configuration
```
public Configuration()
```
 A new configuration.
 - Configuration
```
public Configuration(Configuration other)
```
 A new configuration with the same settings cloned from another.
 
 Parameters:
 other - the configuration from which to clone settings.
- Method Detail
 - isDeprecated
```
public static boolean isDeprecated(String key)
```
 checks whether the given key is deprecated.
 
 Parameters:
 key - the parameter which is to be checked for deprecation
 
 Returns:
 true if the key is deprecated and false otherwise.
 - create
```
public static Configuration create()
```
 Creates an instance of configuration with default and site values.
 
 Returns:
 an instance of Configuration.
 - addResource
```
public void addResource(String name)
```
 Add a configuration resource. The properties of this resource will override properties of previously added resources, unless they were marked final.
 
 Parameters:
 name - resource to be added, the classpath is examined for a file with that name.
 - addResource
```
public void addResource(URL url)
```
 Add a configuration resource. The properties of this resource will override properties of previously added resources, unless they were marked final.
 
 Parameters:
 url - url of the resource to be added, the local filesystem is examined directly to find the resource, without referring to the classpath.
 - addResource
```
public void addResource(InputStream in)
```
 Add a configuration resource. The properties of this resource will override properties of previously added resources, unless they were marked final.
 
 Parameters:
 in - InputStream to deserialize the object from.
 - reloadConfiguration
```
public void reloadConfiguration()
```
 Reload configuration from previously added resources. This method will clear all the configuration read from the added resources, and final parameters. This will make the resources to be read again before accessing the values. Values that are added via set methods will overlay values read from the resources.
 - get
```
public String get(String name)
```
 Get the value of the name property, null if no such property exists. If the key is deprecated, it returns the value of the first key which replaces the deprecated key and is not null Values are processed for variable expansion before being returned.
 
 Parameters:
 name - the property name.
 
 Returns:
 the value of the name or its replacing property, or null if no such property exists.
 - getTrimmed
```
public String getTrimmed(String name)
```
 Get the value of the name property as a trimmed String, null if no such property exists. If the key is deprecated, it returns the value of the first key which replaces the deprecated key and is not null Values are processed for variable expansion before being returned.
 
 Parameters:
 name - the property name.
 
 Returns:
 the value of the name or its replacing property, or null if no such property exists.
 - getRaw
```
public String getRaw(String name)
```
 Get the value of the name property, without doing variable expansion.If the key is deprecated, it returns the value of the first key which replaces the deprecated key and is not null.
 
 Parameters:
 name - the property name.
 
 Returns:
 the value of the name property or its replacing property and null if no such property exists.
 - set
```
public void set(String name,
 String value)
```
 Set the value of the name property. If name is deprecated or there is a deprecated name associated to it, it sets the value to both names.
 
 Parameters:
 name - property name.
 value - property value.
 - unset
```
public void unset(String name)
```
 Unset a previously set property.
 - setIfUnset
```
public void setIfUnset(String name,
 String value)
```
 Sets a property if it is currently unset.
 
 Parameters:
 name - the property name
 value - the new value
 - get
```
public String get(String name,
 String defaultValue)
```
 Get the value of the name. If the key is deprecated, it returns the value of the first key which replaces the deprecated key and is not null. If no such property exists, then defaultValue is returned.
 
 Parameters:
 name - property name.
 defaultValue - default value.
 
 Returns:
 property value, or defaultValue if the property doesn't exist.
 - getInt
```
public int getInt(String name)
```
 Get the value of the name configuration property as an int. If the property is missing from the configuration or is not a valid int, then an exception is thrown.
 
 Parameters:
 name - the configuration property name
 
 Returns:
 the configuration property value as an int
 
 Throws:
 
 NumberFormatException - if the configured value is not a valid int
 
 NullPointerException - if the configuration property is not present in the loaded config
 - getInt
```
public int getInt(String name,
 int defaultValue)
```
 Get the value of the name property as an int. If no such property exists, the provided default value is returned, or if the specified value is not a valid int, then an error is thrown.
 
 Parameters:
 name - property name.
 defaultValue - default value.
 
 Returns:
 property value as an int, or defaultValue.
 
 Throws:
 
 NumberFormatException - when the value is invalid
 - setInt
```
public void setInt(String name,
 int value)
```
 Set the value of the name property to an int.
 
 Parameters:
 name - property name.
 value - int value of the property.
 - getLong
```
public long getLong(String name)
```
 Get the value of the name configuration property as a long. If the config property does does not exist or is not a valid long, then an exception is thrown.
 
 Parameters:
 name - the configuration property name
 
 Returns:
 the configuration property value as a long
 
 Throws:
 
 NumberFormatException - if the configured value is not a valid long
 
 NullPointerException - if the configuration property is not present in the loaded config
 - getLong
```
public long getLong(String name,
 long defaultValue)
```
 Get the value of the name property as a long. If no such property exists, the provided default value is returned, or if the specified value is not a valid long, then an error is thrown.
 
 Parameters:
 name - property name.
 defaultValue - default value.
 
 Returns:
 property value as a long, or defaultValue.
 
 Throws:
 
 NumberFormatException - when the value is invalid
 - getLongBytes
```
public long getLongBytes(String name)
```
 Get the value of the name property as a long or human readable format. If no such property exists or if the specified value is not a valid long or human readable format, then an error is thrown. You can use the following suffix (case insensitive): k(kilo), m(mega), g(giga), t(tera), p(peta), e(exa)
 
 Parameters:
 name - property name.
 
 Returns:
 property value as a long
 
 Throws:
 
 NumberFormatException - when the value is invalid
 
 NullPointerException - if the configuration property does not exist
 - getLongBytes
```
public long getLongBytes(String name,
 long defaultValue)
```
 Get the value of the name property as a long or human readable format. If no such property exists, the provided default value is returned, or if the specified value is not a valid long or human readable format, then an error is thrown. You can use the following suffix (case insensitive): k(kilo), m(mega), g(giga), t(tera), p(peta), e(exa)
 
 Parameters:
 name - property name.
 defaultValue - default value.
 
 Returns:
 property value as a long, or defaultValue.
 
 Throws:
 
 NumberFormatException - when the value is invalid
 - setLong
```
public void setLong(String name,
 long value)
```
 Set the value of the name property to a long.
 
 Parameters:
 name - property name.
 value - long value of the property.
 - getFloat
```
public float getFloat(String name)
```
 Get the value of the name property as a float. If no such property exists or if the specified value is not a valid float, then an error is thrown.
 
 Parameters:
 name - property name.
 
 Returns:
 property value as a float
 
 Throws:
 
 NumberFormatException - when the value is invalid
 
 NullPointerException - if the configuration property does not exist
 - getFloat
```
public float getFloat(String name,
 float defaultValue)
```
 Get the value of the name property as a float. If no such property exists, the provided default value is returned, or if the specified value is not a valid float, then an error is thrown.
 
 Parameters:
 name - property name.
 defaultValue - default value.
 
 Returns:
 property value as a float, or defaultValue.
 
 Throws:
 
 NumberFormatException - when the value is invalid
 - setFloat
```
public void setFloat(String name,
 float value)
```
 Set the value of the name property to a float.
 
 Parameters:
 name - property name.
 value - property value.
 - getBoolean
```
public boolean getBoolean(String name)
```
 Get the value of the name property as a boolean. If no such property is specified, or if the specified value is not a valid boolean, then an exception is thrown.
 
 Parameters:
 name - property name.
 
 Returns:
 property value as a boolean
 
 Throws:
 
 NullPointerException - if the configuration property does not exist
 
 IllegalArgumentException - if the configured value is not a valid boolean
 - getBoolean
```
public boolean getBoolean(String name,
 boolean defaultValue)
```
 Get the value of the name property as a boolean. If no such property is specified, or if the specified value is not a valid boolean, then defaultValue is returned.
 
 Parameters:
 name - property name.
 defaultValue - default value.
 
 Returns:
 property value as a boolean, or defaultValue.
 - setBoolean
```
public void setBoolean(String name,
 boolean value)
```
 Set the value of the name property to a boolean.
 
 Parameters:
 name - property name.
 value - boolean value of the property.
 - setBooleanIfUnset
```
public void setBooleanIfUnset(String name,
 boolean value)
```
 Set the given property, if it is currently unset.
 
 Parameters:
 name - property name
 value - new value
 - setEnum
```
public <T extends Enum<T>> void setEnum(String name,
 T value)
```
 Set the value of the name property to the given type. This is equivalent to set(<name>, value.toString()).
 
 Parameters:
 name - property name
 value - new value
 - getEnum
```
public <T extends Enum<T>> T getEnum(String name,
 Class<T> declaringClass)
```
 Return value matching this enumerated type.
 
 Parameters:
 name - Property name
 
 Throws:
 
 NullPointerException - if the configuration property does not exist
 
 IllegalArgumentException - If mapping is illegal for the type provided
 - getEnum
```
public <T extends Enum<T>> T getEnum(String name,
 T defaultValue)
```
 Return value matching this enumerated type.
 
 Parameters:
 name - Property name
 defaultValue - Value returned if no mapping exists
 
 Throws:
 
 IllegalArgumentException - If mapping is illegal for the type provided
 - getPattern
```
public Pattern getPattern(String name)
```
 Get the value of the name property as a Pattern. If no such property is specified, or if the specified value is not a valid Pattern, then an exception is thrown.
 
 Parameters:
 name - property name
 
 Returns:
 property value as a compiled Pattern
 
 Throws:
 
 NullPointerException - if the configuration property does not exist
 
 PatternSyntaxException - if the configured value is not a valid Pattern
 - getPattern
```
public Pattern getPattern(String name,
 Pattern defaultValue)
```
 Get the value of the name property as a Pattern. If no such property is specified, or if the specified value is not a valid Pattern, then DefaultValue is returned.
 
 Parameters:
 name - property name
 defaultValue - default value
 
 Returns:
 property value as a compiled Pattern, or defaultValue
 - setPattern
```
public void setPattern(String name,
 Pattern pattern)
```
 Set the given property to Pattern. If the pattern is passed as null, sets the empty pattern which results in further calls to getPattern(...) returning the default value.
 
 Parameters:
 name - property name
 pattern - new value
 - getRange
```
public Configuration.IntegerRanges getRange(String name)
```
 Parse the given attribute as a set of integer ranges.
 
 Parameters:
 name - the attribute name
 
 Returns:
 a new set of ranges from the configured value
 
 Throws:
 
 NullPointerException - if the configuration property does not exist
 - getRange
```
public Configuration.IntegerRanges getRange(String name,
 String defaultValue)
```
 Parse the given attribute as a set of integer ranges.
 
 Parameters:
 name - the attribute name
 defaultValue - the default value if it is not set
 
 Returns:
 a new set of ranges from the configured value
 - getStringCollection
```
public Collection<String> getStringCollection(String name)
```
 Get the comma delimited values of the name property as a collection of Strings. If no such property is specified then empty collection is returned.
 This is an optimized version of getStrings(String)
 
 Parameters:
 name - property name.
 
 Returns:
 property value as a collection of Strings.
 - getStrings
```
public String[] getStrings(String name)
```
 Get the comma delimited values of the name property as an array of Strings. If no such property is specified then null is returned.
 
 Parameters:
 name - property name.
 
 Returns:
 property value as an array of Strings, or null.
 - getStrings
```
public String[] getStrings(String name,
 String... defaultValue)
```
 Get the comma delimited values of the name property as an array of Strings. If no such property is specified then default value is returned.
 
 Parameters:
 name - property name.
 defaultValue - The default value
 
 Returns:
 property value as an array of Strings, or default value.
 - getTrimmedStringCollection
```
public Collection<String> getTrimmedStringCollection(String name)
```
 Get the comma delimited values of the name property as a collection of Strings, trimmed of the leading and trailing whitespace. If no such property is specified then empty Collection is returned.
 
 Parameters:
 name - property name.
 
 Returns:
 property value as a collection of Strings, or empty Collection
 - getTrimmedStrings
```
public String[] getTrimmedStrings(String name)
```
 Get the comma delimited values of the name property as an array of Strings, trimmed of the leading and trailing whitespace. If no such property is specified then an empty array is returned.
 
 Parameters:
 name - property name.
 
 Returns:
 property value as an array of trimmed Strings, or empty array.
 - getTrimmedStrings
```
public String[] getTrimmedStrings(String name,
 String... defaultValue)
```
 Get the comma delimited values of the name property as an array of Strings, trimmed of the leading and trailing whitespace. If no such property is specified then default value is returned.
 
 Parameters:
 name - property name.
 defaultValue - The default value
 
 Returns:
 property value as an array of trimmed Strings, or default value.
 - setStrings
```
public void setStrings(String name,
 String... values)
```
 Set the array of string values for the name property as as comma delimited values.
 
 Parameters:
 name - property name.
 values - The values
 - getClassByName
```
public Class<?> getClassByName(String name)
 throws ClassNotFoundException
```
 Load a class by name.
 
 Parameters:
 name - the class name.
 
 Returns:
 the class object.
 
 Throws:
 
 ClassNotFoundException - if the class is not found.
 - getClassByNameOrNull
```
public Class<?> getClassByNameOrNull(String name)
```
 Load a class by name, returning null rather than throwing an exception if it couldn't be loaded. This is to avoid the overhead of creating an exception.
 
 Parameters:
 name - the class name
 
 Returns:
 the class object, or null if it could not be found.
 - getClasses
```
public Class<?>[] getClasses(String name,
 Class<?>... defaultValue)
```
 Get the value of the name property as an array of Class. The value of the property specifies a list of comma separated class names. If no such property is specified, then defaultValue is returned.
 
 Parameters:
 name - the property name.
 defaultValue - default value.
 
 Returns:
 property value as a Class[], or defaultValue.
 - getClass
```
public Class<?> getClass(String name,
 Class<?> defaultValue)
```
 Get the value of the name property as a Class. If no such property is specified, then defaultValue is returned.
 
 Parameters:
 name - the class name.
 defaultValue - default value.
 
 Returns:
 property value as a Class, or defaultValue.
 - getClass
```
public  Class<? extends U> getClass(String name,
 Class<? extends U> defaultValue,
 Class xface)
```
 Get the value of the name property as a Class implementing the interface specified by xface. If no such property is specified, then defaultValue is returned. An exception is thrown if the returned class does not implement the named interface.
 
 Parameters:
 name - the class name.
 defaultValue - default value.
 xface - the interface implemented by the named class.
 
 Returns:
 property value as a Class, or defaultValue.
 - getInstances
```
public  List getInstances(String name,
 Class xface)
```
 Get the value of the name property as a List of objects implementing the interface specified by xface. An exception is thrown if any of the classes does not exist, or if it does not implement the named interface.
 
 Parameters:
 name - the property name.
 xface - the interface implemented by the classes named by name.
 
 Returns:
 a List of objects implementing xface.
 - setClass
```
public void setClass(String name,
 Class<?> theClass,
 Class<?> xface)
```
 Set the value of the name property to the name of a theClass implementing the given interface xface. An exception is thrown if theClass does not implement the interface xface.
 
 Parameters:
 name - property name.
 theClass - property value.
 xface - the interface implemented by the named class.
 - getFile
```
public File getFile(String dirsProp,
 String path)
 throws IOException
```
 Get a local file name under a directory named in dirsProp with the given path. If dirsProp contains multiple directories, then one is chosen based on path's hash code. If the selected directory does not exist, an attempt is made to create it.
 
 Parameters:
 dirsProp - directory in which to locate the file.
 path - file-path.
 
 Returns:
 local file under the directory with the given path.
 
 Throws:
 
 IOException
 - getResource
```
public URL getResource(String name)
```
 Get the URL for the named resource.
 
 Parameters:
 name - resource name.
 
 Returns:
 the url for the named resource.
 - getConfResourceAsInputStream
```
public InputStream getConfResourceAsInputStream(String name)
```
 Get an input stream attached to the configuration resource with the given name.
 
 Parameters:
 name - configuration resource name.
 
 Returns:
 an input stream attached to the resource.
 - getConfResourceAsReader
```
public Reader getConfResourceAsReader(String name)
```
 Get a Reader attached to the configuration resource with the given name.
 
 Parameters:
 name - configuration resource name.
 
 Returns:
 a reader attached to the resource.
 - getProps
```
protected Properties getProps()
```
 - size
```
public int size()
```
 Return the number of keys in the configuration.
 
 Returns:
 number of keys in the configuration.
 - clear
```
public void clear()
```
 Clears all keys from the configuration.
 - writeXml
```
public void writeXml(OutputStream out)
 throws IOException
```
 Write out the non-default properties in this configuration to the given OutputStream.
 
 Parameters:
 out - the output stream to write to.
 
 Throws:
 
 IOException
 - writeXml
```
public void writeXml(Writer out)
 throws IOException
```
 Write out the non-default properties in this configuration to the given Writer.
 
 Parameters:
 out - the writer to write to.
 
 Throws:
 
 IOException
 - dumpConfiguration
```
public static void dumpConfiguration(Configuration config,
 Writer out)
 throws IOException
```
 Writes out all the parameters and their properties (final and resource) to the given Writer The format of the output would be { "properties" : [ {key1,value1,key1.isFinal,key1.resource}, {key2,value2, key2.isFinal,key2.resource}... ] } It does not output the parameters of the configuration object which is loaded from an input stream.
 
 Parameters:
 out - the Writer to write to
 
 Throws:
 
 IOException
 - getClassLoader
```
public ClassLoader getClassLoader()
```
 Get the ClassLoader for this job.
 
 Returns:
 the correct class loader.
 - setClassLoader
```
public void setClassLoader(ClassLoader classLoader)
```
 Set the class loader that will be used to load the various objects.
 
 Parameters:
 classLoader - the new class loader.
 - toString
```
public String toString()
```
 Overrides:
 
 toString in class Object
 - setQuietMode
```
public void setQuietMode(boolean quietmode)
```
 Set the quietness-mode. In the quiet-mode, error and informational messages might not be logged.
 
 Parameters:
 quietmode - true to set quiet-mode on, false to turn it off.
 - main
```
public static void main(String[] args)
 throws Exception
```
 For debugging. List non-default properties to the terminal and exit.
 
 Throws:
 
 Exception
 - getValByRegex
```
public Map<String,String> getValByRegex(String regex)
```
 get keys matching the the regex.
 
 Parameters:
 regex -
 
 Returns:
 Map with matching keys
 - iterator
```
public Iterator<Map.Entry<String,String>> iterator()
```
 Specified by:
 
 iterator in interface Iterable<Map.Entry<String,String>>

Class Configuration

Resources

Final Parameters

Variable Expansion

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Configuration

Configuration

Method Detail

isDeprecated

create

addResource

addResource

addResource

reloadConfiguration

get

getTrimmed

getRaw

set

unset

setIfUnset

get

getInt

getInt

setInt

getLong

getLong

getLongBytes

getLongBytes

setLong

getFloat

getFloat

setFloat

getBoolean

getBoolean

setBoolean

setBooleanIfUnset

setEnum

getEnum

getEnum

getPattern

getPattern

setPattern

getRange

getRange

getStringCollection

getStrings

getStrings

getTrimmedStringCollection

getTrimmedStrings

getTrimmedStrings

setStrings

getClassByName

getClassByNameOrNull

getClasses

getClass

getClass

getInstances

setClass

getFile

getResource

getConfResourceAsInputStream

getConfResourceAsReader

getProps

size

clear

writeXml

writeXml

dumpConfiguration

getClassLoader

setClassLoader

toString

setQuietMode

main

getValByRegex

iterator