Package redempt.ordinate.help

Class HelpPage<T>

java.lang.Object

redempt.ordinate.help.HelpPage<T>

Type Parameters:

T - The sender type

public class HelpPage<T>
extends Object

Represents a collection of help entries, one for each command

Constructor Summary

Constructors

Constructor	Description
HelpPage(Map<Command<T>,HelpEntry<T>> entries)

Method Summary

Modifier and Type	Method	Description
Collection<HelpEntry<T>>	getAll()
HelpEntry<T>	getHelp(Command<T> command)	Gets the help entry for a given command
HelpEntry<T>[]	getHelpRecursive(Command<T> command, boolean filterDescriptionless)	Gets the help entry for a given command and all of its subcommands recursively

Methods inherited from class java.lang.Object

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

Constructor Details

HelpPage

public HelpPage(Map<Command<T>,HelpEntry<T>> entries)

Method Details

getHelp

public HelpEntry<T> getHelp(Command<T> command)

Gets the help entry for a given command

Parameters:

command - The command

Returns:

The help entry

getHelpRecursive

public HelpEntry<T>[] getHelpRecursive(Command<T> command,
 boolean filterDescriptionless)

Gets the help entry for a given command and all of its subcommands recursively

Parameters:

command - The command

filterDescriptionless - Whether commands that have no description should be removed from the results

Returns:

The help entries

getAll

public Collection<HelpEntry<T>> getAll()

Returns:

All available help entries