org.powertac.common.config

Class Configurator

java.lang.Object

org.powertac.common.config.Configurator

public class Configurator
extends Object

Fills in configured values from configuration source based on annotations in the source code.

Configuration clauses are assumed to be of the form
pkg.class[.instance].property = value
where pkg is the package name without org.powertac (or the full classname for classes outside the org.powertac hierarchy), class is the classname (but the first character is lowercase), instance is an optional instance name, and property is the property name. The target property must be annotated with

Author:

John Collins

Constructor Summary

Constructors

Constructor and Description
Configurator()

Method Summary

Modifier and Type	Method and Description
Collection<?>	configureInstances(Class<?> type) Creates and configures instances of the given class.
Collection<?>	configureNamedInstances(List<?> instances) Configures a set of instances of some class.
void	configureSingleton(Object thing) Configures the given thing, using the pre-loaded Configuration.
void	gatherBootstrapList(List<Object> things, ConfigurationRecorder recorder) Pulls "bootstrapState" ConfigurationValues out of objects in the given list, adds them to config with their names.
void	gatherBootstrapState(Object thing, ConfigurationRecorder recorder) Pulls the "bootstrapState" ConfigurableValues out of object thing, adds them to config.
void	gatherPublishedConfiguration(Object thing, ConfigurationRecorder recorder) Pulls the "published" ConfigurableValues out of object thing, adds them to config.
void	setConfiguration(org.apache.commons.configuration.Configuration config) Loads a Configuration into this Configurator.

Methods inherited from class java.lang.Object

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

Constructor Detail

Configurator

public Configurator()

Method Detail

setConfiguration

public void setConfiguration(org.apache.commons.configuration.Configuration config)

Loads a Configuration into this Configurator.

configureSingleton

public void configureSingleton(Object thing)

Configures the given thing, using the pre-loaded Configuration.

configureInstances

public Collection<?> configureInstances(Class<?> type)

Creates and configures instances of the given class. In the configuration, we expect to see a property of the form pkg.class.instances = a, b, c, ... where a, b, c, etc. are the names of instances of the class to be created and configured. These names are provided to the instances through their constructors, and are expected to show up in the configuration as instance names in clauses of the form pkg.class.name.property = value. Returns null in case instances cannot be created.

configureNamedInstances

public Collection<?> configureNamedInstances(List<?> instances)

Configures a set of instances of some class. In the configuration, we expect to see properties of the form pkg.class.name.property = value where name is the name of an instance in the list to be configured. These name must be accessible through a getName() method on each instance. It is an error if instances are not of the same class; in fact, the class of the first instance in the list is used to form the pkg.class. It also does not work for types that lack a getName() method returning a String, or if the name does not match the name in the properties. portion of the property names.

gatherPublishedConfiguration

public void gatherPublishedConfiguration(Object thing,
                                         ConfigurationRecorder recorder)

Pulls the "published" ConfigurableValues out of object thing, adds them to config.

gatherBootstrapState

public void gatherBootstrapState(Object thing,
                                 ConfigurationRecorder recorder)

Pulls the "bootstrapState" ConfigurableValues out of object thing, adds them to config.

gatherBootstrapList

public void gatherBootstrapList(List<Object> things,
                                ConfigurationRecorder recorder)

Pulls "bootstrapState" ConfigurationValues out of objects in the given list, adds them to config with their names. This requires that the instances in the list each have a getName() method that returns a String. Any instance lacking such a method will not be recorded, and an error message logged.