com.deltaxml.core

Class DXPParameterDefinition<T extends java.lang.Comparable<?>>

java.lang.Object

com.deltaxml.core.DXPParameterDefinition<T>

Type Parameters:

T - The type of parameter (e.g. String or Boolean).

All Implemented Interfaces:

java.lang.Comparable<DXPParameterDefinition<?>>

Direct Known Subclasses:

DXPParameterInstance

public class DXPParameterDefinition<T extends java.lang.Comparable<?>>
extends java.lang.Object
implements java.lang.Comparable<DXPParameterDefinition<?>>

A comparison parameter definition.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DXPParameterDefinition.FormatInfo A utility class for identifying the space required to display a list of parameter definitions.

Constructor Summary

Constructors

Constructor and Description
DXPParameterDefinition(java.lang.String name, T defaultValue, java.lang.String description) Create a parameter with a given name, default value and description.

Method Summary

Modifier and Type	Method and Description
int	compareTo(DXPParameterDefinition<?> p) Total order of two parameter objects, where objects primary order is by name.
boolean	equals(java.lang.Object o) Overrides the default equals method.
T	getDefaultValue() Get the parameter's default value.
java.lang.String	getDescription() Get the parameter's description.
java.lang.String	getName() Get the parameter's name.
int	hashCode() Overrides the default hashCode method.
void	setDescription(java.lang.String description) Set the parameters description.
java.lang.String	toString() Overrides the default toString method.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DXPParameterDefinition

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

Create a parameter with a given name, default value and description.

Parameters:

name - The parameter's name.

defaultValue - The parameter's default value.

description - A short description of what the parameter does.

Method Detail

getName

public java.lang.String getName()

Get the parameter's name.

Returns:

The parameter's name.

getDefaultValue

public T getDefaultValue()

Get the parameter's default value.

Returns:

The parameter's default value.

getDescription

public java.lang.String getDescription()

Get the parameter's description.

Returns:

The parameter's description.

setDescription

public void setDescription(java.lang.String description)

Set the parameters description.

Parameters:

description - The parameter's description.

compareTo

public int compareTo(DXPParameterDefinition<?> p)

Total order of two parameter objects, where objects primary order is by name.

Specified by:

compareTo in interface java.lang.Comparable<DXPParameterDefinition<?>>

Parameters:

p -

Returns:

equals

public boolean equals(java.lang.Object o)

Overrides the default equals method.

Overrides:

equals in class java.lang.Object

Parameters:

o -

Returns:

hashCode

public int hashCode()

Overrides the default hashCode method.

Overrides:

hashCode in class java.lang.Object

Returns:

toString

public java.lang.String toString()

Overrides the default toString method.

Overrides:

toString in class java.lang.Object

Returns: