org.eclipse.m2e.core.internal.project.registry

Class MavenProjectFacade

java.lang.Object

org.eclipse.m2e.core.internal.project.registry.MavenProjectFacade

All Implemented Interfaces:

java.io.Serializable, IMavenProjectFacade

public class MavenProjectFacade
extends java.lang.Object
implements IMavenProjectFacade, java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private ArtifactKey	artifactKey
private java.util.Set<ArtifactRepositoryRef>	artifactRepositories
private java.util.Set<ArtifactRef>	artifacts
private org.eclipse.core.runtime.IPath[]	compileSourceLocations
private static java.lang.String	CTX_EXECUTION_PLANS
private static java.lang.String	CTX_SETUP_EXECUTIONS
private java.lang.String	lifecycleMappingId
private ProjectRegistryManager	manager
private java.util.List<java.lang.String>	modules
private java.util.Map<MojoExecutionKey,java.util.List<IPluginExecutionMetadata>>	mojoExecutionMapping
private org.eclipse.core.runtime.IPath	outputLocation
private java.lang.String	packaging
private java.util.Set<ArtifactRepositoryRef>	pluginArtifactRepositories
private org.eclipse.core.resources.IFile	pom
private java.io.File	pomFile
static java.lang.String	PROP_CONFIGURATORS
static java.lang.String	PROP_LIFECYCLE_MAPPING
private ResolverConfiguration	resolverConfiguration
private org.eclipse.core.runtime.IPath[]	resourceLocations
private static long	serialVersionUID
private java.util.Map<java.lang.String,java.lang.Object>	sessionProperties
private org.eclipse.core.runtime.IPath[]	testCompileSourceLocations
private org.eclipse.core.runtime.IPath	testOutputLocation
private org.eclipse.core.runtime.IPath[]	testResourceLocations
private long[]	timestamp

Constructor Summary

Constructors

Constructor and Description
MavenProjectFacade(MavenProjectFacade other) Copy constructor.
MavenProjectFacade(ProjectRegistryManager manager, org.eclipse.core.resources.IFile pom, org.apache.maven.project.MavenProject mavenProject, ResolverConfiguration resolverConfiguration)

Method Summary

Modifier and Type	Method and Description
private static <T> T[]	arrayCopy(T[] a)
private static boolean	contains(java.lang.String[] goals, java.lang.String goal)
ArtifactKey	getArtifactKey()
java.util.Set<ArtifactRepositoryRef>	getArtifactRepositoryRefs()
org.eclipse.core.runtime.IPath[]	getCompileSourceLocations()
private static <T> T	getContextValue(org.apache.maven.project.MavenProject mavenProject, java.lang.String key)
java.util.List<org.apache.maven.plugin.MojoExecution>	getExecutionPlan(java.lang.String lifecycle, org.eclipse.core.runtime.IProgressMonitor monitor)
private java.util.Map<java.lang.String,java.util.List<org.apache.maven.plugin.MojoExecution>>	getExecutionPlans(org.eclipse.core.runtime.IProgressMonitor monitor) Maps LIFECYCLE_* to corresponding mojo executions.
org.eclipse.core.runtime.IPath	getFullPath()
org.eclipse.core.runtime.IPath	getFullPath(java.io.File file) Returns the full, absolute path of the given file relative to the workspace.
java.lang.String	getLifecycleMappingId()
org.apache.maven.project.MavenProject	getMavenProject() Returns cached MavenProject instance associated with this facade or null, if the cache has not been populated yet, for example right after workspace restart.
org.apache.maven.project.MavenProject	getMavenProject(org.eclipse.core.runtime.IProgressMonitor monitor) Lazy load and cache MavenProject instance
java.util.Set<ArtifactRef>	getMavenProjectArtifacts()
java.util.List<java.lang.String>	getMavenProjectModules()
private static long	getModificationStamp(org.eclipse.core.resources.IFile file)
org.apache.maven.plugin.MojoExecution	getMojoExecution(MojoExecutionKey mojoExecutionKey, org.eclipse.core.runtime.IProgressMonitor monitor) Returns fully setup MojoExecution instance bound to project build lifecycle that matches provided mojoExecutionKey.
java.util.Map<MojoExecutionKey,java.util.List<IPluginExecutionMetadata>>	getMojoExecutionMapping()
java.util.List<org.apache.maven.plugin.MojoExecution>	getMojoExecutions() Returns cached list of MojoExecutions bound to project's clean, default and site lifecycles.
java.util.List<org.apache.maven.plugin.MojoExecution>	getMojoExecutions(org.eclipse.core.runtime.IProgressMonitor monitor) Returns list of MojoExecutions bound to project's clean, default and site lifecycles.
java.util.List<org.apache.maven.plugin.MojoExecution>	getMojoExecutions(java.lang.String groupId, java.lang.String artifactId, org.eclipse.core.runtime.IProgressMonitor monitor, java.lang.String... goals) Returns list of fully setup MojoExecution instances bound to project build lifecycle that matche provided groupId, artifactId and (vararg) goals.
org.eclipse.core.runtime.IPath	getOutputLocation() Returns the full, absolute path of this project maven build output directory relative to the workspace or null if maven build output directory cannot be determined or outside of the workspace.
java.lang.String	getPackaging()
java.util.Set<ArtifactRepositoryRef>	getPluginArtifactRepositoryRefs()
org.eclipse.core.resources.IFile	getPom()
java.io.File	getPomFile()
org.eclipse.core.resources.IProject	getProject()
org.eclipse.core.runtime.IPath	getProjectRelativePath(java.lang.String resourceLocation) Returns project resource for given file system location or null the location is outside of project.
ResolverConfiguration	getResolverConfiguration()
org.eclipse.core.runtime.IPath[]	getResourceLocations() Returns project relative paths of resource directories
java.lang.Object	getSessionProperty(java.lang.String key)
private java.util.Map<MojoExecutionKey,org.apache.maven.plugin.MojoExecution>	getSetupMojoExecutions(org.eclipse.core.runtime.IProgressMonitor monitor) Returns cache of fully setup MojoExecution instances.
org.eclipse.core.runtime.IPath[]	getTestCompileSourceLocations()
org.eclipse.core.runtime.IPath	getTestOutputLocation() Returns the full, absolute path of this project maven build test output directory relative to the workspace or null if maven build output directory cannot be determined or outside of the workspace.
org.eclipse.core.runtime.IPath[]	getTestResourceLocations() Returns project relative paths of test resource directories
boolean	isStale()
private void	putSetupMojoExecution(java.util.Map<MojoExecutionKey,org.apache.maven.plugin.MojoExecution> setupMojoExecutions, MojoExecutionKey mojoExecutionKey, org.apache.maven.plugin.MojoExecution execution)
void	setLifecycleMappingId(java.lang.String lifecycleMappingId)
(package private) void	setMavenProjectArtifacts(org.apache.maven.project.MavenProject mavenProject)
void	setMojoExecutionMapping(java.util.Map<MojoExecutionKey,java.util.List<IPluginExecutionMetadata>> mojoExecutionMapping)
void	setSessionProperty(java.lang.String key, java.lang.Object value) Associates the value with the key in session (i.e.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

CTX_EXECUTION_PLANS

private static final java.lang.String CTX_EXECUTION_PLANS

CTX_SETUP_EXECUTIONS

private static final java.lang.String CTX_SETUP_EXECUTIONS

PROP_LIFECYCLE_MAPPING

public static final java.lang.String PROP_LIFECYCLE_MAPPING

PROP_CONFIGURATORS

public static final java.lang.String PROP_CONFIGURATORS

manager

private final ProjectRegistryManager manager

pom

private final org.eclipse.core.resources.IFile pom

pomFile

private final java.io.File pomFile

resolverConfiguration

private final ResolverConfiguration resolverConfiguration

timestamp

private final long[] timestamp

artifactKey

private final ArtifactKey artifactKey

modules

private final java.util.List<java.lang.String> modules

packaging

private final java.lang.String packaging

resourceLocations

private final org.eclipse.core.runtime.IPath[] resourceLocations

testResourceLocations

private final org.eclipse.core.runtime.IPath[] testResourceLocations

compileSourceLocations

private final org.eclipse.core.runtime.IPath[] compileSourceLocations

testCompileSourceLocations

private final org.eclipse.core.runtime.IPath[] testCompileSourceLocations

outputLocation

private final org.eclipse.core.runtime.IPath outputLocation

testOutputLocation

private final org.eclipse.core.runtime.IPath testOutputLocation

artifactRepositories

private final java.util.Set<ArtifactRepositoryRef> artifactRepositories

pluginArtifactRepositories

private final java.util.Set<ArtifactRepositoryRef> pluginArtifactRepositories

artifacts

private java.util.Set<ArtifactRef> artifacts

lifecycleMappingId

private java.lang.String lifecycleMappingId

mojoExecutionMapping

private java.util.Map<MojoExecutionKey,java.util.List<IPluginExecutionMetadata>> mojoExecutionMapping

sessionProperties

private transient java.util.Map<java.lang.String,java.lang.Object> sessionProperties

Constructor Detail

MavenProjectFacade

public MavenProjectFacade(ProjectRegistryManager manager,
                          org.eclipse.core.resources.IFile pom,
                          org.apache.maven.project.MavenProject mavenProject,
                          ResolverConfiguration resolverConfiguration)

MavenProjectFacade

public MavenProjectFacade(MavenProjectFacade other)

Copy constructor. Does NOT preserve session state.

Method Detail

arrayCopy

private static <T> T[] arrayCopy(T[] a)

getResourceLocations

public org.eclipse.core.runtime.IPath[] getResourceLocations()

Returns project relative paths of resource directories

Specified by:

getResourceLocations in interface IMavenProjectFacade

getTestResourceLocations

public org.eclipse.core.runtime.IPath[] getTestResourceLocations()

Returns project relative paths of test resource directories

Specified by:

getTestResourceLocations in interface IMavenProjectFacade

getCompileSourceLocations

public org.eclipse.core.runtime.IPath[] getCompileSourceLocations()

Specified by:

getCompileSourceLocations in interface IMavenProjectFacade

getTestCompileSourceLocations

public org.eclipse.core.runtime.IPath[] getTestCompileSourceLocations()

Specified by:

getTestCompileSourceLocations in interface IMavenProjectFacade

getProjectRelativePath

public org.eclipse.core.runtime.IPath getProjectRelativePath(java.lang.String resourceLocation)

Returns project resource for given file system location or null the location is outside of project.

Specified by:

getProjectRelativePath in interface IMavenProjectFacade

Parameters:

resourceLocation - absolute file system location

Returns:

IPath the full, absolute workspace path resourceLocation

getOutputLocation

public org.eclipse.core.runtime.IPath getOutputLocation()

Returns the full, absolute path of this project maven build output directory relative to the workspace or null if maven build output directory cannot be determined or outside of the workspace.

Specified by:

getOutputLocation in interface IMavenProjectFacade

getTestOutputLocation

public org.eclipse.core.runtime.IPath getTestOutputLocation()

Returns the full, absolute path of this project maven build test output directory relative to the workspace or null if maven build output directory cannot be determined or outside of the workspace.

Specified by:

getTestOutputLocation in interface IMavenProjectFacade

getFullPath

public org.eclipse.core.runtime.IPath getFullPath()

Specified by:

getFullPath in interface IMavenProjectFacade

getMavenProject

public org.apache.maven.project.MavenProject getMavenProject(org.eclipse.core.runtime.IProgressMonitor monitor)
                                                      throws org.eclipse.core.runtime.CoreException

Lazy load and cache MavenProject instance

Specified by:

getMavenProject in interface IMavenProjectFacade

Throws:

org.eclipse.core.runtime.CoreException

getMavenProject

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

Description copied from interface: IMavenProjectFacade

Returns cached MavenProject instance associated with this facade or null, if the cache has not been populated yet, for example right after workspace restart. Clients must use IMavenProjectFacade.getMavenProject(IProgressMonitor) unless they are prepared to deal with null return value.

Specified by:

getMavenProject in interface IMavenProjectFacade

getPackaging

public java.lang.String getPackaging()

Specified by:

getPackaging in interface IMavenProjectFacade

getProject

public org.eclipse.core.resources.IProject getProject()

Specified by:

getProject in interface IMavenProjectFacade

getPom

public org.eclipse.core.resources.IFile getPom()

Specified by:

getPom in interface IMavenProjectFacade

getPomFile

public java.io.File getPomFile()

Specified by:

getPomFile in interface IMavenProjectFacade

getFullPath

public org.eclipse.core.runtime.IPath getFullPath(java.io.File file)

Returns the full, absolute path of the given file relative to the workspace. Returns null if the file does not exist or is not a member of this project.

Specified by:

getFullPath in interface IMavenProjectFacade

getMavenProjectModules

public java.util.List<java.lang.String> getMavenProjectModules()

Specified by:

getMavenProjectModules in interface IMavenProjectFacade

getMavenProjectArtifacts

public java.util.Set<ArtifactRef> getMavenProjectArtifacts()

Specified by:

getMavenProjectArtifacts in interface IMavenProjectFacade

setMavenProjectArtifacts

void setMavenProjectArtifacts(org.apache.maven.project.MavenProject mavenProject)

getResolverConfiguration

public ResolverConfiguration getResolverConfiguration()

Specified by:

getResolverConfiguration in interface IMavenProjectFacade

isStale

public boolean isStale()

Specified by:

isStale in interface IMavenProjectFacade

Returns:

true if maven project needs to be re-read from disk

getModificationStamp

private static long getModificationStamp(org.eclipse.core.resources.IFile file)

getArtifactKey

public ArtifactKey getArtifactKey()

Specified by:

getArtifactKey in interface IMavenProjectFacade

setSessionProperty

public void setSessionProperty(java.lang.String key,
                               java.lang.Object value)

Description copied from interface: IMavenProjectFacade

Associates the value with the key in session (i.e. transient) context. Intended as a mechanism to cache state derived from MavenProject. Session properties are cleared when MavenProject is re-read from disk.

Specified by:

setSessionProperty in interface IMavenProjectFacade

See Also:

IMavenProjectFacade.getSessionProperty(String)

getSessionProperty

public java.lang.Object getSessionProperty(java.lang.String key)

Specified by:

getSessionProperty in interface IMavenProjectFacade

Returns:

the value associated with the key in session context or null if the key is not associated with any value.

See Also:

IMavenProjectFacade.setSessionProperty(String, Object)

getArtifactRepositoryRefs

public java.util.Set<ArtifactRepositoryRef> getArtifactRepositoryRefs()

Specified by:

getArtifactRepositoryRefs in interface IMavenProjectFacade

getPluginArtifactRepositoryRefs

public java.util.Set<ArtifactRepositoryRef> getPluginArtifactRepositoryRefs()

Specified by:

getPluginArtifactRepositoryRefs in interface IMavenProjectFacade

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLifecycleMappingId

public java.lang.String getLifecycleMappingId()

Specified by:

getLifecycleMappingId in interface IMavenProjectFacade

setLifecycleMappingId

public void setLifecycleMappingId(java.lang.String lifecycleMappingId)

getMojoExecutionMapping

public java.util.Map<MojoExecutionKey,java.util.List<IPluginExecutionMetadata>> getMojoExecutionMapping()

Specified by:

getMojoExecutionMapping in interface IMavenProjectFacade

setMojoExecutionMapping

public void setMojoExecutionMapping(java.util.Map<MojoExecutionKey,java.util.List<IPluginExecutionMetadata>> mojoExecutionMapping)

getExecutionPlans

private java.util.Map<java.lang.String,java.util.List<org.apache.maven.plugin.MojoExecution>> getExecutionPlans(org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                                         throws org.eclipse.core.runtime.CoreException

Maps LIFECYCLE_* to corresponding mojo executions. The mojo executions are not fully setup and cannot be executed directly.

Throws:

org.eclipse.core.runtime.CoreException

getContextValue

private static <T> T getContextValue(org.apache.maven.project.MavenProject mavenProject,
                                     java.lang.String key)

getSetupMojoExecutions

private java.util.Map<MojoExecutionKey,org.apache.maven.plugin.MojoExecution> getSetupMojoExecutions(org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                              throws org.eclipse.core.runtime.CoreException

Returns cache of fully setup MojoExecution instances. Lifespan of the cache is linked to the lifespan of MavenProject instance. The cache is initially empty and it is up to the callers to populate and maintain it.

Throws:

org.eclipse.core.runtime.CoreException

getMojoExecution

public org.apache.maven.plugin.MojoExecution getMojoExecution(MojoExecutionKey mojoExecutionKey,
                                                              org.eclipse.core.runtime.IProgressMonitor monitor)
                                                       throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMavenProjectFacade

Returns fully setup MojoExecution instance bound to project build lifecycle that matches provided mojoExecutionKey. Returns null if no such mojo execution.

Specified by:

getMojoExecution in interface IMavenProjectFacade

Throws:

org.eclipse.core.runtime.CoreException

putSetupMojoExecution

private void putSetupMojoExecution(java.util.Map<MojoExecutionKey,org.apache.maven.plugin.MojoExecution> setupMojoExecutions,
                                   MojoExecutionKey mojoExecutionKey,
                                   org.apache.maven.plugin.MojoExecution execution)

getMojoExecutions

public java.util.List<org.apache.maven.plugin.MojoExecution> getMojoExecutions(java.lang.String groupId,
                                                                               java.lang.String artifactId,
                                                                               org.eclipse.core.runtime.IProgressMonitor monitor,
                                                                               java.lang.String... goals)
                                                                        throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMavenProjectFacade

Returns list of fully setup MojoExecution instances bound to project build lifecycle that matche provided groupId, artifactId and (vararg) goals. Returns empty list if no such mojo executions.

Specified by:

getMojoExecutions in interface IMavenProjectFacade

Throws:

org.eclipse.core.runtime.CoreException

contains

private static boolean contains(java.lang.String[] goals,
                                java.lang.String goal)

getMojoExecutions

public java.util.List<org.apache.maven.plugin.MojoExecution> getMojoExecutions()

Returns cached list of MojoExecutions bound to project's clean, default and site lifecycles. Returned MojoExecutions are not fully setup and IMaven.setupMojoExecution(MavenSession, MavenProject, MojoExecution) is required to execute and/or query mojo parameters. Similarly to getMavenProject(), return value is null after workspace restart.

getMojoExecutions

public java.util.List<org.apache.maven.plugin.MojoExecution> getMojoExecutions(org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                        throws org.eclipse.core.runtime.CoreException

Returns list of MojoExecutions bound to project's clean, default and site lifecycles. Returned MojoExecutions are not fully setup and IMaven.setupMojoExecution(MavenSession, MavenProject, MojoExecution) is required to execute and/or query mojo parameters.

Throws:

org.eclipse.core.runtime.CoreException

getExecutionPlan

public java.util.List<org.apache.maven.plugin.MojoExecution> getExecutionPlan(java.lang.String lifecycle,
                                                                              org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                       throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException