org.jboss.forge.addon.parser.java.ui

Class AbstractJavaSourceCommand<SOURCETYPE extends org.jboss.forge.roaster.model.source.JavaSource<?>>

java.lang.Object

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

org.jboss.forge.addon.projects.ui.AbstractProjectCommand

org.jboss.forge.addon.parser.java.ui.AbstractJavaSourceCommand<SOURCETYPE>

All Implemented Interfaces:

UICommand

@FacetConstraints(value=@FacetConstraint(value=JavaSourceFacet.class,type=REQUIRED))
public abstract class AbstractJavaSourceCommand<SOURCETYPE extends org.jboss.forge.roaster.model.source.JavaSource<?>>
extends AbstractProjectCommand

Author:

Lincoln Baxter, III, George Gastaldi

Constructor Summary

Constructors

Constructor and Description
AbstractJavaSourceCommand()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	calculateDefaultPackage(UIContext context)
SOURCETYPE	decorateSource(UIExecutionContext context, Project project, SOURCETYPE source) Override this method to do any necessary work to customize the generated JavaResource.
Result	execute(UIExecutionContext context) Called when the UICommand should be executed.
UICommandMetadata	getMetadata(UIContext context)
protected UIInput<String>	getNamed()
protected UIInput<Boolean>	getOverwrite()
protected ProjectFactory	getProjectFactory() Returns a reference to the ProjectFactory.
protected abstract Class<SOURCETYPE>	getSourceType() Get the JavaSource type for which this command should create a new source file.
protected UIInput<String>	getTargetPackage()
protected abstract String	getType() Get the type for which this command should create a new source file.
void	initializeUI(UIBuilder builder) Called before rendering the UI.
protected boolean	isProjectRequired() Implementations should return true if a Project is required in order for this command to execute.
void	validate(UIValidationContext validator) Validate the current UICommand.

Methods inherited from class org.jboss.forge.addon.projects.ui.AbstractProjectCommand

containsProject, getSelectedProject, getSelectedProject, isEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJavaSourceCommand

public AbstractJavaSourceCommand()

Method Detail

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

getMetadata

public UICommandMetadata getMetadata(UIContext context)

Specified by:

getMetadata in interface UICommand

Overrides:

getMetadata in class AbstractUICommand

Parameters:

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

Returns:

The Metadata of this command. Should never return null

getType

protected abstract String getType()

Get the type for which this command should create a new source file. ("Class", "Enum", "Interface", etc.)

getSourceType

protected abstract Class<SOURCETYPE> getSourceType()

Get the JavaSource type for which this command should create a new source file.

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

decorateSource

public SOURCETYPE decorateSource(UIExecutionContext context,
                        Project project,
                        SOURCETYPE source)
                                                                                     throws Exception

Override this method to do any necessary work to customize the generated JavaResource.

Throws:

Exception

isProjectRequired

protected boolean isProjectRequired()

Description copied from class: AbstractProjectCommand

Implementations should return true if a Project is required in order for this command to execute. If false, this command will run without a Project selected in the current UIContext. Returning true also enables the use of FacetConstraints on the implementation Class declaration.

Specified by:

isProjectRequired in class AbstractProjectCommand

getTargetPackage

protected UIInput<String> getTargetPackage()

getNamed

protected UIInput<String> getNamed()

getOverwrite

protected UIInput<Boolean> getOverwrite()

calculateDefaultPackage

protected String calculateDefaultPackage(UIContext context)

getProjectFactory

protected ProjectFactory getProjectFactory()

Description copied from class: AbstractProjectCommand

Returns a reference to the ProjectFactory.

Specified by:

getProjectFactory in class AbstractProjectCommand