org.jboss.forge.addon.projects.facets

Interface ResourcesFacet

All Superinterfaces:

Facet<Project>, ProjectFacet

public interface ResourcesFacet
extends ProjectFacet

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
FileResource<?>	createResource(char[] bytes, String relativeFilename) Deprecated. use getResource(String) and call WriteableResource.setContents(char[])
FileResource<?>	createTestResource(char[] bytes, String relativeFilename) Deprecated. use getTestResource(String) and call WriteableResource.setContents(char[])
FileResource<?>	getResource(String relativePath) Return the FileResource at the given path relative to getResourceDirectory().
List<DirectoryResource>	getResourceDirectories() Get a list of DirectoryResources representing the directories this project uses to contain Project non-source documents (such as configuration files.)
DirectoryResource	getResourceDirectory() Get the DirectoryResource representing the folder this Project uses to store package-able, non-source documents (such as configuration files.)
FileResource<?>	getTestResource(String relativePath) Attempt to locate a FileResource at the given path relative to getTestResourceDirectory().
DirectoryResource	getTestResourceDirectory() Get the DirectoryResource representing the folder this Project uses to store test-scoped non-source documents (such as configuration files.) Files in this directory will never be packaged or deployed except when running Unit Tests.
void	visitResources(ResourceVisitor visitor) Recursively loops over all the resource directories and for each file it finds, calls the visitor.
void	visitTestResources(ResourceVisitor visitor) Recursively loops over all the test 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

getResourceDirectories

List<DirectoryResource> getResourceDirectories()

Get a list of DirectoryResources representing the directories this project uses to contain Project non-source documents (such as configuration files.)

getResourceDirectory

DirectoryResource getResourceDirectory()

Get the DirectoryResource representing the folder this Project uses to store package-able, non-source documents (such as configuration files.)

getTestResourceDirectory

DirectoryResource getTestResourceDirectory()

Get the DirectoryResource representing the folder this Project uses to store test-scoped non-source documents (such as configuration files.) Files in this directory will never be packaged or deployed except when running Unit Tests.

createResource

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

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

At the given path/filename relative to the project resources directory: getResourceDirectory() - create a file containing the given bytes.

Returns:

a handle to the FileResource that was created.

createTestResource

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

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

At the given path/filename relative to the project test resources directory: getTestResourceDirectory() - create a file containing the given bytes.

Returns:

a handle to the FileResource that was created.

getResource

FileResource<?> getResource(String relativePath)

Return the FileResource at the given path relative to getResourceDirectory(). The FileResource object is returned regardless of whether the target actually exists. To determine if the file exists, you should call Resource.exists() on the return value of this method.

getTestResource

FileResource<?> getTestResource(String relativePath)

Attempt to locate a FileResource at the given path relative to getTestResourceDirectory(). The FileResource object is returned regardless of whether the target actually exists. To determine if the file exists, you should call Resource.exists() on the return value of this method.

visitResources

void visitResources(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.

visitTestResources

void visitTestResources(ResourceVisitor visitor)

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

Parameters:

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