Class SelectionCommandParameter

java.lang.Object
org.tweetyproject.plugin.parameter.CommandParameter
org.tweetyproject.plugin.parameter.SelectionCommandParameter
All Implemented Interfaces:
Cloneable
public class SelectionCommandParameter extends CommandParameter
This class expands the CommandParameter with a selection-array containing strings the parameter supports
Author:
Bastian Wolf

  • Constructor Details

    • SelectionCommandParameter

      public SelectionCommandParameter(String id, String des)
      Creates a new parameter.
      Parameters:
      id - some string
      des - some string

    • SelectionCommandParameter

      public SelectionCommandParameter(String id, String des, String[] selections)
      Creates a new parameter.
      Parameters:
      id - some string
      des - some string
      selections - some array of string

  • Method Details

    • getSelections

      public String[] getSelections()
      returns each possible selection argument
      Returns:
      each possible selection argument

    • setSelections

      public void setSelections(String[] selections)
      sets new selection parameter
      Parameters:
      selections - an array of strings

    • getValue

      public String getValue()
      returns the given instantiation argument value for this parameter
      Returns:
      the given instantiation argument value for this parameter

    • setValue

      public void setValue(String 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 ist 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.

    • instantiate

      public ArrayList<CommandParameter> instantiate(ArrayList<String> s)
      Instantiates a list of `CommandParameter` objects based on the provided list of strings.

      This method processes a list of string values, validates each one, and creates a corresponding `SelectionCommandParameter` for each valid string. The `SelectionCommandParameter` is created by cloning the current object and setting its value to the corresponding string from the input list. The created parameters are collected into an `ArrayList` and returned.

      The method modifies the input list of strings by removing each processed and valid string.

      Parameters:
      s - an `ArrayList` of `String` objects representing the input values to be converted into command parameters.
      Returns:
      an `ArrayList` of `CommandParameter` objects, each instantiated from a valid string in the input list.

    • clone

      public Object clone()