|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgr.uoa.di.madgik.commons.configuration.parameter.StringParameter
public class StringParameter
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>
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface gr.uoa.di.madgik.commons.configuration.parameter.IParameter |
---|
IParameter.ParameterType |
Constructor Summary | |
---|---|
StringParameter()
|
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.String |
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 |
---|
public StringParameter()
Method Detail |
---|
public java.lang.Class<?> GetParameterClassType()
IParameter
GetParameterClassType
in interface IParameter
public java.lang.Boolean IsChecked()
IParameter
DependencyGraph.ResolveDependencies()
process
IsChecked
in interface IParameter
public void Check()
IParameter
DependencyGraph.ResolveDependencies()
process
Check
in interface IParameter
public IParameter.ParameterType GetParameterType()
IParameter
IParameter
the implementing
instnace represents
GetParameterType
in interface IParameter
public java.lang.String GetName()
IParameter
GetName
in interface IParameter
public java.lang.Boolean IsGenerated()
IParameter
IsGenerated
in interface IParameter
public java.lang.Boolean IsInternal()
IParameter
IsInternal
in interface IParameter
public java.lang.String GetValue()
IParameter
GetValue
in interface IParameter
public void SetValue(java.lang.Object Value) throws java.lang.Exception
IParameter
SetValue
in interface IParameter
Value
- the value
java.lang.Exception
- the value is not of correct type for the parameter instnacepublic void FromXML(java.lang.String xml) throws java.lang.Exception
IParameter
FromXML
in interface IParameter
xml
- the xml subtree
java.lang.Exception
- the parsing could be performedpublic void FromXML(org.w3c.dom.Element element) throws java.lang.Exception
IParameter
FromXML
in interface IParameter
element
- the xml subtree
java.lang.Exception
- the parsing could be performed
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |