org.jboss.forge.env

Class ConfigurationFacet

java.lang.Object

org.jboss.forge.project.facets.BaseFacet

org.jboss.forge.env.ConfigurationFacet

All Implemented Interfaces:

Facet

@Alias(value="forge.configuration.facet")
public class ConfigurationFacet
extends BaseFacet

This facet allows easy access to the project-scoped Configuration object

Author:

George Gastaldi

Field Summary

Fields inherited from class org.jboss.forge.project.facets.BaseFacet

project

Constructor Summary

Constructors

Constructor and Description
ConfigurationFacet(ConfigurationFactory configurationFactory)

Method Summary

Methods

Modifier and Type	Method and Description
Configuration	getConfiguration()
boolean	install() Perform necessary setup for this Facet to be considered installed in the given Project.
boolean	isInstalled() Return true if the Facet is available for the given Project, false if otherwise.

Methods inherited from class org.jboss.forge.project.facets.BaseFacet

equals, getProject, hashCode, setProject, uninstall

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurationFacet

@Inject
public ConfigurationFacet(ConfigurationFactory configurationFactory)

Method Detail

getConfiguration

public Configuration getConfiguration()

install

public boolean install()

Description copied from interface: Facet

Perform necessary setup for this Facet to be considered installed in the given Project. This method should NOT register the facet; facet registration is handled by the project if installation is successful.

Returns:

true if installation was successful, false if not.

isInstalled

public boolean isInstalled()

Description copied from interface: Facet

Return true if the Facet is available for the given Project, false if otherwise.