Module it.polimi.ingsw.am13

Package it.polimi.ingsw.am13

Class PromptCommand

java.lang.Object

it.polimi.ingsw.am13.PromptCommand

public class PromptCommand
extends Object

Representation of a command accepted from the command line

Field Summary

Fields

Modifier and Type	Field	Description
private final Consumer<List<String>>	action	Action corresponding to the command.
private final String	command	Command key from the command line (comprehensive of the '--')
private final String	description	Short description of the command
private final List<String>	parameterList	List of parameters needed, in form of text.

Constructor Summary

Constructors

Constructor	Description
PromptCommand(String command, String description, Consumer<List<String>> action, String... params)

Method Summary

Modifier and Type	Method	Description
void	executeAction(List<String> args)
String	generateHelpString()
String	getCommand()
List<String>	getParameterList()

Methods inherited from class java.lang.Object

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

Field Details

command

private final String command

Command key from the command line (comprehensive of the '--')

description

private final String description

Short description of the command

parameterList

private final List<String> parameterList

List of parameters needed, in form of text. The list can be used to check how many parameters must be present for this command (optional parameters are not supported)

action

private final Consumer<List<String>> action

Action corresponding to the command. The argument is the possible list of arguments for that command

Constructor Details

PromptCommand

public PromptCommand(String command,
 String description,
 Consumer<List<String>> action,
 String... params)

Method Details

getCommand

public String getCommand()

Returns:

Command key from the command line (comprehensive of the '--')

getParameterList

public List<String> getParameterList()

Returns:

List of parameters needed, in form of text. The list can be used to check how many parameters must be present for this command

executeAction

public void executeAction(List<String> args)
                   throws IllegalArgumentException

Throws:

IllegalArgumentException

generateHelpString

public String generateHelpString()

Returns:

A formatted string representing the command