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

Class MavenProjectManager

java.lang.Object

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

All Implemented Interfaces:

IMavenProjectRegistry

public class MavenProjectManager
extends java.lang.Object
implements IMavenProjectRegistry

The only reason this class exists is to implement async refresh(MavenUpdateRequest) without introducing circular dependency between ProjectRegistryRefreshJob and ProjectRegistryManager. Otherwise, all requests are forwarded to ProjectRegistryManager as is.

Field Summary

Fields

Modifier and Type	Field and Description
private ProjectRegistryManager	manager
private ProjectRegistryRefreshJob	mavenBackgroundJob
static java.lang.String	STATE_FILENAME
private java.io.File	workspaceStateFile

Constructor Summary

Constructors

Constructor and Description
MavenProjectManager(ProjectRegistryManager manager, ProjectRegistryRefreshJob mavenBackgroundJob, java.io.File stateLocation)

Method Summary

Modifier and Type	Method and Description
void	addMavenProjectChangedListener(IMavenProjectChangedListener listener)
IMavenProjectFacade	create(org.eclipse.core.resources.IFile pom, boolean load, org.eclipse.core.runtime.IProgressMonitor monitor) Returns IMavenProjectFacade corresponding to the pom.
IMavenProjectFacade	create(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IProgressMonitor monitor)
org.apache.maven.execution.MavenExecutionRequest	createExecutionRequest(org.eclipse.core.resources.IFile pom, ResolverConfiguration resolverConfiguration, org.eclipse.core.runtime.IProgressMonitor monitor) Deprecated.
org.apache.maven.execution.MavenExecutionRequest	createExecutionRequest(IMavenProjectFacade project, org.eclipse.core.runtime.IProgressMonitor monitor) Deprecated.
<V> V	execute(IMavenProjectFacade facade, ICallable<V> callable, org.eclipse.core.runtime.IProgressMonitor monitor)
IMavenProjectFacade	getMavenProject(java.lang.String groupId, java.lang.String artifactId, java.lang.String version) Returns IMavenProjectFacade of the Maven workspace project that has given (groupId,artifactId,version) coordinates.
IMavenProjectFacade	getProject(org.eclipse.core.resources.IProject project)
IMavenProjectFacade[]	getProjects() Returns IMavenProjectFacade for all opened Maven workspace projects.
java.io.File	getWorkspaceStateFile()
void	refresh(java.util.Collection<org.eclipse.core.resources.IFile> pomFiles, org.eclipse.core.runtime.IProgressMonitor monitor) Performs requested Maven project update synchronously.
void	refresh(MavenUpdateRequest request) Performs requested Maven project update asynchronously, using background job.
void	refresh(MavenUpdateRequest request, org.eclipse.core.runtime.IProgressMonitor monitor) Deprecated.
void	removeMavenProjectChangedListener(IMavenProjectChangedListener listener)

Methods inherited from class java.lang.Object

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

Field Detail

STATE_FILENAME

public static final java.lang.String STATE_FILENAME

See Also:

Constant Field Values

manager

private final ProjectRegistryManager manager

mavenBackgroundJob

private final ProjectRegistryRefreshJob mavenBackgroundJob

workspaceStateFile

private final java.io.File workspaceStateFile

Constructor Detail

MavenProjectManager

public MavenProjectManager(ProjectRegistryManager manager,
                           ProjectRegistryRefreshJob mavenBackgroundJob,
                           java.io.File stateLocation)

Method Detail

refresh

public void refresh(MavenUpdateRequest request)

Description copied from interface: IMavenProjectRegistry

Performs requested Maven project update asynchronously, using background job. This method returns immediately.

Specified by:

refresh in interface IMavenProjectRegistry

refresh

@Deprecated
public void refresh(MavenUpdateRequest request,
                                org.eclipse.core.runtime.IProgressMonitor monitor)
                         throws org.eclipse.core.runtime.CoreException

Deprecated.

Description copied from interface: IMavenProjectRegistry

Performs requested Maven project update synchronously. In other words, this method does not return until all affected projects have been updated and corresponding MavenProjectChangeEvent's broadcast. This method acquires a lock on the workspace's root.

Specified by:

refresh in interface IMavenProjectRegistry

Throws:

org.eclipse.core.runtime.CoreException

refresh

public void refresh(java.util.Collection<org.eclipse.core.resources.IFile> pomFiles,
                    org.eclipse.core.runtime.IProgressMonitor monitor)
             throws org.eclipse.core.runtime.CoreException

Description copied from interface: IMavenProjectRegistry

Performs requested Maven project update synchronously. In other words, this method does not return until all affected projects have been updated and corresponding MavenProjectChangeEvent's broadcast. This method acquires a lock on the workspace's root.

Specified by:

refresh in interface IMavenProjectRegistry

Throws:

org.eclipse.core.runtime.CoreException

addMavenProjectChangedListener

public void addMavenProjectChangedListener(IMavenProjectChangedListener listener)

Specified by:

addMavenProjectChangedListener in interface IMavenProjectRegistry

removeMavenProjectChangedListener

public void removeMavenProjectChangedListener(IMavenProjectChangedListener listener)

Specified by:

removeMavenProjectChangedListener in interface IMavenProjectRegistry

create

public IMavenProjectFacade create(org.eclipse.core.resources.IFile pom,
                                  boolean load,
                                  org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IMavenProjectRegistry

Returns IMavenProjectFacade corresponding to the pom. This method first looks in the project cache, then attempts to load the pom if the pom is not found in the cache. In the latter case, workspace resolution is assumed to be enabled for the pom but the pom will not be added to the cache.

Specified by:

create in interface IMavenProjectRegistry

create

public IMavenProjectFacade create(org.eclipse.core.resources.IProject project,
                                  org.eclipse.core.runtime.IProgressMonitor monitor)

Specified by:

create in interface IMavenProjectRegistry

getProjects

public IMavenProjectFacade[] getProjects()

Description copied from interface: IMavenProjectRegistry

Returns IMavenProjectFacade for all opened Maven workspace projects.

Specified by:

getProjects in interface IMavenProjectRegistry

getProject

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

Specified by:

getProject in interface IMavenProjectRegistry

Returns:

IMavenProjectFacade cached IMavenProjectFacade corresponding to the project or null if there is no cache entry for the project.

getMavenProject

public IMavenProjectFacade getMavenProject(java.lang.String groupId,
                                           java.lang.String artifactId,
                                           java.lang.String version)

Description copied from interface: IMavenProjectRegistry

Returns IMavenProjectFacade of the Maven workspace project that has given (groupId,artifactId,version) coordinates.

Specified by:

getMavenProject in interface IMavenProjectRegistry

getWorkspaceStateFile

public java.io.File getWorkspaceStateFile()

createExecutionRequest

@Deprecated
public org.apache.maven.execution.MavenExecutionRequest createExecutionRequest(org.eclipse.core.resources.IFile pom,
                                                                                           ResolverConfiguration resolverConfiguration,
                                                                                           org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                    throws org.eclipse.core.runtime.CoreException

Deprecated.

Specified by:

createExecutionRequest in interface IMavenProjectRegistry

Throws:

org.eclipse.core.runtime.CoreException

createExecutionRequest

@Deprecated
public org.apache.maven.execution.MavenExecutionRequest createExecutionRequest(IMavenProjectFacade project,
                                                                                           org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                    throws org.eclipse.core.runtime.CoreException

Deprecated.

Specified by:

createExecutionRequest in interface IMavenProjectRegistry

Throws:

org.eclipse.core.runtime.CoreException

execute

public <V> V execute(IMavenProjectFacade facade,
                     ICallable<V> callable,
                     org.eclipse.core.runtime.IProgressMonitor monitor)
              throws org.eclipse.core.runtime.CoreException

Specified by:

execute in interface IMavenProjectRegistry

Throws:

org.eclipse.core.runtime.CoreException