desmoj.extensions.visualization2d.engine.command

Class Parameter

java.lang.Object

desmoj.extensions.visualization2d.engine.command.Parameter

All Implemented Interfaces:

java.lang.Cloneable

public class Parameter
extends java.lang.Object
implements java.lang.Cloneable

Parameter of a Command Each parameter has a type (name) and can have between min and max values.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

christian.mueller@th-wildau.de For information about subproject: desmoj.extensions.visualization2d please have a look at: http://www.th-wildau.de/cmueller/Desmo-J/Visualization2d/ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor and Description
Parameter(java.lang.String typ, int min, int max) Constructor

Method Summary

Modifier and Type	Method and Description
void	addValue(java.lang.String v) add a value to a parameter
void	addValueCat(java.lang.String[] v) add a value with value-component to a parameter
static java.lang.String	cat(java.lang.String[] v) Parameter-value-components v are connected with a value-separator to one string
Parameter	clone() create an clone of an parameter, used by CommandFrame.clone
int	getMax() get max number of possible values
int	getMin() get min number of possible values
java.lang.String	getTyp() Get type of parameter
java.lang.String[]	getValues() get values of parameter
java.lang.String[]	getValueSplit(int i) get the i.th value from a parameter.
static java.lang.String	replaceSyntaxSign(java.lang.String value)
static java.lang.String[]	split(java.lang.String v) A String v is splited in to its parameter-value-components

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter(java.lang.String typ,
                 int min,
                 int max)

Constructor

Parameters:

typ - Typ of Parameter

min - Min number of possible values

max - Max number of possible values

Method Detail

cat

public static java.lang.String cat(java.lang.String[] v)
                            throws CommandException

Parameter-value-components v are connected with a value-separator to one string

Parameters:

v -

Returns:

string with connected parameters

Throws:

CommandException, - when v[i] contains a Cmd.VALUE_SEPARATOR

CommandException

split

public static java.lang.String[] split(java.lang.String v)

A String v is splited in to its parameter-value-components

Parameters:

v -

Returns:

splitted string

replaceSyntaxSign

public static java.lang.String replaceSyntaxSign(java.lang.String value)

getTyp

public java.lang.String getTyp()

Get type of parameter

Returns:

type of parameter

getMin

public int getMin()

get min number of possible values

Returns:

min number of possible values

getMax

public int getMax()

get max number of possible values

Returns:

max number of possible values

getValues

public java.lang.String[] getValues()

get values of parameter

Returns:

array with parameter-values

addValue

public void addValue(java.lang.String v)

add a value to a parameter

Parameters:

v -

addValueCat

public void addValueCat(java.lang.String[] v)
                 throws CommandException

add a value with value-component to a parameter

Parameters:

v -

Throws:

CommandException

getValueSplit

public java.lang.String[] getValueSplit(int i)

get the i.th value from a parameter. It's components will be splited in a array

Parameters:

i -

Returns:

i.th value of parameter-array

clone

public Parameter clone()
                throws java.lang.CloneNotSupportedException

create an clone of an parameter, used by CommandFrame.clone

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException