org.jboss.forge.maven
Interface MavenCoreFacet

All Superinterfaces:

Facet

public interface MavenCoreFacet
extends Facet

Provides *DIRECT* access to a Project's Maven POM and Build artifacts. Should only be used by extremely low-level operations.

Author:

Lincoln Baxter, III

Method Summary

boolean	executeMaven(ShellPrintWriter out, String[] parameters) Execute a command using the native Maven installation.
boolean	executeMaven(String[] selected) Execute a command using the native Maven installation.
boolean	executeMavenEmbedded(PrintStream out, PrintStream err, String[] parameters) Execute a command using the embedded Maven shell, using the given PrintStreams for output and error output.
boolean	executeMavenEmbedded(String[] parameters) Execute a command using the embedded Maven shell.
org.apache.maven.project.ProjectBuildingResult	getFullProjectBuildingResult() Ask Maven to process this project's POM and return the resulting metadata.
DirectoryResource	getLocalRepositoryDirectory() Get the location of the currently configured local maven repository.
org.apache.maven.project.MavenProject	getMavenProject() Return the fully-resolved POM/MavenProject for this Maven enabled Project
org.apache.maven.project.ProjectBuildingResult	getPartialProjectBuildingResult() Ask Maven to process this project's POM and return the resulting metadata.
org.apache.maven.model.Model	getPOM() Get the current Maven POM file.
FileResource<?>	getPOMFile() Get the current Maven POM file.
void	setPOM(org.apache.maven.model.Model pom) Set the current Maven POM file (overwriting any existing POM)

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

getProject, install, isInstalled, setProject, uninstall

Method Detail

getPOM

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

Get the current Maven POM file.

getPOMFile

FileResource<?> getPOMFile()

Get the current Maven POM file.

setPOM

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

Set the current Maven POM file (overwriting any existing POM)

getPartialProjectBuildingResult

org.apache.maven.project.ProjectBuildingResult getPartialProjectBuildingResult()

Ask Maven to process this project's POM and return the resulting metadata. Do not build dependency hierarchy past the immediate POM.

**Warning!** Calling this method has serious performance implications! Avoid whenever possible!

getFullProjectBuildingResult

org.apache.maven.project.ProjectBuildingResult getFullProjectBuildingResult()

Ask Maven to process this project's POM and return the resulting metadata.

**Warning!** Calling this method has serious performance implications! Avoid whenever possible!

getMavenProject

org.apache.maven.project.MavenProject getMavenProject()

Return the fully-resolved POM/MavenProject for this Maven enabled Project

executeMavenEmbedded

boolean executeMavenEmbedded(String[] parameters)

Execute a command using the embedded Maven shell. Return the exit status code. 0 = success, anything else = failure.

executeMavenEmbedded

boolean executeMavenEmbedded(PrintStream out,
                             PrintStream err,
                             String[] parameters)

Execute a command using the embedded Maven shell, using the given PrintStreams for output and error output. Return the exit status code. 0 = success, anything else = failure.

executeMaven

boolean executeMaven(ShellPrintWriter out,
                     String[] parameters)

Execute a command using the native Maven installation. If native Maven is not available, fall back to the embedded Maven provider built in to Forge.

Returns:

executeMaven

boolean executeMaven(String[] selected)

Execute a command using the native Maven installation. If native Maven is not available, fall back to the embedded Maven provider built in to Forge.

getLocalRepositoryDirectory

DirectoryResource getLocalRepositoryDirectory()

Get the location of the currently configured local maven repository.