org.jboss.forge.addon.projects.facets

Interface WebResourcesFacet

All Superinterfaces:

Facet<Project>, ProjectFacet

public interface WebResourcesFacet
extends ProjectFacet

A Facet containing APIs to interact with Java Web Projects

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
FileResource<?>	createWebResource(char[] bytes, String relativeFilename) Deprecated. use getWebResource(String) and call WriteableResource.setContents(char[])
FileResource<?>	createWebResource(String render, String relativeFilename) Deprecated. use getWebResource(String) and call WriteableResource.setContents(String)
FileResource<?>	getWebResource(String relativePath) Get the given FileResource relative to the project Web Root directory: getWebRootDirectory()
List<DirectoryResource>	getWebRootDirectories() Get a list containing all possible Web Root DirectoryResources for the current project.
DirectoryResource	getWebRootDirectory() Get the default Web Root directory (this is the DirectoryResource containing resources to be deployed to the web-root URL when the application is published.
void	visitWebResources(ResourceVisitor visitor) Recursively loops over all the resource directories and for each file it finds, calls the visitor.

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

getFaceted, install, isInstalled, uninstall

Method Detail

getWebRootDirectory

DirectoryResource getWebRootDirectory()

Get the default Web Root directory (this is the DirectoryResource containing resources to be deployed to the web-root URL when the application is published. (E.g. In a maven project, files in the /project/src/main/webapp directory are typically published to the root URL: http://localhost:8080/project/ root directory. In an eclipse project, this folder is typically located by default at: /project/WebContent/.)

getWebRootDirectories

List<DirectoryResource> getWebRootDirectories()

Get a list containing all possible Web Root DirectoryResources for the current project.

createWebResource

@Deprecated
FileResource<?> createWebResource(char[] bytes,
                                           String relativeFilename)

Deprecated. use getWebResource(String) and call WriteableResource.setContents(char[])

At the given path/filename relative to the project Web Root directory: getWebRootDirectory() - create a FileResource containing the given bytes.

Returns:

a handle to the FileResource that was created.

createWebResource

@Deprecated
FileResource<?> createWebResource(String render,
                                           String relativeFilename)

Deprecated. use getWebResource(String) and call WriteableResource.setContents(String)

At the given path/filename relative to the project Web Root directory: getWebRootDirectory() - create a FileResource containing the given String.

Returns:

a handle to the FileResource that was created.

getWebResource

FileResource<?> getWebResource(String relativePath)

Get the given FileResource relative to the project Web Root directory: getWebRootDirectory()

visitWebResources

void visitWebResources(ResourceVisitor visitor)

Recursively loops over all the resource directories and for each file it finds, calls the visitor.

Parameters:

visitor - The ResourceVisitor that processes all the found files. Cannot be null.