org.castor.ddlgen

Class Configuration

java.lang.Object

org.castor.ddlgen.Configuration

Direct Known Subclasses:

DDLGenConfiguration

public class Configuration
extends Object

Handle the configuration for DDL generator including load configuration files, manage configuration values.

Since:

1.1

Version:

$Revision: 5951 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $

Author:

Le Duc Bao, Ralf Joachim

Field Summary

Fields

Modifier and Type	Field and Description
static String	FALSE String representation of boolean false.
static String	TRUE String representation of boolean true.

Constructor Summary

Constructors

Constructor and Description
Configuration() Constructor for Configuration.

Method Summary

Modifier and Type	Method and Description
void	addProperties(Properties props) add properties (key, value) for configuration, the existed item will be overwrited.
void	addProperties(String filename) add properties (key, value) for configuration, the existed item will be overwrited.
boolean	getBoolValue(String key) get boolean value associated with key in the configuration files.
boolean	getBoolValue(String key, boolean defaultValue) get boolean value associated with key in the configuration files.
Integer	getInteger(String name) Get property with given name as Integer value.
String	getStringValue(String key) get String value associated with key in the configuration files.
String	getStringValue(String key, String defaultValue) get String value associated with key in the configuration files.
void	setProperty(String key, String value) set property value, this will overwrite the loaded value.

Methods inherited from class java.lang.Object

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

Field Detail

TRUE

public static final String TRUE

String representation of boolean true.

See Also:

Constant Field Values

FALSE

public static final String FALSE

String representation of boolean false.

See Also:

Constant Field Values

Constructor Detail

Configuration

public Configuration()

Constructor for Configuration.

Method Detail

getBoolValue

public final boolean getBoolValue(String key)
                           throws WrongFormatException,
                                  KeyNotFoundException

get boolean value associated with key in the configuration files.

Parameters:

key - key

Returns:

return value associated with key. If not exists, throw an exception

Throws:

WrongFormatException - format error

KeyNotFoundException - key error

getBoolValue

public final boolean getBoolValue(String key,
                                  boolean defaultValue)

get boolean value associated with key in the configuration files.

Parameters:

key - key

defaultValue - default value

Returns:

return value associated with key. If not exists, return the default value

getInteger

public final Integer getInteger(String name)

Get property with given name as Integer value. If property is not available or can not be interpreted as integer null will be returned.

Parameters:

name - Name of the property.

Returns:

The configured Integer property or null if property is not available or can not be interpreted as integer.

getStringValue

public final String getStringValue(String key)
                            throws KeyNotFoundException

get String value associated with key in the configuration files.

Parameters:

key - key

Returns:

return value associated with key. If not exists, throw an exception

Throws:

KeyNotFoundException - key error

getStringValue

public final String getStringValue(String key,
                                   String defaultValue)

get String value associated with key in the configuration files.

Parameters:

key - key

defaultValue - default value

Returns:

return value associated with key. If not exists, return default value

addProperties

public final void addProperties(Properties props)

add properties (key, value) for configuration, the existed item will be overwrited.

Parameters:

props - properties

addProperties

public final void addProperties(String filename)
                         throws GeneratorException

add properties (key, value) for configuration, the existed item will be overwrited.

Parameters:

filename - a properties file

Throws:

GeneratorException - generator error

setProperty

public final void setProperty(String key,
                              String value)

set property value, this will overwrite the loaded value.

Parameters:

key - key

value - value