org.jboss.forge.scaffold
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<?>>	generateFromEntity(String targetDir, Resource<?> template, org.jboss.forge.parser.java.JavaClass entity, boolean overwrite) Generate a set of create, read, update, delete pages for a given JPA entity JavaClass.
List<Resource<?>>	generateIndex(String targetDir, Resource<?> template, boolean overwrite) Create and configure the index pages for use in this application.
List<Resource<?>>	generateTemplates(String targetDir, boolean overwrite) Generate a base set of templates for use in generating resources.
AccessStrategy	getAccessStrategy() Get the AccessStrategy for this ScaffoldProvider.
List<Resource<?>>	getGeneratedResources(String targetDir) Attempt to locate all Resources generated by this ScaffoldProvider.
TemplateStrategy	getTemplateStrategy() Get the TemplateStrategy for this ScaffoldProvider.
List<Resource<?>>	setup(String targetDir, Resource<?> template, boolean overwrite) 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,
                        Resource<?> template,
                        boolean overwrite)

Set up this scaffold provider, installing any necessary Facet or Plugin implementations as necessary. Use the given Resource as a template.

generateTemplates

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

Generate a base set of templates for use in generating resources.

generateIndex

List<Resource<?>> generateIndex(String targetDir,
                                Resource<?> template,
                                boolean overwrite)

Create and configure the index pages for use in this application. Use the given Resource as a template.

generateFromEntity

List<Resource<?>> generateFromEntity(String targetDir,
                                     Resource<?> template,
                                     org.jboss.forge.parser.java.JavaClass entity,
                                     boolean overwrite)

Generate a set of create, read, update, delete pages for a given JPA entity JavaClass.

getGeneratedResources

List<Resource<?>> getGeneratedResources(String targetDir)

Attempt to locate all Resources generated by this ScaffoldProvider.

getAccessStrategy

AccessStrategy getAccessStrategy()

Get the AccessStrategy for this ScaffoldProvider.

getTemplateStrategy

TemplateStrategy getTemplateStrategy()

Get the TemplateStrategy for this ScaffoldProvider.