org.jboss.forge.addon.scaffold.spi

Interface ScaffoldProvider

All Superinterfaces:

org.jboss.forge.addon.facets.Facet<org.jboss.forge.addon.projects.Project>, org.jboss.forge.addon.projects.ProjectFacet, org.jboss.forge.addon.ui.UIValidator

public interface ScaffoldProvider
extends org.jboss.forge.addon.projects.ProjectFacet, org.jboss.forge.addon.ui.UIValidator

Provides an implementation of Scaffolding for various UI code generation operations.

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
List<org.jboss.forge.addon.resource.Resource<?>>	generateFrom(Iterable<org.jboss.forge.addon.resource.Resource<?>> resources, ScaffoldContext scaffoldContext) Generate a set of create, read, update, delete pages for the given collection of resources Resource.
String	getDescription() Return the description for this ScaffoldProvider Ex: JavaServer Faces
String	getName() Return the name for this ScaffoldProvider Ex: faces
Class<? extends org.jboss.forge.addon.ui.wizard.UIWizardStep>	getSetupFlow() Return the UIWizardStep class that begins the scaffold setup of this type, if any.
boolean	needsOverwriteConfirmation(ScaffoldContext scaffoldContext) Needs overwrite confirmation ?
List<org.jboss.forge.addon.resource.Resource<?>>	setup(ScaffoldContext scaffoldContext) Set up this scaffold provider, installing any necessary Facet or Plugin implementations as necessary.

Methods inherited from interface org.jboss.forge.addon.facets.Facet

getFaceted, install, isInstalled, uninstall

Methods inherited from interface org.jboss.forge.addon.ui.UIValidator

validate

Method Detail

getName

String getName()

Return the name for this ScaffoldProvider Ex: faces

getDescription

String getDescription()

Return the description for this ScaffoldProvider Ex: JavaServer Faces

setup

List<org.jboss.forge.addon.resource.Resource<?>> setup(ScaffoldContext scaffoldContext)

Set up this scaffold provider, installing any necessary Facet or Plugin implementations as necessary. Install the templates in the provider to the src/main/templates directory of the project.

generateFrom

List<org.jboss.forge.addon.resource.Resource<?>> generateFrom(Iterable<org.jboss.forge.addon.resource.Resource<?>> resources,
                                                            ScaffoldContext scaffoldContext)

Generate a set of create, read, update, delete pages for the given collection of resources Resource. Note that any collection of Resource instances can be provided to the ScaffoldProvider. It is the responsibility of the ScaffoldProvider to verify whether it can act on the provided resource.

needsOverwriteConfirmation

boolean needsOverwriteConfirmation(ScaffoldContext scaffoldContext)

Needs overwrite confirmation ?

Parameters:

scaffoldContext -

Returns:

getSetupFlow

Class<? extends org.jboss.forge.addon.ui.wizard.UIWizardStep> getSetupFlow()

Return the UIWizardStep class that begins the scaffold setup of this type, if any.