org.jboss.forge.addon.ui.controller

Interface CommandController

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

SingleCommandController, WizardCommandController

public interface CommandController
extends AutoCloseable

A Controller for a specific UICommand

Author:

George Gastaldi, Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canExecute() Returns true if UICommand.execute(org.jboss.forge.addon.ui.context.UIExecutionContext) can be called.
Result	execute() Calls UICommand.execute(org.jboss.forge.addon.ui.context.UIExecutionContext).
UICommand	getCommand()
UIContext	getContext()
Map<String,InputComponent<?,?>>	getInputs() Returns a Map of InputComponent instances for this command.
UICommandMetadata	getMetadata()
Object	getValueFor(String inputName) Gets the value of InputComponent with the given name.
void	initialize() Initializes this controller by calling UICommand.initializeUI(org.jboss.forge.addon.ui.context.UIBuilder) on the underlying UICommand instance.
boolean	isEnabled()
boolean	isInitialized() Returns true if initialize() has been called.
boolean	isValid() Returns true if the validate() method contains no UIMessage instances with an ERROR severity
CommandController	setValueFor(String inputName, Object value) Sets the value of InputComponent with the given name.
List<UIMessage>	validate() Calls UICommand.validate(org.jboss.forge.addon.ui.context.UIValidationContext), and InputComponent.validate(org.jboss.forge.addon.ui.context.UIValidationContext) for each enabled InputComponent.
List<UIMessage>	validate(InputComponent<?,?> input) Calls InputComponent.validate(org.jboss.forge.addon.ui.context.UIValidationContext) for the given InputComponent belonging to the underlying UICommand.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

initialize

void initialize()
                throws Exception

Initializes this controller by calling UICommand.initializeUI(org.jboss.forge.addon.ui.context.UIBuilder) on the underlying UICommand instance.

Throws:

Exception - if problems occurred during initialization.

isInitialized

boolean isInitialized()

Returns true if initialize() has been called.

execute

Result execute()
               throws Exception

Calls UICommand.execute(org.jboss.forge.addon.ui.context.UIExecutionContext). Causes available CommandExecutionListener instances to be called.

Throws:

IllegalStateException - if initialize() has not been called before invoking this method.

Exception - if problems occurred during initialization

validate

List<UIMessage> validate()

Calls UICommand.validate(org.jboss.forge.addon.ui.context.UIValidationContext), and InputComponent.validate(org.jboss.forge.addon.ui.context.UIValidationContext) for each enabled InputComponent.

Throws:

IllegalStateException - if initialize() has not been called before invoking this method.

validate

List<UIMessage> validate(InputComponent<?,?> input)

Calls InputComponent.validate(org.jboss.forge.addon.ui.context.UIValidationContext) for the given InputComponent belonging to the underlying UICommand.

Throws:

IllegalStateException - if initialize() has not been called before invoking this method.

isValid

boolean isValid()

Returns true if the validate() method contains no UIMessage instances with an ERROR severity

Throws:

IllegalStateException - if initialize() has not been called before invoking this method.

setValueFor

CommandController setValueFor(String inputName,
                            Object value)
                              throws IllegalArgumentException

Sets the value of InputComponent with the given name.

Throws:

IllegalArgumentException - if no InputComponent with the given name exists

IllegalStateException - if initialize() has not been called before invoking this method.

getValueFor

Object getValueFor(String inputName)
                   throws IllegalArgumentException

Gets the value of InputComponent with the given name.

Throws:

IllegalArgumentException - if no InputComponent with the given name exists

IllegalStateException - if initialize() has not been called before invoking this method.

getInputs

Map<String,InputComponent<?,?>> getInputs()

Returns a Map of InputComponent instances for this command.

Throws:

IllegalStateException - if initialize() has not been called before invoking this method.

getMetadata

UICommandMetadata getMetadata()

Returns:

the result of the current UICommand.getMetadata(UIContext). Does not require initialization.

isEnabled

boolean isEnabled()

Returns:

if the current UICommand.isEnabled(UIContext) is true. Does not require initialization.

getCommand

UICommand getCommand()

Returns:

the underlying UICommand.

getContext

UIContext getContext()

Returns:

the underlying UIContext object.

canExecute

boolean canExecute()

Returns true if UICommand.execute(org.jboss.forge.addon.ui.context.UIExecutionContext) can be called.

Throws:

IllegalStateException - if initialize() has not been called before invoking this method.