com.deltaxml.core

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

java.lang.Object

com.deltaxml.core.DXPParameterDefinition<T>

com.deltaxml.core.DXPParameterInstance<T>

Type Parameters:

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

All Implemented Interfaces:

java.lang.Comparable<DXPParameterDefinition<?>>

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

An instance of a DXPParameterDefinition object. If no value is given to this instance, it will take its default value from the DXPParameterDefinition supplied.

Nested Class Summary

Nested classes/interfaces inherited from class com.deltaxml.core.DXPParameterDefinition

DXPParameterDefinition.FormatInfo

Constructor Summary

Constructors

Constructor and Description
DXPParameterInstance(DXPParameterDefinition<T> pd) Create a parameter instance from a parameter definition.
DXPParameterInstance(DXPParameterDefinition<T> pd, T value) Create a parameter instance from a parameter definition and value.

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.
T	getValue() Get the parameter's current value.
void	setValue(T value) Set the parameters current value.
java.lang.String	toString() Overrides the default toString method.

Methods inherited from class com.deltaxml.core.DXPParameterDefinition

equals, getDefaultValue, getDescription, getName, hashCode, setDescription

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DXPParameterInstance

public DXPParameterInstance(DXPParameterDefinition<T> pd)

Create a parameter instance from a parameter definition.

Parameters:

pd - The parameter definition

DXPParameterInstance

public DXPParameterInstance(DXPParameterDefinition<T> pd,
                            T value)

Create a parameter instance from a parameter definition and value.

Parameters:

pd - The parameter definition.

value - The parameter value.

Method Detail

getValue

public T getValue()

Get the parameter's current value.

Returns:

The parameter's current value.

setValue

public void setValue(T value)

Set the parameters current value.

Parameters:

value - The parameter's current value.

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<?>>

Overrides:

compareTo in class DXPParameterDefinition<T extends java.lang.Comparable<?>>

Parameters:

p - the DXPParameterDefinition to compare against this one

Returns:

toString

public java.lang.String toString()

Overrides the default toString method.

Overrides:

toString in class DXPParameterDefinition<T extends java.lang.Comparable<?>>

Returns: