gr.uoa.di.madgik.commons.configuration.parameter

Interface IParameter

All Known Implementing Classes:

BooleanClassParameter, BooleanPrimitiveParameter, ByteClassParameter, BytePrimitiveParameter, DoubleClassParameter, DoublePrimitiveParameter, FloatClassParameter, FloatPrimitiveParameter, IntegerClassParameter, IntegerPrimitiveParameter, LongClassParameter, LongPrimitiveParameter, ObjectParameter, ShortClassParameter, ShortPrimitiveParameter, StringParameter, XMLParameter

public interface IParameter

All elements that can be defined and retrieved ffrom the ConfigurationManager are parameters. All these parameters have to implement this interface.

Author:

gpapanikos

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IParameter.ParameterType The type of parameters tat can be declared and instnatiated.

Method Summary

Methods

Modifier and Type	Method and Description
void	Check() Sets that the parameter has been evaluated during the DependencyGraph.ResolveDependencies() process
void	FromXML(Element element) Parses the provided xml subtree and populates the parameter instnace
void	FromXML(String xml) Parses the provided xml subtree and populates the parameter instnace
String	GetName() Retrieves the name of the parameter
Class<?>	GetParameterClassType() Retireves the class type of the value the parameter stored
IParameter.ParameterType	GetParameterType() Retrieves the IParameter the implementing instnace represents
Object	GetValue() Retrieves the value of the parameter
Boolean	IsChecked() Retrieves whether or not the parameter has been evaluated during the DependencyGraph.ResolveDependencies() process
Boolean	IsGenerated() Retrieves whether or not the parameter is generated or a specific value of generation description is available in the same decleration
Boolean	IsInternal() Retrieves whether or not the parameter is internal and is only used as an intermediate step during the initialization of an other parameter or it can also be accessed by external clients
void	SetValue(Object Value) Sets the value of the parameter

Method Detail

GetParameterType

IParameter.ParameterType GetParameterType()

Retrieves the IParameter the implementing instnace represents

Returns:

the parameter type

GetName

String GetName()

Retrieves the name of the parameter

Returns:

the parameter name

IsGenerated

Boolean IsGenerated()

Retrieves whether or not the parameter is generated or a specific value of generation description is available in the same decleration

Returns:

whether or not the parameter is generated

IsInternal

Boolean IsInternal()

Retrieves whether or not the parameter is internal and is only used as an intermediate step during the initialization of an other parameter or it can also be accessed by external clients

Returns:

wheter or not the parameter is generated

IsChecked

Boolean IsChecked()

Retrieves whether or not the parameter has been evaluated during the DependencyGraph.ResolveDependencies() process

Returns:

whether or not the parameter has been evaluated

Check

void Check()

Sets that the parameter has been evaluated during the DependencyGraph.ResolveDependencies() process

GetValue

Object GetValue()

Retrieves the value of the parameter

Returns:

the value

SetValue

void SetValue(Object Value)
              throws Exception

Sets the value of the parameter

Parameters:

Value - the value

Throws:

Exception - the value is not of correct type for the parameter instnace

GetParameterClassType

Class<?> GetParameterClassType()

Retireves the class type of the value the parameter stored

Returns:

the class

FromXML

void FromXML(String xml)
             throws Exception

Parses the provided xml subtree and populates the parameter instnace

Parameters:

xml - the xml subtree

Throws:

Exception - the parsing could be performed

FromXML

void FromXML(Element element)
             throws Exception

Parses the provided xml subtree and populates the parameter instnace

Parameters:

element - the xml subtree

Throws:

Exception - the parsing could be performed