org.debellor.core.parameters
Class ParametersInfo

java.lang.Object
  org.debellor.core.parameters.ParametersInfo

All Implemented Interfaces:

java.io.Serializable

public class ParametersInfo
extends java.lang.Object
implements java.io.Serializable

Holds information about all available parameters of a cell. Can be printed to a PrintStream in a readable text form.

Author:

Marcin Wojnarski

See Also:

Serialized Form

Constructor Summary

ParametersInfo()

ParametersInfo(java.lang.String... entries)
Creates ParametersInfo with initial content passed in entries.

Method Summary

ParametersInfo	copy() Returns deep copy of this object
Parameters	getDefaultValues() Returns default values of parameters as a Parameters instance that can be passed directly to Cell.setParameters(org.debellor.core.Parameters).
void	set(java.lang.String name, java.lang.String value) Add new parameter together with its default value.
void	set(java.lang.String name, java.lang.String value, java.lang.String meaning) Add new parameter together with its default value and description of meaning.
int	size() Returns the number of parameters defined in this ParametersInfo.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParametersInfo

public ParametersInfo()

ParametersInfo

public ParametersInfo(java.lang.String... entries)

Creates ParametersInfo with initial content passed in entries.

Parameters:

entries - Names, default values and meanings of consecutive parameters, given in the following order:

name1, default1, meaning1, name2, default2, meaning2, ...

Caution: do not omit any element of the triple. If you do not want to give meaning or a sensible default value for some parameter, put null instead.

Method Detail

set

public void set(java.lang.String name,
                java.lang.String value)

Add new parameter together with its default value.

Parameters:

name -

value - default value

See Also:

Parameters.set(java.lang.String, java.lang.String)

set

public void set(java.lang.String name,
                java.lang.String value,
                java.lang.String meaning)

Add new parameter together with its default value and description of meaning.

Parameters:

name -

value - default value

meaning - description of meaning and usage, preferably as a single line of text, without end-of-line at the end

See Also:

Parameters.set(java.lang.String, java.lang.String)

getDefaultValues

public Parameters getDefaultValues()

Returns default values of parameters as a Parameters instance that can be passed directly to Cell.setParameters(org.debellor.core.Parameters).

size

public int size()

Returns the number of parameters defined in this ParametersInfo.

copy

public ParametersInfo copy()

Returns deep copy of this object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object