nz.ac.waikato.mcennis.rat.graph.descriptors
Interface Parameter

All Known Subinterfaces:
ParameterInternal, SettableParameter
All Known Implementing Classes:
AverageSumParameter, BasicParameter, ExponentialDecayParameter

public interface Parameter

Base interface for parameter. It allows reading of parameter values. Will eventaully bne replaced by JavaBeans.


Method Summary
 java.lang.String getName()
          Name of this parameter.
 java.lang.Class getType()
          Returns the Class type of the parameter.
 java.lang.Object getValue()
          Returns the current value of this object.
 boolean isStructural()
          Will modification of this parameter cause a structural change in the component that has it?
 

Method Detail

getName

java.lang.String getName()
Name of this parameter. Typically, this value in a Properties object sets this parameter

Returns:
name of this parameter

getType

java.lang.Class getType()
Returns the Class type of the parameter.

Returns:
Class type of the parameter

getValue

java.lang.Object getValue()
Returns the current value of this object. Returns null if no value has been set and no default value exists. Typically, a parameter has a default value that will be returned.

Returns:
value of this paramter.

isStructural

boolean isStructural()
Will modification of this parameter cause a structural change in the component that has it?

Returns:
is a structural parameter.