ObjectParameter (MadgikCommons 1.5.0-SNAPSHOT API)

java.lang.Object
- gr.uoa.di.madgik.commons.configuration.parameter.ObjectParameter

All Implemented Interfaces:: IParameter

public class ObjectParameter
extends Object
implements IParameter

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

 <param name="parameterKey" type="Object" generated="false" internal="false" shared="false">
  <class value="full.package.name.ClassName"/>
  <constructor>
   <arguments>
    <arg order="1" name="arg1" param="parameterKey1"/>
    <arg order="2" name="arg2" param="parameterKey2"/>
    <arg order="3" name="arg3" param="parameterKey3"/>
   </arguments>
  </constructor>
  <calls>
   <method order="1" name="method1">
    <arguments>
     <arg order="1" name="arg1" param="parameterKey4"/>
     <arg order="2" name="arg2" param="parameterKey5"/>
     <arg order="3" name="arg3" param="parameterKey6"/>
    </arguments>
    <output param="parameterKey7"/>
   </method>
   <method order="2" name="method2">
    <arguments>
     <arg order="1" name="arg1" param="parameterKey8"/>
     <arg order="2" name="arg2" param="parameterKey9"/>
     <arg order="3" name="arg3" param="parameterKey10"/>
    </arguments>
    <output param="parameterKey11"/>
   </method>
  </calls>
 </param>

If the IsShared() is set to false, the object needs also to implement the ICloneable interface in order to Clone the object and serve a disjoint reference everytime it is requested by a client.

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

ObjectParameter()

Constructors
Constructor and Description
`ObjectParameter()`

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`	`GetClassName()`
`Constructor`	`GetConstructor()`
`List<Method>`	`GetMethods()`
`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
`Boolean`	`IsShared()`
`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
  - ObjectParameter
```
public ObjectParameter()
```
- 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
  - GetClassName
```
public String GetClassName()
```
  - GetConstructor
```
public Constructor GetConstructor()
```
  - GetMethods
```
public List<Method> GetMethods()
```
  - 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
  - IsShared
```
public Boolean IsShared()
```
  - GetValue
```
public 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(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

Class ObjectParameter

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ObjectParameter

Method Detail

GetParameterClassType

IsChecked

Check

GetClassName

GetConstructor

GetMethods

GetParameterType

GetName

IsGenerated

IsInternal

IsShared

GetValue

SetValue

FromXML

FromXML