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

All Known Subinterfaces:

ParameterInternal

All Known Implementing Classes:

BasicParameter

public interface Parameter

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

Method Summary

void	add(java.util.List value)
void	add(java.lang.Object value)
boolean	check(Parameter type)
boolean	check(Property property)
boolean	check(java.lang.String type, java.util.List value)
boolean	check(java.lang.String type, java.lang.Object value)
void	clear()
Parameter	duplicate()
java.lang.Object	get()
java.lang.String	getDescription()
java.lang.Class	getParameterClass()
SyntaxChecker	getRestrictions()
java.lang.String	getType() Name of this parameter.
java.util.List<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?
Parameter	prototype()
void	set(java.util.List value)
void	set(java.lang.Object value)
void	set(Property property)

Method Detail

getType

java.lang.String getType()

Name of this parameter. Typically, this value in a Properties object sets this parameter

Returns:

name of this parameter

getValue

java.util.List<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.

getDescription

java.lang.String getDescription()

getParameterClass

java.lang.Class getParameterClass()

getRestrictions

SyntaxChecker getRestrictions()

check

boolean check(Property property)

check

boolean check(java.lang.String type,
              java.lang.Object value)

check

boolean check(java.lang.String type,
              java.util.List value)

check

boolean check(Parameter type)

add

void add(java.lang.Object value)

add

void add(java.util.List value)

set

void set(Property property)

clear

void clear()

duplicate

Parameter duplicate()

prototype

Parameter prototype()

get

java.lang.Object get()

set

void set(java.lang.Object value)

set

void set(java.util.List value)