com.eibus.management

Class ParameterDefinition<T>

java.lang.Object

<any>

com.eibus.management.ParameterDefinition<T>

All Implemented Interfaces:

IParameterDefinition<T>

public class ParameterDefinition<T>
extends <any>
implements IParameterDefinition<T>

Defines a parameter for a managed operation.

Author:

Bert Roos

Constructor Summary

Constructors

Constructor and Description
ParameterDefinition(java.lang.String name, ILocalizableString description) Constructs a parameter definition with a given name and description.
ParameterDefinition(java.lang.String name, ILocalizableString description, T defaultValue) Constructs a parameter definition with a given name, description and default value.
ParameterDefinition(java.lang.String name, ILocalizableString description, T defaultValue, java.lang.Comparable<T> minValue, java.lang.Comparable<T> maxValue) Constructs a parameter definition with a given name, description, default value and minimum/maximum value.
ParameterDefinition(java.lang.String name, ILocalizableString description, T defaultValue, T[] legalValues) Constructs a parameter definition with a given name, description, default value and set of legal values.
ParameterDefinition(java.lang.String name, java.lang.String description) Deprecated. Use the localizable variant of this constructor instead.
ParameterDefinition(java.lang.String name, java.lang.String description, T defaultValue) Deprecated. Use the localizable variant of this constructor instead.
ParameterDefinition(java.lang.String name, java.lang.String description, T defaultValue, java.lang.Comparable<T> minValue, java.lang.Comparable<T> maxValue) Deprecated. Use the localizable variant of this constructor instead.
ParameterDefinition(java.lang.String name, java.lang.String description, T defaultValue, T[] legalValues) Deprecated. Use the localizable variant of this constructor instead.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterDefinition

public ParameterDefinition(java.lang.String name,
                           java.lang.String description)

Deprecated. Use the localizable variant of this constructor instead.

Constructs a parameter definition with a given name and description.

Parameters:

name - the name of this parameter

description - the description of this parameter

ParameterDefinition

public ParameterDefinition(java.lang.String name,
                           ILocalizableString description)

Constructs a parameter definition with a given name and description.

Parameters:

name - the name of this parameter

description - the localizable description of this parameter

ParameterDefinition

public ParameterDefinition(java.lang.String name,
                           java.lang.String description,
                           T defaultValue)

Deprecated. Use the localizable variant of this constructor instead.

Constructs a parameter definition with a given name, description and default value.

Parameters:

name - the name of this parameter

description - the description of this parameter

defaultValue - the default parameter value

ParameterDefinition

public ParameterDefinition(java.lang.String name,
                           ILocalizableString description,
                           T defaultValue)

Constructs a parameter definition with a given name, description and default value.

Parameters:

name - the name of this parameter

description - the localizable description of this parameter

defaultValue - the default parameter value

ParameterDefinition

public ParameterDefinition(java.lang.String name,
                           java.lang.String description,
                           T defaultValue,
                           java.lang.Comparable<T> minValue,
                           java.lang.Comparable<T> maxValue)

Deprecated. Use the localizable variant of this constructor instead.

Constructs a parameter definition with a given name, description, default value and minimum/maximum value.

Parameters:

name - the name of this parameter

description - the description of this parameter

defaultValue - the default parameter value

minValue - the minimum parameter value

maxValue - the maximum parameter value

ParameterDefinition

public ParameterDefinition(java.lang.String name,
                           ILocalizableString description,
                           T defaultValue,
                           java.lang.Comparable<T> minValue,
                           java.lang.Comparable<T> maxValue)

Constructs a parameter definition with a given name, description, default value and minimum/maximum value.

Parameters:

name - the name of this parameter

description - the localizable description of this parameter

defaultValue - the default parameter value

minValue - the minimum parameter value

maxValue - the maximum parameter value

ParameterDefinition

public ParameterDefinition(java.lang.String name,
                           java.lang.String description,
                           T defaultValue,
                           T[] legalValues)

Deprecated. Use the localizable variant of this constructor instead.

Constructs a parameter definition with a given name, description, default value and set of legal values.

Parameters:

name - the name of this parameter

description - the description of this parameter

defaultValue - the default parameter value

legalValues - the legal parameter values

ParameterDefinition

public ParameterDefinition(java.lang.String name,
                           ILocalizableString description,
                           T defaultValue,
                           T[] legalValues)

Constructs a parameter definition with a given name, description, default value and set of legal values.

Parameters:

name - the name of this parameter

description - the localizable description of this parameter

defaultValue - the default parameter value

legalValues - the legal parameter values

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IParameterDefinition

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

Specified by:

getName in interface IParameterDefinition<T>

Returns:

the name of the parameter described by this IParameterDefinition instance.

getDescription

public java.lang.String getDescription()

Description copied from interface: IParameterDefinition

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

Specified by:

getDescription in interface IParameterDefinition<T>

Returns:

the name of the parameter described by this IParameterDefinition instance.

getDefaultValue

public T getDefaultValue()

Description copied from interface: IParameterDefinition

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

Specified by:

getDefaultValue in interface IParameterDefinition<T>

Returns:

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

getLegalValues

public T[] getLegalValues()

Description copied from interface: IParameterDefinition

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

Specified by:

getLegalValues in interface IParameterDefinition<T>

Returns:

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

getMaxValue

public java.lang.Comparable<T> getMaxValue()

Description copied from interface: IParameterDefinition

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

Specified by:

getMaxValue in interface IParameterDefinition<T>

Returns:

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

getMinValue

public java.lang.Comparable<T> getMinValue()

Description copied from interface: IParameterDefinition

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

Specified by:

getMinValue in interface IParameterDefinition<T>

Returns:

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