org.bukkit.command.defaults
Class HelpCommand

java.lang.Object
  extended by org.bukkit.command.Command
      extended by org.bukkit.command.defaults.VanillaCommand
          extended by org.bukkit.command.defaults.HelpCommand

public class HelpCommand
extends VanillaCommand


Field Summary
 
Fields inherited from class org.bukkit.command.Command
description, usageMessage
 
Constructor Summary
HelpCommand()
           
 
Method Summary
protected static int damerauLevenshteinDistance(String s1, String s2)
          Computes the Dameraur-Levenshtein Distance between two strings.
 boolean execute(CommandSender sender, String currentAlias, String[] args)
          Executes the command, returning its success
protected  HelpTopic findPossibleMatches(String searchString)
           
 boolean matches(String input)
           
 List<String> tabComplete(CommandSender sender, String alias, String[] args)
          Executed on tab completion for this command, returning a list of options the player can tab through.
 
Methods inherited from class org.bukkit.command.defaults.VanillaCommand
getDouble, getDouble, getInteger
 
Methods inherited from class org.bukkit.command.Command
broadcastCommandMessage, broadcastCommandMessage, getAliases, getDescription, getLabel, getName, getPermission, getPermissionMessage, getUsage, isRegistered, register, setAliases, setDescription, setLabel, setPermission, setPermissionMessage, setUsage, tabComplete, testPermission, testPermissionSilent, toString, unregister
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HelpCommand

public HelpCommand()
Method Detail

execute

public boolean execute(CommandSender sender,
                       String currentAlias,
                       String[] args)
Description copied from class: Command
Executes the command, returning its success

Specified by:
execute in class Command
Parameters:
sender - Source object which is executing this command
currentAlias - The alias of the command used
args - All arguments passed to the command, split via ' '
Returns:
true if the command was successful, otherwise false

matches

public boolean matches(String input)
Overrides:
matches in class VanillaCommand

tabComplete

public List<String> tabComplete(CommandSender sender,
                                String alias,
                                String[] args)
Description copied from class: Command
Executed on tab completion for this command, returning a list of options the player can tab through.

Overrides:
tabComplete in class Command
Parameters:
sender - Source object which is executing this command
alias - the alias being used
args - All arguments passed to the command, split via ' '
Returns:
a list of tab-completions for the specified arguments. This will never be null. List may be immutable.

findPossibleMatches

protected HelpTopic findPossibleMatches(String searchString)

damerauLevenshteinDistance

protected static int damerauLevenshteinDistance(String s1,
                                                String s2)
Computes the Dameraur-Levenshtein Distance between two strings. Adapted from the algorithm at Wikipedia: Damerau–Levenshtein distance

Parameters:
s1 - The first string being compared.
s2 - The second string being compared.
Returns:
The number of substitutions, deletions, insertions, and transpositions required to get from s1 to s2.


Copyright © 2013. All Rights Reserved.