be.ac.ulg.montefiore.run.totem.util
Class ParameterDescriptor

java.lang.Object
  be.ac.ulg.montefiore.run.totem.util.ParameterDescriptor

public class ParameterDescriptor
extends java.lang.Object

Use to represent a parameter constituted of a name, description, type, a set of possible values (optional) and a default value.

Creation date: 14 nov. 2005

Author:

Gaël Monfort (monfort@run.montefiore.ulg.ac.be)

Constructor Summary

ParameterDescriptor(java.lang.String name, java.lang.String description, java.lang.Class type, java.lang.Object defaultValue)

ParameterDescriptor(java.lang.String name, java.lang.String description, java.lang.Class type, java.lang.Object defaultValue, java.lang.Object[] possibleValues)

Method Summary

java.lang.Object	getDefaultValue()
java.lang.String	getDescription()
java.lang.String	getName()
java.lang.Object[]	getPossibleValues()
java.lang.Class	getType()
void	setDefaultValue(java.lang.Object defaultValue)
boolean	validate(java.lang.String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParameterDescriptor

public ParameterDescriptor(java.lang.String name,
                           java.lang.String description,
                           java.lang.Class type,
                           java.lang.Object defaultValue)
                    throws AlgorithmParameterException

Throws:

AlgorithmParameterException

ParameterDescriptor

public ParameterDescriptor(java.lang.String name,
                           java.lang.String description,
                           java.lang.Class type,
                           java.lang.Object defaultValue,
                           java.lang.Object[] possibleValues)
                    throws AlgorithmParameterException

Throws:

AlgorithmParameterException

Method Detail

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getType

public java.lang.Class getType()

getDefaultValue

public java.lang.Object getDefaultValue()

setDefaultValue

public void setDefaultValue(java.lang.Object defaultValue)
                     throws AlgorithmParameterException

Throws:

AlgorithmParameterException

validate

public boolean validate(java.lang.String value)

getPossibleValues

public java.lang.Object[] getPossibleValues()