org.jboss.forge.addon.script.ui

Class RunCommand

java.lang.Object

org.jboss.forge.addon.ui.command.AbstractUICommand

org.jboss.forge.addon.shell.ui.AbstractShellCommand

org.jboss.forge.addon.script.ui.RunCommand

All Implemented Interfaces:

UICommand

public class RunCommand
extends AbstractShellCommand

Implementation of the "run" command

Author:

Lincoln Baxter, III

Constructor Summary

Constructors

Constructor and Description
RunCommand()

Method Summary

Modifier and Type	Method and Description
Result	execute(UIExecutionContext context) Called when the UICommand should be executed.
UICommandMetadata	getMetadata(UIContext context)
void	initializeUI(UIBuilder builder) Called before rendering the UI.
void	validate(UIValidationContext validator) Validate the current UICommand.

Methods inherited from class org.jboss.forge.addon.shell.ui.AbstractShellCommand

isEnabled, isEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

RunCommand

public RunCommand()

Method Detail

getMetadata

public UICommandMetadata getMetadata(UIContext context)

Specified by:

getMetadata in interface UICommand

Overrides:

getMetadata in class AbstractShellCommand

Parameters:

context - the UIContext provided by the UI implementation, never null

Returns:

The Metadata of this command. Should never return null

initializeUI

public void initializeUI(UIBuilder builder)
                  throws Exception

Description copied from interface: UICommand

Called before rendering the UI. Should add the InputComponent objects to be displayed in the provided UIBuilder

Parameters:

builder - The builder on which the UI should be built upon. Never null

Throws:

Exception - if anything wrong happens

validate

public void validate(UIValidationContext validator)

Description copied from interface: UICommand

Validate the current UICommand.

Specified by:

validate in interface UICommand

Overrides:

validate in class AbstractUICommand

execute

public Result execute(UIExecutionContext context)
               throws Exception

Description copied from interface: UICommand

Called when the UICommand should be executed. This method should NEVER execute if UICommand.isEnabled(UIContext) returns false and UICommand.validate(UIValidationContext) contains validation errors

Parameters:

context - the context of the interaction

Returns:

the result of this execution (see the Results class)

Throws:

Exception - if anything wrong happens