org.jboss.forge.addon.templates.facets

Interface TemplateFacet

All Superinterfaces:

Facet<Project>, ProjectFacet

public interface TemplateFacet
extends ProjectFacet

A Facet for template resource directories. The Facet allows templates from multiple sources/addons (referred to as providers) to be installed in a directory in the project structure. For instance, templates from the javaee addon could be installed into the 'javaee' sub-directory, while templates from the angularjs addon could be installed into the 'angularjs' sub-directory. The name of the provider is determined by the provider, and only serves as a qualifier to locate templates that may be similarly named. Providers are expected to use unique qualifiers; fully-qualified provider names are recommended.

Author:

Vineet Reynolds

Method Summary

Methods

Modifier and Type	Method and Description
FileResource<?>	getResource(String path) Return the FileResource at the given path relative to getRootTemplateDirectory().
DirectoryResource	getRootTemplateDirectory() Get the DirectoryResource representing the directory this Project uses to store templates across all providers.

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

getFaceted, install, isInstalled, uninstall

Method Detail

getRootTemplateDirectory

DirectoryResource getRootTemplateDirectory()

Get the DirectoryResource representing the directory this Project uses to store templates across all providers.

getResource

FileResource<?> getResource(String path)

Return the FileResource at the given path relative to getRootTemplateDirectory(). 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.

Parameters:

path - The path to the template