js.lang

Class ConfigBuilder

java.lang.Object

js.lang.ConfigBuilder

Direct Known Subclasses:

I18nRepository.ConfigBuilder

public class ConfigBuilder
extends Object

Configuration object builder. Create configuration object loaded from various sources.

Usage pattern is trivial: create configuration builder instance for desired configuration source and invoke build().

 ConfigBuilder builder = new ConfigBuilder(new File("conf/logs.xml"));
 Config config = builder.build();
 

Current builder implementation supports two main configuration sources: XML and Java properties.

Version:

final

Author:

Iulian Rotaru

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ConfigBuilder.Loader SAX handler for configuration object loading from XML source.

Field Summary

Fields

Modifier and Type	Field and Description
private Properties	properties Configuration properties.
private InputStream	xmlStream Configuration source XML stream.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigBuilder() Protected default constructor for sub-classing.
	ConfigBuilder(File xmlFile) Create configuration builder from XML file.
	ConfigBuilder(InputStream xmlStream) Create configuration builder from XML stream.
	ConfigBuilder(Properties properties) Create configuration builder from Java properties.
	ConfigBuilder(String xml) Create configuration builder from XML represented as string, merrely for tests.

Method Summary

Modifier and Type	Method and Description
Config	build() Build configuration object.

Methods inherited from class java.lang.Object

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

Field Detail

xmlStream

private InputStream xmlStream

Configuration source XML stream.

properties

private Properties properties

Configuration properties.

Constructor Detail

ConfigBuilder

public ConfigBuilder(String xml)

Create configuration builder from XML represented as string, merrely for tests.

Parameters:

xml - source XML serialized as string.

ConfigBuilder

public ConfigBuilder(File xmlFile)
              throws FileNotFoundException

Create configuration builder from XML file.

Parameters:

xmlFile - source XML file.

Throws:

FileNotFoundException - if source XML file does not exist.

ConfigBuilder

public ConfigBuilder(InputStream xmlStream)

Create configuration builder from XML stream.

Parameters:

xmlStream - source XML stream.

ConfigBuilder

public ConfigBuilder(Properties properties)

Create configuration builder from Java properties.

Parameters:

properties - source properties.

ConfigBuilder

protected ConfigBuilder()

Protected default constructor for sub-classing.

Method Detail

build

public Config build()
             throws ConfigException

Build configuration object. Configuration object is not reusable so this factory creates a new instance for every call.

Returns:

newly created configuration object.

Throws:

ConfigException - if XML stream read operation fails or is not well formed.