Package org.tweetyproject.plugin.parameter

Class StringListCommandParameter

java.lang.Object

org.tweetyproject.plugin.parameter.CommandParameter

org.tweetyproject.plugin.parameter.StringListCommandParameter

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

CustomStringListCommandParameter

public class StringListCommandParameter
extends CommandParameter

This class models a string list command parameter for Work-in-Progress, do not use!

Author:

bwolf

Constructor Summary

Constructors

Constructor	Description
StringListCommandParameter(String id, String des)	constructor with identifier and description

Method Summary

Modifier and Type	Method	Description
Object	clone()	method to clone this object for instantiation
String[]	getValue()	Retrieves the value of this object.
CommandParameter	instantiate(String s)	instantiates unary argument if valid
CommandParameter	instantiate(String[] s)	instantiates a list of arguments if valid
boolean	isValid(String s)	checks each input string for validity
void	setValue(String[] value)	Sets the value of this object.

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

StringListCommandParameter

public StringListCommandParameter(String id,
 String des)

constructor with identifier and description

Parameters:

id - the identifier used to call this parameter

des - the description of this parameter

Method Details

getValue

public String[] getValue()

Retrieves the value of this object.

Returns:

a `String[]` representing the current value of this object, or `null` if no value has been set.

setValue

public void setValue(String[] value)

Sets the value of this object.

Parameters:

value - a `String[]` representing the new value to be stored in this object.

isValid

public boolean isValid(String s)

checks each input string for validity

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 unary argument if valid

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.

instantiate

public CommandParameter instantiate(String[] s)

instantiates a list of arguments if valid

Parameters:

s - an array of strings

Returns:

the command parameter

clone

public Object clone()

method to clone this object for instantiation