org.jboss.forge.addon.maven.projects

Interface MavenFacet

All Superinterfaces:

Facet<Project>, ProjectFacet, ProvidedProjectFacet

public interface MavenFacet
extends ProvidedProjectFacet

A ProjectFacet adding support for the Maven build system.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
boolean	executeMaven(List<String> parameters) Execute Maven with the given arguments.
boolean	executeMavenEmbedded(List<String> parameters) Execute Maven with the given arguments.
boolean	executeMavenEmbedded(List<String> parameters, PrintStream out, PrintStream err) Execute embedded Maven with the given arguments.
DirectoryResource	getLocalRepositoryDirectory() Returns a DirectoryResource representing the location of the current local Maven repository.
org.apache.maven.model.Model	getModel() Get the current Maven Model for this Project.
MavenModelResource	getModelResource() Get the MavenModelResource for this Project.
Map<String,String>	getProperties() Get a Map of all resolvable project properties.
boolean	isModelValid() Returns true if the underlying Project Model is in a build-able state.
String	resolveProperties(String value) Resolve Maven properties for the given input String, replacing occurrences of the `${property}` with their defined value.
void	setModel(org.apache.maven.model.Model pom) Set the current Maven Model for this Project.

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

getFaceted, install, isInstalled, uninstall

Method Detail

getModelResource

MavenModelResource getModelResource()

Get the MavenModelResource for this Project.

getModel

org.apache.maven.model.Model getModel()

Get the current Maven Model for this Project.

setModel

void setModel(org.apache.maven.model.Model pom)

Set the current Maven Model for this Project.

getProperties

Map<String,String> getProperties()

Get a Map of all resolvable project properties.

resolveProperties

String resolveProperties(String value)

Resolve Maven properties for the given input String, replacing occurrences of the `${property}` with their defined value.

executeMaven

boolean executeMaven(List<String> parameters)

Execute Maven with the given arguments. Attempt to use any native installation of Maven before falling back to Maven embedded.

Returns:

true on success or false on failure.

executeMavenEmbedded

boolean executeMavenEmbedded(List<String> parameters)

Execute Maven with the given arguments.

Returns:

true on success or false on failure.

executeMavenEmbedded

boolean executeMavenEmbedded(List<String> parameters,
                             PrintStream out,
                             PrintStream err)

Execute embedded Maven with the given arguments. Redirects the output and error output to the provided PrintStreams

Returns:

true on success or false on failure.

getLocalRepositoryDirectory

DirectoryResource getLocalRepositoryDirectory()

Returns a DirectoryResource representing the location of the current local Maven repository.

isModelValid

boolean isModelValid()

Returns true if the underlying Project Model is in a build-able state.