Package org.tweetyproject.plugin.parameter

Class IntegerCommandParameter

java.lang.Object

org.tweetyproject.plugin.parameter.CommandParameter

org.tweetyproject.plugin.parameter.IntegerCommandParameter

All Implemented Interfaces:

Cloneable

public class IntegerCommandParameter
extends CommandParameter

This parameter holds a number-interval of possible arguments

Author:

Bastian Wolf

Constructor Summary

Constructors

Constructor	Description
IntegerCommandParameter(String id, String des)	Constructs an `IntegerCommandParameter` with the specified identifier and description.
IntegerCommandParameter(String id, String des, String interval)	Constructs an `IntegerCommandParameter` with the specified identifier, description, and interval.
IntegerCommandParameter(String id, String des, Interval<Integer> interval)	Constructs an `IntegerCommandParameter` with the specified identifier, description, and interval.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Clones the object
Interval<Integer>	getInterval()	returns each possible selection argument
Integer	getValue()	returns the given instantiation argument value for this parameter
CommandParameter	instantiate(String s)	instantiates a new parameter iff the given value is valid for this command parameter
boolean	isValid(String s)	checks whether a cli input parameter argument is valid for the called command parameter
void	setInterval(String interval)	sets new selection parameter
void	setValue(Integer value)	sets the instantiated parameter argument value, value has to be one of the options contained in selections

Methods inherited from class org.tweetyproject.plugin.parameter.CommandParameter

getDescription, getIdentifier

Methods inherited from class java.lang.Object

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

Constructor Details

IntegerCommandParameter

public IntegerCommandParameter(String id,
 String des)

Constructs an `IntegerCommandParameter` with the specified identifier and description.

Parameters:

id - a `String` representing the unique identifier for this parameter.

des - a `String` representing the description of this parameter.

IntegerCommandParameter

public IntegerCommandParameter(String id,
 String des,
 Interval<Integer> interval)

Constructs an `IntegerCommandParameter` with the specified identifier, description, and interval.

Parameters:

id - a `String` representing the unique identifier for this parameter.

des - a `String` representing the description of this parameter.

interval - an object specifying the range of valid integer values for this parameter.

IntegerCommandParameter

public IntegerCommandParameter(String id,
 String des,
 String interval)

Constructs an `IntegerCommandParameter` with the specified identifier, description, and interval.

Parameters:

id - a `String` representing the unique identifier for this parameter.

des - a `String` representing the description of this parameter.

interval - a `String` representing the range of valid integer values for this parameter. The string should be in a format that can be parsed

Method Details

setInterval

public void setInterval(String interval)

sets new selection parameter

Parameters:

interval - some string

getInterval

public Interval<Integer> getInterval()

returns each possible selection argument

Returns:

each possible selection argument

getValue

public Integer getValue()

returns the given instantiation argument value for this parameter

Returns:

the given instantiation argument value for this parameter

setValue

public void setValue(Integer value)

sets the instantiated parameter argument value, value has to be one of the options contained in selections

Parameters:

value - the value given as argument value

isValid

public boolean isValid(String s)

checks whether a cli input parameter argument is valid for the called command parameter

Specified by:

isValid in class CommandParameter

Parameters:

s - the given input string

Returns:

true if valid, false if not

instantiate

public CommandParameter instantiate(String s)

instantiates a new parameter iff the given value is valid for this command parameter

Specified by:

instantiate in class CommandParameter

Parameters:

s - the given argument string

Returns:

The CommandParameter instance or null if the given string is not valid.

clone

public Object clone()

Clones the object