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

Class StringParameter

java.lang.Object

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

All Implemented Interfaces:

IParameter

public class StringParameter
extends Object
implements IParameter

Parameter of type IParameter.ParameterType.String. An example of this instnace configuratino type is the following

 <param name="parameterKey" type="String" generated="false" internal="false">Hello World</param>

 
 

Author:

gpapanikos

Nested Class Summary

Nested classes/interfaces inherited from interface gr.uoa.di.madgik.commons.configuration.parameter.IParameter

IParameter.ParameterType

Constructor Summary

Constructors

Constructor and Description
StringParameter()

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
String	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

Methods inherited from class java.lang.Object

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

Constructor Detail

StringParameter

public StringParameter()

Method Detail

GetParameterClassType

public Class<?> GetParameterClassType()

Description copied from interface: IParameter

Retireves the class type of the value the parameter stored

Specified by:

GetParameterClassType in interface IParameter

Returns:

the class

IsChecked

public Boolean IsChecked()

Description copied from interface: IParameter

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

Specified by:

IsChecked in interface IParameter

Returns:

whether or not the parameter has been evaluated

Check

public void Check()

Description copied from interface: IParameter

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

Specified by:

Check in interface IParameter

GetParameterType

public IParameter.ParameterType GetParameterType()

Description copied from interface: IParameter

Retrieves the IParameter the implementing instnace represents

Specified by:

GetParameterType in interface IParameter

Returns:

the parameter type

GetName

public String GetName()

Description copied from interface: IParameter

Retrieves the name of the parameter

Specified by:

GetName in interface IParameter

Returns:

the parameter name

IsGenerated

public Boolean IsGenerated()

Description copied from interface: IParameter

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

Specified by:

IsGenerated in interface IParameter

Returns:

whether or not the parameter is generated

IsInternal

public Boolean IsInternal()

Description copied from interface: IParameter

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

Specified by:

IsInternal in interface IParameter

Returns:

wheter or not the parameter is generated

GetValue

public String GetValue()

Description copied from interface: IParameter

Retrieves the value of the parameter

Specified by:

GetValue in interface IParameter

Returns:

the value

SetValue

public void SetValue(Object Value)
              throws Exception

Description copied from interface: IParameter

Sets the value of the parameter

Specified by:

SetValue in interface IParameter

Parameters:

Value - the value

Throws:

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

FromXML

public void FromXML(String xml)
             throws Exception

Description copied from interface: IParameter

Parses the provided xml subtree and populates the parameter instnace

Specified by:

FromXML in interface IParameter

Parameters:

xml - the xml subtree

Throws:

Exception - the parsing could be performed

FromXML

public void FromXML(Element element)
             throws Exception

Description copied from interface: IParameter

Parses the provided xml subtree and populates the parameter instnace

Specified by:

FromXML in interface IParameter

Parameters:

element - the xml subtree

Throws:

Exception - the parsing could be performed