org.qedeq.kernel.rel.test.gui
Class Parameter

java.lang.Object
  org.qedeq.kernel.rel.test.gui.Parameter

public final class Parameter

extends Object

Show and edit parameters of an application. Valid parameter types are:

• Boolean
• Integer
• Double
• String
• File
• List

TODO mime 20060831: check for correct type class

Version:

$Revision: 1.5 $

Constructor Summary

Parameter(String name, String label, Class type, String comment, String value)
Constructor.

Parameter(String name, String label, Class type, String comment, String value, String dflt)
Constructor.

Parameter(String name, String label, String comment, String value, String dflt, List list)
Constructor.

Method Summary

Boolean	getBooleanValue() Get Boolean parameter value.
String	getComment() Get parameter comment.
Boolean	getCurrentBooleanValue() Get current Boolean parameter value.
Double	getCurrentDoubleValue() Get current Double parameter value.
File	getCurrentFileValue() Get current File parameter value.
Integer	getCurrentIntegerValue() Get current Integer parameter value.
String	getCurrentStringValue() Get current parameter value as String.
Object	getCurrentValue() Get current parameter value.
Double	getDoubleValue() Get Double parameter value.
File	getFileValue() Get File parameter value.
Integer	getIntegerValue() Get Integer parameter value.
String	getLabel() Get parameter label.
List	getList() Get value list.
String	getName() Get parameter name.
String	getStringValue() Get parameter value as String.
Class	getType() Get parameter type.
Object	getValue() Get parameter value.
void	resetToDefault() Reset all parameters to default values.
void	setComment(String comment) Set parameter comment.
void	setCurrentValue(Boolean valueCurrent) Set current Boolean parameter value.
void	setCurrentValue(Double valueCurrent) Set current Double parameter value.
void	setCurrentValue(File valueCurrent) Set current File parameter value.
void	setCurrentValue(Integer valueCurrent) Set current Integer parameter value.
void	setCurrentValue(String valueCurrent) Set current String parameter value.
void	setLabel(String label) Set parameter label.
void	setName(String name) Set parameter name.
void	setStringValue(String value) Set value according to type.
void	setValue(Boolean value) Set Boolean parameter value.
void	setValue(Double value) Set Double parameter value.
void	setValue(File value) Set File parameter value.
void	setValue(Integer value) Set Integer parameter value.
void	setValue(String value) Set String parameter value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter(String name,
                 String label,
                 Class type,
                 String comment,
                 String value)

Constructor.

Parameters:

name - Parameter name.

label - Parameter label.

type - Parameter type.

comment - Parameter comment.

value - Value of parameter. Maybe null.

Parameter

public Parameter(String name,
                 String label,
                 Class type,
                 String comment,
                 String value,
                 String dflt)

Constructor.

Parameters:

name - Parameter name.

label - Parameter label.

type - Parameter type.

comment - Parameter comment.

value - Value of parameter. Maybe null.

dflt - Default value of parameter. Maybe null.

Parameter

public Parameter(String name,
                 String label,
                 String comment,
                 String value,
                 String dflt,
                 List list)

Constructor.

Parameters:

name - Parameter name.

label - Parameter label.

comment - Parameter comment.

value - Value of parameter. Maybe null.

dflt - Default value of parameter. Maybe null.

list - List of possible string values.

Throws:

NullPointerException - list is null.

Method Detail

resetToDefault

public void resetToDefault()

Reset all parameters to default values.

getComment

public String getComment()

Get parameter comment.

Returns:

Comment.

setComment

public void setComment(String comment)

Set parameter comment.

Parameters:

comment - Comment.

getName

public String getName()

Get parameter name.

Returns:

Name of parameter.

setName

public void setName(String name)

Set parameter name.

Parameters:

name -

getType

public Class getType()

Get parameter type.

Returns:

Type.

getValue

public Object getValue()

Get parameter value.

Returns:

Value.

getBooleanValue

public Boolean getBooleanValue()

Get Boolean parameter value.

Returns:

Boolean parameter value.

Throws:

ClassCastException - Type is not Boolean.

getIntegerValue

public Integer getIntegerValue()

Get Integer parameter value.

Returns:

Integer parameter value.

Throws:

ClassCastException - Type is not Integer.

getDoubleValue

public Double getDoubleValue()

Get Double parameter value.

Returns:

Double parameter value.

Throws:

ClassCastException - Type is not Double.

getStringValue

public String getStringValue()

Get parameter value as String. Works on any parameter type.

Returns:

Parameter value as String.

getFileValue

public File getFileValue()

Get File parameter value.

Returns:

File parameter value.

Throws:

ClassCastException - Type is not File.

setValue

public void setValue(Boolean value)

Set Boolean parameter value.

Parameters:

value - Boolean parameter value.

Throws:

ClassCastException - Type is not Boolean.

setValue

public void setValue(Integer value)

Set Integer parameter value.

Parameters:

value - Integer parameter value.

Throws:

ClassCastException - Type is not Integer.

setValue

public void setValue(Double value)

Set Double parameter value.

Parameters:

value - Double parameter value.

Throws:

ClassCastException - Type is not Double.

setValue

public void setValue(String value)

Set String parameter value.

Parameters:

value - String parameter value.

Throws:

ClassCastException - Type is not String or List.

IllegalArgumentException - Type is List and value is not in list.

setValue

public void setValue(File value)

Set File parameter value.

Parameters:

value - File parameter value.

Throws:

ClassCastException - Type is not File.

setLabel

public void setLabel(String label)

Set parameter label.

Parameters:

label - Label for parameter.

getLabel

public String getLabel()

Get parameter label.

Returns:

Label for parameter.

setStringValue

public void setStringValue(String value)

Set value according to type. Uses constructor with String for getType().

Parameters:

value -

getList

public List getList()

Get value list.

Returns:

List of possible values.

getCurrentValue

public Object getCurrentValue()

Get current parameter value.

Returns:

Value.

getCurrentBooleanValue

public Boolean getCurrentBooleanValue()

Get current Boolean parameter value.

Returns:

Boolean parameter value.

Throws:

ClassCastException - Type is not Boolean.

getCurrentIntegerValue

public Integer getCurrentIntegerValue()

Get current Integer parameter value.

Returns:

Integer parameter value.

Throws:

ClassCastException - Type is not Integer.

getCurrentDoubleValue

public Double getCurrentDoubleValue()

Get current Double parameter value.

Returns:

Double parameter value.

Throws:

ClassCastException - Type is not Double.

getCurrentStringValue

public String getCurrentStringValue()

Get current parameter value as String. Works on any parameter type.

Returns:

Parameter value as String.

getCurrentFileValue

public File getCurrentFileValue()

Get current File parameter value.

Returns:

File parameter value.

Throws:

ClassCastException - Type is not File.

setCurrentValue

public void setCurrentValue(Boolean valueCurrent)

Set current Boolean parameter value.

Parameters:

valueCurrent - Boolean parameter value.

Throws:

ClassCastException - Type is not Boolean.

setCurrentValue

public void setCurrentValue(Integer valueCurrent)

Set current Integer parameter value.

Parameters:

valueCurrent - Integer parameter value.

Throws:

ClassCastException - Type is not Integer.

setCurrentValue

public void setCurrentValue(Double valueCurrent)

Set current Double parameter value.

Parameters:

valueCurrent - Double parameter value.

Throws:

ClassCastException - Type is not Double.

setCurrentValue

public void setCurrentValue(String valueCurrent)

Set current String parameter value.

Parameters:

valueCurrent - String parameter value.

Throws:

ClassCastException - Type is not String or List.

IllegalArgumentException - Type is List and value is not in list.

setCurrentValue

public void setCurrentValue(File valueCurrent)

Set current File parameter value.

Parameters:

valueCurrent - File parameter value.

Throws:

ClassCastException - Type is not File.