org.jboss.forge.addon.ui.command

Interface CommandFactory

public interface CommandFactory

Responsible for producing UICommand objects from all registered CommandProvider instances.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
UICommand	getCommandByName(UIContext context, String name) Get a UICommand instance given its name in the given UIContext
String	getCommandName(UIContext context, UICommand cmd) Return the UICommand name for a given UIContext
Set<String>	getCommandNames(UIContext context) Get all command names enabled for the given UIContext
Iterable<UICommand>	getCommands() Get all UICommand instances from all available CommandProvider services.
Set<String>	getEnabledCommandNames(UIContext context) Get all enabled command names enabled for the given UIContext
UICommand	getNewCommandByName(UIContext context, String name) Get an un-cached UICommand instance given its name in the given UIContext

Method Detail

getCommands

Iterable<UICommand> getCommands()

Get all UICommand instances from all available CommandProvider services. The underlying collection of UICommands is very likely be cached, and thus invoking operations directly on them is not recommended for safety. Consecutive invocations may be performed on the same UICommand instance, instead of different instances. It is recommended to create a new UICommand when required. This can be done through the getNewCommandByName(UIContext, String) method.

getEnabledCommandNames

Set<String> getEnabledCommandNames(UIContext context)

Get all enabled command names enabled for the given UIContext

getCommandNames

Set<String> getCommandNames(UIContext context)

Get all command names enabled for the given UIContext

getCommandByName

UICommand getCommandByName(UIContext context,
                           String name)

Get a UICommand instance given its name in the given UIContext

getCommandName

String getCommandName(UIContext context,
                      UICommand cmd)

Return the UICommand name for a given UIContext

getNewCommandByName

UICommand getNewCommandByName(UIContext context,
                              String name)

Get an un-cached UICommand instance given its name in the given UIContext