rescuecore2.config

Class Config

java.lang.Object

rescuecore2.config.Config

public class Config
extends java.lang.Object

This class represents a config file and any other config files that might have been included with a !include directive. Config files must be defined relative to a base directory so that includes can be resolved.

Constructor Summary

Constructors

Constructor and Description
Config() Create an empty config.
Config(Config other) Copy constructor.
Config(java.io.File file) Create a config that reads from a given file.

Method Summary

Modifier and Type	Method and Description
void	addConstraint(ConfigConstraint c) Add a constraint.
void	appendValue(java.lang.String key, java.lang.String value) Append a value to a key.
void	appendValue(java.lang.String key, java.lang.String value, java.lang.String separator) Append a value to a key.
java.util.Set<java.lang.String>	getAllKeys() Get all keys in this config.
java.util.List<java.lang.String>	getArrayValue(java.lang.String key) Get the value of a key as an array of strings.
java.util.List<java.lang.String>	getArrayValue(java.lang.String key, java.lang.String defaultValue) Get the value of a key (or a default value) as an array of strings.
boolean	getBooleanValue(java.lang.String key) Get the value of a key as a boolean.
boolean	getBooleanValue(java.lang.String key, boolean defaultValue) Get the value of a key as a boolean or use a default value.
double	getFloatValue(java.lang.String key) Get the value of a key as a floating point number.
double	getFloatValue(java.lang.String key, double defaultValue) Get the value of a key as a floating point number or use a default value.
int	getIntValue(java.lang.String key) Get the value of a key as an integer.
int	getIntValue(java.lang.String key, int defaultValue) Get the value of a key as an integer or use a default value.
java.util.Random	getRandom() Get the random number generator defined by this config.
java.lang.String	getValue(java.lang.String key) Get the value of a key as a String.
java.lang.String	getValue(java.lang.String key, java.lang.String defaultValue) Get the value of a key as a String or use a default value.
java.util.Set<ConfigConstraint>	getViolatedConstraints() Get all violated constraints.
boolean	isDefined(java.lang.String key) Find out if a key is defined.
void	merge(Config other) Merge all keys and values from another Config into this one.
void	read(java.io.File file) Read a config file and add its contents.
void	read(java.io.Reader reader, java.lang.String name) Read config information from a Reader and add its contents.
void	read(java.lang.String resource) Read a config file from a resource that this class' classloader can find.
void	removeAllKeys() Remove all keys.
void	removeConstraint(ConfigConstraint c) Remove a constraint.
void	removeExcept(java.util.Collection<java.lang.String> exceptions) Remove all except a set of keys.
void	removeExcept(java.lang.String... exceptions) Remove all except a set of keys.
void	removeExceptRegex(java.util.Collection<java.lang.String> exceptions) Remove all keys that do not match any of the given regular expressions.
void	removeKey(java.lang.String key) Remove a key from the config.
void	setBooleanValue(java.lang.String key, boolean value) Set the value of a key as a boolean.
void	setFloatValue(java.lang.String key, double value) Set the value of a key as a floating point number.
void	setIntValue(java.lang.String key, int value) Set the value of a key as an integer.
void	setValue(java.lang.String key, java.lang.String value) Set the value of a key.
void	write(java.io.PrintWriter out) Write this config to a PrintWriter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Config

public Config()

Create an empty config.

Config

public Config(java.io.File file)
       throws ConfigException

Create a config that reads from a given file. Additional config files can be read later with the read(String) method.

Parameters:

file - The config file to read. Must not be null.

Throws:

ConfigException - If there is an error parsing the config file or one of its descendants.

Config

public Config(Config other)

Copy constructor. The new Config will contain all keys and values that are currently in this config.

Parameters:

other - The Config to copy.

Method Detail

read

public void read(java.lang.String resource)
          throws ConfigException

Read a config file from a resource that this class' classloader can find.

Parameters:

resource - The name of the resource.

Throws:

ConfigException - If there is an error parsing the config file or one of its descendants.

read

public void read(java.io.File file)
          throws ConfigException

Read a config file and add its contents. Existing entries with the same name will be overwritten.

Parameters:

file - The config file to read. Must not be null. If this is a directory then all files in the directory tree will be read.

Throws:

ConfigException - If there is an error parsing the config file or one of its descendants.

read

public void read(java.io.Reader reader,
                 java.lang.String name)
          throws ConfigException

Read config information from a Reader and add its contents. Existing entries with the same name will be overwritten.

Parameters:

reader - The Reader to read from. Must not be null.

name - The name of the reader being read. This is used when reporting errors in the file.

Throws:

ConfigException - If there is an error parsing the config file or one of its descendants.

write

public void write(java.io.PrintWriter out)
           throws java.io.IOException

Write this config to a PrintWriter.

Parameters:

out - The PrintWriter to write to. Must not be null.

Throws:

java.io.IOException - If there is an error writing to the stream.

merge

public void merge(Config other)

Merge all keys and values from another Config into this one.

Parameters:

other - The Config to merge from.

addConstraint

public void addConstraint(ConfigConstraint c)

Add a constraint.

Parameters:

c - The constraint to add.

removeConstraint

public void removeConstraint(ConfigConstraint c)

Remove a constraint.

Parameters:

c - The constraint to remove.

getViolatedConstraints

public java.util.Set<ConfigConstraint> getViolatedConstraints()

Get all violated constraints.

Returns:

All violated constraints.

getAllKeys

public java.util.Set<java.lang.String> getAllKeys()

Get all keys in this config.

Returns:

An immutable view of all keys.

isDefined

public boolean isDefined(java.lang.String key)

Find out if a key is defined.

Parameters:

key - The key to test.

Returns:

True if the key has a non-null value.

getValue

public java.lang.String getValue(java.lang.String key)

Get the value of a key as a String.

Parameters:

key - The key to look up. Must not be null.

Returns:

The value associated with that key.

Throws:

NoSuchConfigOptionException - If the key is not defined.

getValue

public java.lang.String getValue(java.lang.String key,
                                 java.lang.String defaultValue)

Get the value of a key as a String or use a default value.

Parameters:

key - The key to look up. Must not be null.

defaultValue - The default value to return if the key has no defined value.

Returns:

The value associated with that key, or the default value of the key has no value.

getIntValue

public int getIntValue(java.lang.String key)

Get the value of a key as an integer.

Parameters:

key - The key to look up. Must not be null.

Returns:

The value associated with that key interpreted as an integer.

Throws:

NoSuchConfigOptionException - If the key is not defined.

java.lang.NumberFormatException - If the value of the key cannot be interpreted as an integer.

getIntValue

public int getIntValue(java.lang.String key,
                       int defaultValue)

Get the value of a key as an integer or use a default value.

Parameters:

key - The key to look up. Must not be null.

defaultValue - The default value to return if the key has no defined value.

Returns:

The value associated with that key interpreted as an integer, or the default value of the key has no value.

Throws:

java.lang.NumberFormatException - If the value of the key cannot be interpreted as an integer.

getFloatValue

public double getFloatValue(java.lang.String key)

Get the value of a key as a floating point number.

Parameters:

key - The key to look up. Must not be null.

Returns:

The value associated with that key interpreted as a floating point number.

Throws:

NoSuchConfigOptionException - If the key is not defined.

java.lang.NumberFormatException - If the value of the key cannot be interpreted as a floating point number.

getFloatValue

public double getFloatValue(java.lang.String key,
                            double defaultValue)

Get the value of a key as a floating point number or use a default value.

Parameters:

key - The key to look up. Must not be null.

defaultValue - The default value to return if the key has no defined value.

Returns:

The value associated with that key interpreted as a floating point number, or the default value of the key has no value.

Throws:

java.lang.NumberFormatException - If the value of the key cannot be interpreted as a floating point number.

getBooleanValue

public boolean getBooleanValue(java.lang.String key)

Get the value of a key as a boolean. "true", "t", "yes", "y" and "1" (case insensitive) are all interpreted as true, all other values are false.

Parameters:

key - The key to look up. Must not be null.

Returns:

The value associated with that key interpreted as a boolean.

Throws:

NoSuchConfigOptionException - If the key is not defined.

getBooleanValue

public boolean getBooleanValue(java.lang.String key,
                               boolean defaultValue)

Get the value of a key as a boolean or use a default value. "true", "t", "yes", "y" and "1" (case insensitive) are all interpreted as true, all other values are false.

Parameters:

key - The key to look up. Must not be null.

defaultValue - The default value to return if the key has no defined value.

Returns:

The value associated with that key interpreted as a boolean, or the default value of the key has no value.

getArrayValue

public java.util.List<java.lang.String> getArrayValue(java.lang.String key)

Get the value of a key as an array of strings. The value will be split on space and comma characters and the resulting list of tokens is returned.

Parameters:

key - The key to look up. Must not be null.

Returns:

The value associated with that key interpreted as an array of space-and-comma-separated tokens.

Throws:

NoSuchConfigOptionException - If the key is not defined.

getArrayValue

public java.util.List<java.lang.String> getArrayValue(java.lang.String key,
                                                      java.lang.String defaultValue)

Get the value of a key (or a default value) as an array of strings. The value will be split on space and comma characters and the resulting list of tokens is returned.

Parameters:

key - The key to look up. Must not be null.

defaultValue - The default value to use if the key is not defined. If this is null then null will be returned, otherwise it will be split according to the usual rules.

Returns:

The value associated with the key (or the default value) interpreted as an array of space or comma-separated tokens.

setValue

public void setValue(java.lang.String key,
                     java.lang.String value)

Set the value of a key.

Parameters:

key - The key to set. Must not be null.

value - The new value. If this is null then removeKey(String) is called with the given key.

appendValue

public void appendValue(java.lang.String key,
                        java.lang.String value)

Append a value to a key. If there is no value for the key then this is equivalent to setValue(String, String). This method calls appendValue(String, String, String) with a space character as the separator.

Parameters:

key - The key to append.

value - The value to append.

appendValue

public void appendValue(java.lang.String key,
                        java.lang.String value,
                        java.lang.String separator)

Append a value to a key. If there is no value for the key then this is equivalent to setValue(String, String).

Parameters:

key - The key to append.

value - The value to append.

separator - A string to add before the new value to separate it from the previous value.

setIntValue

public void setIntValue(java.lang.String key,
                        int value)

Set the value of a key as an integer.

Parameters:

key - The key to set. Must not be null.

value - The new value.

setFloatValue

public void setFloatValue(java.lang.String key,
                          double value)

Set the value of a key as a floating point number.

Parameters:

key - The key to set. Must not be null.

value - The new value.

setBooleanValue

public void setBooleanValue(java.lang.String key,
                            boolean value)

Set the value of a key as a boolean.

Parameters:

key - The key to set. Must not be null.

value - The new value.

removeKey

public void removeKey(java.lang.String key)

Remove a key from the config.

Parameters:

key - The key to remove. Must not be null.

removeAllKeys

public void removeAllKeys()

Remove all keys.

removeExcept

public void removeExcept(java.lang.String... exceptions)

Remove all except a set of keys.

Parameters:

exceptions - The keys to keep.

removeExcept

public void removeExcept(java.util.Collection<java.lang.String> exceptions)

Remove all except a set of keys.

Parameters:

exceptions - The keys to keep.

removeExceptRegex

public void removeExceptRegex(java.util.Collection<java.lang.String> exceptions)

Remove all keys that do not match any of the given regular expressions.

Parameters:

exceptions - The regular expressions describing keys to keep.

getRandom

public java.util.Random getRandom()

Get the random number generator defined by this config.

Returns:

The random number generator.