com.eibus.management

Interface IParameterDefinition<T>

All Known Implementing Classes:

ParameterDefinition

public interface IParameterDefinition<T>

This interface defines a parameter of a management operation.

Author:

Bert Roos

Method Summary

Modifier and Type	Method and Description
T	getDefaultValue() Returns the default value for this parameter, if it has one, or null otherwise.
java.lang.String	getDescription() Returns the name of the parameter described by this IParameterDefinition instance.
T[]	getLegalValues() Returns the set of legal values for this parameter, if it has one, or null otherwise.
java.lang.Comparable<T>	getMaxValue() Returns the maximal value for this parameter, if it has one, or null otherwise.
java.lang.Comparable<T>	getMinValue() Returns the minimal value for this parameter, if it has one, or null otherwise.
java.lang.String	getName() Returns the name of the parameter described by this IParameterDefinition instance.

Method Detail

getName

java.lang.String getName()

Returns the name of the parameter described by this IParameterDefinition instance.

Returns:

the name of the parameter described by this IParameterDefinition instance.

getDescription

java.lang.String getDescription()

Returns the name of the parameter described by this IParameterDefinition instance.

Returns:

the name of the parameter described by this IParameterDefinition instance.

getDefaultValue

T getDefaultValue()

Returns the default value for this parameter, if it has one, or null otherwise.

Returns:

the default value for this parameter, if it has one, or null otherwise.

getLegalValues

T[] getLegalValues()

Returns the set of legal values for this parameter, if it has one, or null otherwise.

Returns:

the set of legal values for this parameter, if it has one, or null otherwise.

getMaxValue

java.lang.Comparable<T> getMaxValue()

Returns the maximal value for this parameter, if it has one, or null otherwise.

Returns:

the maximal value for this parameter, if it has one, or null otherwise.

getMinValue

java.lang.Comparable<T> getMinValue()

Returns the minimal value for this parameter, if it has one, or null otherwise.

Returns:

the minimal value for this parameter, if it has one, or null otherwise.