org.jboss.forge.maven.facets
Class MavenMetadataFacet

java.lang.Object
  org.jboss.forge.project.facets.BaseFacet
      org.jboss.forge.maven.facets.MavenMetadataFacet

All Implemented Interfaces:

Facet, MetadataFacet

@Dependent
@Alias(value="forge.maven.MetadataFacet")
@RequiresFacet(value=MavenCoreFacet.class)
public class MavenMetadataFacet
extends BaseFacet
implements MetadataFacet

Author:

Lincoln Baxter, III

Constructor Summary

MavenMetadataFacet()

Method Summary

Dependency	getOutputDependency()
Project	getProject() Return the Project instance on which this Facet operates.
String	getProjectName()
String	getProjectVersion()
String	getTopLevelPackage()
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.
void	setProject(Project project) Initialize this Facet for operation on the given Project.
void	setProjectName(String name)
void	setTopLevelPackage(String groupId)

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

equals, hashCode, uninstall

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.forge.project.Facet

uninstall

Constructor Detail

MavenMetadataFacet

public MavenMetadataFacet()

Method Detail

getProjectName

public String getProjectName()

Specified by:

getProjectName in interface MetadataFacet

getProjectVersion

public String getProjectVersion()

Specified by:

getProjectVersion in interface MetadataFacet

getProject

public Project getProject()

Description copied from interface: Facet

Return the Project instance on which this Facet operates.

Specified by:

getProject in interface Facet

Overrides:

getProject in class BaseFacet

setProject

public void setProject(Project project)

Description copied from interface: Facet

Initialize this Facet for operation on the given Project. This method is responsible for ensuring that the Facet instance is ready for use, and must be called before any other methods.

Specified by:

setProject in interface Facet

Overrides:

setProject in class BaseFacet

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.

Specified by:

install in interface Facet

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.

Specified by:

isInstalled in interface Facet

setProjectName

public void setProjectName(String name)

Specified by:

setProjectName in interface MetadataFacet

setTopLevelPackage

public void setTopLevelPackage(String groupId)

Specified by:

setTopLevelPackage in interface MetadataFacet

getTopLevelPackage

public String getTopLevelPackage()

Specified by:

getTopLevelPackage in interface MetadataFacet

getOutputDependency

public Dependency getOutputDependency()

Specified by:

getOutputDependency in interface MetadataFacet