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

java.lang.Object
  extended by gr.uoa.di.madgik.commons.configuration.parameter.ShortClassParameter
All Implemented Interfaces:
IParameter

public class ShortClassParameter
extends java.lang.Object
implements IParameter

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

 <param name="parameterKey" type="ShortClass" generated="false" internal="false">4</param>

 
 

Author:
gpapanikos

Nested Class Summary
 
Nested classes/interfaces inherited from interface gr.uoa.di.madgik.commons.configuration.parameter.IParameter
IParameter.ParameterType
 
Constructor Summary
ShortClassParameter()
           
 
Method Summary
 void Check()
          Sets that the parameter has been evaluated during the DependencyGraph.ResolveDependencies() process
 void FromXML(org.w3c.dom.Element element)
          Parses the provided xml subtree and populates the parameter instnace
 void FromXML(java.lang.String xml)
          Parses the provided xml subtree and populates the parameter instnace
 java.lang.String GetName()
          Retrieves the name of the parameter
 java.lang.Class<?> GetParameterClassType()
          Retireves the class type of the value the parameter stored
 IParameter.ParameterType GetParameterType()
          Retrieves the IParameter the implementing instnace represents
 java.lang.Object GetValue()
          Retrieves the value of the parameter
 java.lang.Boolean IsChecked()
          Retrieves whether or not the parameter has been evaluated during the DependencyGraph.ResolveDependencies() process
 java.lang.Boolean IsGenerated()
          Retrieves whether or not the parameter is generated or a specific value of generation description is available in the same decleration
 java.lang.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(java.lang.Object Value)
          Sets the value of the parameter
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ShortClassParameter

public ShortClassParameter()
Method Detail

GetParameterClassType

public java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.Object 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(java.lang.Object Value)
              throws java.lang.Exception
Description copied from interface: IParameter
Sets the value of the parameter

Specified by:
SetValue in interface IParameter
Parameters:
Value - the value
Throws:
java.lang.Exception - the value is not of correct type for the parameter instnace

FromXML

public void FromXML(java.lang.String xml)
             throws java.lang.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:
java.lang.Exception - the parsing could be performed

FromXML

public void FromXML(org.w3c.dom.Element element)
             throws java.lang.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:
java.lang.Exception - the parsing could be performed