ListArgumentNode

java.lang.Object

me.efekos.simpler.commands.node.CommandNode

me.efekos.simpler.commands.node.ArgumentNode

me.efekos.simpler.commands.node.impl.ListArgumentNode

Direct Known Subclasses:: EnumArgumentNode

public class ListArgumentNode extends ArgumentNode

An example of custom ArgumentNodes. Allows player to choose an argument from the list given.

Constructor Summary

Constructors

Constructor

Description

ListArgumentNode(String... list)

Creates a new node.

ListArgumentNode(List<String> list, CommandNode... children)

Creates a new node.
Method Summary

Modifier and Type

Method

Description

boolean

isCorrect(String given)

Checks for a given argument and ensures that the argument is correct.

List<String>

suggest(org.bukkit.command.CommandSender sender, List<String> args)

Provides a list that can be added to the final list of tab completion.

Methods inherited from class me.efekos.simpler.commands.node.CommandNode
addChild, addChild, getChildren, getConsoleExecutive, getDescription, getExecutive, getParent, getPermission, setConsoleExecutive, setDescription, setExecutive, setParent, setPermission

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ListArgumentNode
  
  public ListArgumentNode(String... list)
  
  Creates a new node.
  
  Parameters:
  
  list - Values that this argument can have.
- ListArgumentNode
  
  public ListArgumentNode(List<String> list, CommandNode... children)
  
  Creates a new node.
  
  Parameters:
  
  list - List of the values that this argument can have.
  
  children - Any child node to add to this node if you would like to. You can use CommandNode.addChild(CommandNode) later.
Method Details
- isCorrect
  
  public boolean isCorrect(String given)
  
  Checks for a given argument and ensures that the argument is correct.
  
  Specified by:
  
  isCorrect in class ArgumentNode
  
  Parameters:
  
  given - Argument that was given for this node.
  
  Returns:
  
  Whether the argument is correct or not.
- suggest
  
  public List<String> suggest(org.bukkit.command.CommandSender sender, List<String> args)
  
  Provides a list that can be added to the final list of tab completion.
  
  Specified by:
  
  suggest in class CommandNode
  
  Parameters:
  
  sender - Sender that needs a tab completion. Probably a Player since console doesn't need a tab completion.
  
  args - List of the other arguments given by the sender.
  
  Returns:
  
  A list for tab completion.