Package org.elypia.commandler.newb

Class DefaultHelpController

java.lang.Object

org.elypia.commandler.newb.DefaultHelpController

@StandardController
public class DefaultHelpController
extends Object

The default help module, this is an optional module one can add to provide some basic help functionality. This is pre-implemented it can only be created with knowledge of Commandler as a framework, which we're not expecting new consumers of the API to immediately be able to follow. You'll need to ensure you have a Messenger implementation for the following types to use this effectively:

• CommandModel
• GroupModel
• ControllerModel

Field Summary

Fields

Modifier and Type	Field	Description
protected org.elypia.commandler.CommandlerExtension	commandlerExtension
protected org.elypia.commandler.i18n.CommandlerMessageResolver	messageResolver

Constructor Summary

Constructors

Constructor	Description
DefaultHelpController(org.elypia.commandler.CommandlerExtension commandlerExtension, org.elypia.commandler.i18n.CommandlerMessageResolver messageResolver)

Method Summary

Modifier and Type	Method	Description
org.elypia.commandler.models.AllGroupsModel	getAllGroups()
org.elypia.commandler.models.ControllerModel	getControllerHelp(org.elypia.commandler.metadata.MetaController controller)	The default help command for a Controller, this should use the MetaController around this Controller to display helpful information to the user.
Object	getGroup(String query)
protected List<org.elypia.commandler.models.PropertyModel>	getLocalizedPublicProperties(org.elypia.commandler.metadata.MetaComponent metaComponent)

Methods inherited from class java.lang.Object

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

Field Detail

commandlerExtension

protected final org.elypia.commandler.CommandlerExtension commandlerExtension

messageResolver

protected final org.elypia.commandler.i18n.CommandlerMessageResolver messageResolver

Constructor Detail

DefaultHelpController

@Inject
public DefaultHelpController(org.elypia.commandler.CommandlerExtension commandlerExtension,
                             org.elypia.commandler.i18n.CommandlerMessageResolver messageResolver)

Method Detail

getAllGroups

@StandardCommand(isDefault=true)
public org.elypia.commandler.models.AllGroupsModel getAllGroups()

getGroup

@StandardCommand
public Object getGroup(@Param
                       String query)

getControllerHelp

@StandardCommand
public org.elypia.commandler.models.ControllerModel getControllerHelp(@Param
                                                                      org.elypia.commandler.metadata.MetaController controller)

The default help command for a Controller, this should use the MetaController around this Controller to display helpful information to the user.

Parameters:

controller - The MetaController to get commands for.

Returns:

The message to send to the end user.

getLocalizedPublicProperties

protected List<org.elypia.commandler.models.PropertyModel> getLocalizedPublicProperties(org.elypia.commandler.metadata.MetaComponent metaComponent)