org.jboss.forge.scaffoldx
Interface ScaffoldProvider

All Superinterfaces:

Facet

public interface ScaffoldProvider
extends Facet

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

Author:

Lincoln Baxter, III

Method Summary

List<Resource<?>>	generateFrom(List<Resource<?>> resource, String targetDir, boolean overwrite) Generate a set of create, read, update, delete pages for the given collection of resources Resource.
AccessStrategy	getAccessStrategy() Get the AccessStrategy for this ScaffoldProvider.
TemplateStrategy	getTemplateStrategy() Get the TemplateStrategy for this ScaffoldProvider.
List<Resource<?>>	setup(String targetDir, boolean overwrite, boolean installTemplates) Set up this scaffold provider, installing any necessary Facet or Plugin implementations as necessary.

Methods inherited from interface org.jboss.forge.project.Facet

getProject, install, isInstalled, setProject, uninstall

Method Detail

setup

List<Resource<?>> setup(String targetDir,
                        boolean overwrite,
                        boolean installTemplates)

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<Resource<?>> generateFrom(List<Resource<?>> resource,
                               String targetDir,
                               boolean overwrite)

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.

getAccessStrategy

AccessStrategy getAccessStrategy()

Get the AccessStrategy for this ScaffoldProvider.

getTemplateStrategy

TemplateStrategy getTemplateStrategy()

Get the TemplateStrategy for this ScaffoldProvider.