org.bukkit.conversations
Class FixedSetPrompt
java.lang.Object
org.bukkit.conversations.ValidatingPrompt
org.bukkit.conversations.FixedSetPrompt
- All Implemented Interfaces:
- Cloneable, Prompt
public abstract class FixedSetPrompt
- extends ValidatingPrompt
FixedSetPrompt is the base class for any prompt that requires a fixed set response from the user.
Constructor Summary |
FixedSetPrompt(String... fixedSet)
Creates a FixedSetPrompt from a set of strings. |
Method Summary |
protected String |
formatFixedSet()
Utility function to create a formatted string containing all the options declared in the constructor. |
protected boolean |
isInputValid(ConversationContext context,
String input)
Override this method to check the validity of the player's input. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
fixedSet
protected List<String> fixedSet
FixedSetPrompt
public FixedSetPrompt(String... fixedSet)
- Creates a FixedSetPrompt from a set of strings.
foo = new FixedSetPrompt("bar", "cheese", "panda");
- Parameters:
fixedSet
- A fixed set of strings, one of which the user must type.
isInputValid
protected boolean isInputValid(ConversationContext context,
String input)
- Description copied from class:
ValidatingPrompt
- Override this method to check the validity of the player's input.
- Specified by:
isInputValid
in class ValidatingPrompt
- Parameters:
context
- Context information about the conversation.input
- The player's raw console input.
- Returns:
- True or false depending on the validity of the input.
formatFixedSet
protected String formatFixedSet()
- Utility function to create a formatted string containing all the options declared in the constructor.
- Returns:
- the options formatted like "[bar, cheese, panda]" if bar, cheese, and panda were the options used
Copyright © 2013. All Rights Reserved.