de.uni_hildesheim.sse.monitoring.runtime.configuration

Class ConfigurationEntry

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.configuration.ConfigurationEntry

public class ConfigurationEntry
extends java.lang.Object

Defines a generic configuration entry.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigurationEntry.Type Defines the supported types of configuration entries.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Class<?>	elemType Stores additional information characterizing type.
private static HashMap<java.lang.String,ConfigurationEntry>	ENTRIES Stores the configuration entries.
private java.lang.reflect.Field	field Stores the field representing the attribute of this configuration entry.
private java.lang.String	name Stores the name of the entry.
private ConfigurationEntry.Type	type Stores the type of this configuration entry.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ConfigurationEntry(java.lang.String name, java.lang.String fieldName, ConfigurationEntry.Type type, java.lang.Class<?> elemType) Creates a new configuration entry.

Method Summary

Modifier and Type	Method and Description
static java.util.Iterator<ConfigurationEntry>	getEntries() Returns all registered configuration entries.
static ConfigurationEntry	getEntry(java.lang.String name) Returns the entry matching the given name.
java.lang.String	getName() Returns the name of this entry.
private static java.lang.Object	getPrimitiveValue(java.lang.String value, ConfigurationEntry.Type type, java.lang.Class<?> elemType) Converts the given string to the given type (in case that the type is primitive) and returns the converted object result.
static void	registerEntry(java.lang.String name, ConfigurationEntry.Type type) Registers a new configuration entry.
static void	registerEntry(java.lang.String name, java.lang.String fieldName, ConfigurationEntry.Type type) Registers a new configuration entry.
static void	registerEntry(java.lang.String name, java.lang.String fieldName, ConfigurationEntry.Type type, java.lang.Class<?> elemType) Registers a new configuration entry.
void	setValue(java.lang.String value) Converts the given string to the type of this entry and applies it to the configuration instance.

Methods inherited from class java.lang.Object

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

Field Detail

ENTRIES

private static final HashMap<java.lang.String,ConfigurationEntry> ENTRIES

Stores the configuration entries.

type

private ConfigurationEntry.Type type

Stores the type of this configuration entry.

field

private java.lang.reflect.Field field

Stores the field representing the attribute of this configuration entry.

name

private java.lang.String name

Stores the name of the entry.

elemType

private java.lang.Class<?> elemType

Stores additional information characterizing type.

Constructor Detail

ConfigurationEntry

private ConfigurationEntry(java.lang.String name,
                           java.lang.String fieldName,
                           ConfigurationEntry.Type type,
                           java.lang.Class<?> elemType)

Creates a new configuration entry.

Parameters:

name - the name of the entry

fieldName - the name of the field where to store the value to

type - the type of the entry

elemType - additional type information when type is ConfigurationEntry.Type.ENUM or ConfigurationEntry.Type.ARRAY_ENUM

Throws:

java.lang.IllegalArgumentException - in case that name is null, type is null or that the related attribute in the configuration does not exist.

Since:

1.00

Method Detail

registerEntry

public static final void registerEntry(java.lang.String name,
                                       java.lang.String fieldName,
                                       ConfigurationEntry.Type type,
                                       java.lang.Class<?> elemType)

Registers a new configuration entry.

Parameters:

name - the name of the entry

fieldName - the name of the field where to store the value to

type - the type of the entry

elemType - additional type information when type is ConfigurationEntry.Type.ENUM or ConfigurationEntry.Type.ARRAY_ENUM

Throws:

java.lang.IllegalArgumentException - in case that name is null, type is null or that the related attribute in the configuration does not exist.

Since:

1.00

registerEntry

public static final void registerEntry(java.lang.String name,
                                       java.lang.String fieldName,
                                       ConfigurationEntry.Type type)

Registers a new configuration entry.

Parameters:

name - the name of the entry

fieldName - the name of the field where to store the value to

type - the type of the entry

Throws:

java.lang.IllegalArgumentException - in case that name is null, type is null or that the related attribute in the configuration does not exist.

Since:

1.00

registerEntry

public static final void registerEntry(java.lang.String name,
                                       ConfigurationEntry.Type type)

Registers a new configuration entry.

Parameters:

name - the name of the entry (also the name of the field)

type - the type of the entry

Throws:

java.lang.IllegalArgumentException - in case that name is null, type is null or that the related attribute in the configuration does not exist.

Since:

1.00

getEntry

public static final ConfigurationEntry getEntry(java.lang.String name)

Returns the entry matching the given name.

Parameters:

name - the name of the profile to be returned

Returns:

the configuration entry or null if none was found

Throws:

java.lang.IllegalArgumentException - if name is null

Since:

1.00

getEntries

public static final java.util.Iterator<ConfigurationEntry> getEntries()

Returns all registered configuration entries.

Returns:

all registered configuration entries

Since:

1.00

getName

public java.lang.String getName()

Returns the name of this entry.

Returns:

the name of this entry

Since:

1.00

setValue

public void setValue(java.lang.String value)

Converts the given string to the type of this entry and applies it to the configuration instance.

Parameters:

value - the value to be set for this entry

Throws:

java.lang.IllegalArgumentException - in case that the value cannot be set for some reason (e.g. cannot be converted to target type)

Since:

1.00

getPrimitiveValue

private static java.lang.Object getPrimitiveValue(java.lang.String value,
                                                  ConfigurationEntry.Type type,
                                                  java.lang.Class<?> elemType)

Converts the given string to the given type (in case that the type is primitive) and returns the converted object result.

Parameters:

value - the value to be set for this entry

type - the type to convert for

elemType - the additional information characterizing e.g. enums

Returns:

the result of the conversion (null if not applicable)

Since:

1.00