rasmus_torkel.config

Class ConfigProcessor

java.lang.Object

rasmus_torkel.config.ConfigProcessor

Direct Known Subclasses:

ConfigFileReader

public class ConfigProcessor
extends java.lang.Object

This class performs all sorts of functionality for configuration except actually reading it.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,rasmus_torkel.config.ConfigParam>	_nameToParam
protected java.util.ArrayList<rasmus_torkel.config.ConfigParam>	_paramAl
protected static java.util.regex.Pattern	_paramPattern
PropertySourceDescription	_sourceDesc

Constructor Summary

Constructors

Constructor and Description
ConfigProcessor(PropertySourceDescription sourceDesc)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	evaluateExpression(java.lang.String expression, java.io.File file, int lineNr) Evaluates and expression to an actual value.
java.lang.String	getValue(java.lang.String name) If you really want, you can retrieve the value directly from this class instead of retrieving the properties first.
java.lang.String	makeAnnotatedConfigString() This method blends the functionality of makeConfigString() and makeTrace().
java.lang.String	makeConfigString() Makes a configuration string that encapsulates the final state of all properties.
java.util.Properties	makeProperties() Makes a properties object representing the configuration.
PropertiesView	makePropertiesView() Gives a representation of the configuration in the author's preferred format for actually extracting data out of it.
java.lang.String	makeTrace() Returns a string that describes all assignments to the properties including superseded ones.
protected boolean	tryParam(java.lang.String line, java.io.File file, int lineNr)

Methods inherited from class java.lang.Object

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

Field Detail

_paramAl

protected java.util.ArrayList<rasmus_torkel.config.ConfigParam> _paramAl

_nameToParam

protected java.util.HashMap<java.lang.String,rasmus_torkel.config.ConfigParam> _nameToParam

_sourceDesc

public final PropertySourceDescription _sourceDesc

_paramPattern

protected static final java.util.regex.Pattern _paramPattern

Constructor Detail

ConfigProcessor

public ConfigProcessor(PropertySourceDescription sourceDesc)

Method Detail

tryParam

protected boolean tryParam(java.lang.String line,
               java.io.File file,
               int lineNr)
                    throws ConfigSyntaxException

Throws:

ConfigSyntaxException

evaluateExpression

public java.lang.String evaluateExpression(java.lang.String expression,
                                  java.io.File file,
                                  int lineNr)
                                    throws ConfigSyntaxException

Evaluates and expression to an actual value.

Parameters:

expression - The expression to evaluate

file - The file the expression came from (used only for exceptions)

lineNr - The line number of the expression within the file (used only for exceptions)

Returns:

Throws:

ConfigSyntaxException

getValue

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

If you really want, you can retrieve the value directly from this class instead of retrieving the properties first. But this function was actually created for test purposes.

Parameters:

name -

Returns:

value of parameter. Null for non-existing parameter.

makeProperties

public java.util.Properties makeProperties()

Makes a properties object representing the configuration. However, unless you have some interface to satisfy that requires a simple properties object, consider using makePropertiesView() to get a more useful PropertiesView object.

Returns:

A simple properties object representing the configuration.

makePropertiesView

public PropertiesView makePropertiesView()

Gives a representation of the configuration in the author's preferred format for actually extracting data out of it.

Returns:

An object designed for easy extraction of the data.

makeConfigString

public java.lang.String makeConfigString()

Makes a configuration string that encapsulates the final state of all properties. If one were to write this string to a file, one would end up with a flat, fully evaluated configuration file, equivalent to the original configuration.

Returns:

The string encapsulating the configuration.

makeTrace

public java.lang.String makeTrace()

Returns a string that describes all assignments to the properties including superseded ones. This function is intended for debugging.

Returns:

The trace

makeAnnotatedConfigString

public java.lang.String makeAnnotatedConfigString()

This method blends the functionality of makeConfigString() and makeTrace(). If written to a file, the file would be a valid configuration file. Superseded assignments are included as comments. It is however not as easy to read as makeConfigString() and makeTrace().

Returns:

String version of properties