co.aikar.commands

Class CommandHelp

java.lang.Object

co.aikar.commands.CommandHelp

public class CommandHelp
extends Object

Constructor Summary

Constructors

Constructor and Description
CommandHelp(CommandManager manager, co.aikar.commands.RootCommand rootCommand, CommandIssuer issuer)

Method Summary

Modifier and Type	Method and Description
String	getCommandName()
String	getCommandPrefix()
List<HelpEntry>	getHelpEntries()
CommandIssuer	getIssuer()
CommandManager	getManager()
int	getPage()
int	getPerPage()
List<String>	getSearch()
HelpEntry	getSelectedEntry()
int	getTotalPages()
int	getTotalResults()
boolean	isExactMatch(String command)
boolean	isLastPage()
void	setPage(int page)
void	setPage(int page, int perPage)
void	setPerPage(int perPage)
void	setSearch(List<String> search)
void	showDetailedHelp(HelpEntry entry, CommandIssuer issuer)
void	showHelp()
void	showHelp(CommandIssuer issuer)
protected void	updateSearchScore(HelpEntry help)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandHelp

public CommandHelp(CommandManager manager,
                   co.aikar.commands.RootCommand rootCommand,
                   CommandIssuer issuer)

Method Detail

updateSearchScore

protected void updateSearchScore(HelpEntry help)

getManager

public CommandManager getManager()

isExactMatch

public boolean isExactMatch(String command)

showHelp

public void showHelp()

showHelp

public void showHelp(CommandIssuer issuer)

showDetailedHelp

public void showDetailedHelp(HelpEntry entry,
                             CommandIssuer issuer)

getHelpEntries

public List<HelpEntry> getHelpEntries()

setPerPage

public void setPerPage(int perPage)

setPage

public void setPage(int page)

setPage

public void setPage(int page,
                    int perPage)

setSearch

public void setSearch(List<String> search)

getIssuer

public CommandIssuer getIssuer()

getCommandName

public String getCommandName()

getCommandPrefix

public String getCommandPrefix()

getPage

public int getPage()

getPerPage

public int getPerPage()

getSearch

public List<String> getSearch()

getSelectedEntry

public HelpEntry getSelectedEntry()

getTotalResults

public int getTotalResults()

getTotalPages

public int getTotalPages()

isLastPage

public boolean isLastPage()