org.eclipse.m2e.jdt.internal

Class BuildPathManager

java.lang.Object

org.eclipse.m2e.jdt.internal.BuildPathManager

All Implemented Interfaces:

EventListener, org.eclipse.core.resources.IResourceChangeListener, IMavenProjectChangedListener, IClasspathManager

public class BuildPathManager
extends Object
implements IMavenProjectChangedListener, org.eclipse.core.resources.IResourceChangeListener, IClasspathManager

This class is responsible for mapping Maven classpath to JDT and back.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASSIFIER_JAVADOC
static String	CLASSIFIER_SOURCES
static String	CLASSIFIER_TESTS
static String	CLASSIFIER_TESTSOURCES
static String	M2_REPO
static org.apache.maven.artifact.resolver.filter.ArtifactFilter	SCOPE_FILTER_RUNTIME
static org.apache.maven.artifact.resolver.filter.ArtifactFilter	SCOPE_FILTER_TEST
static int	SOURCE_DOWNLOAD_PRIORITY

Fields inherited from interface org.eclipse.m2e.jdt.IClasspathManager

ARTIFACT_ID_ATTRIBUTE, CLASSIFIER_ATTRIBUTE, CLASSPATH_DEFAULT, CLASSPATH_RUNTIME, CLASSPATH_TEST, CONTAINER_ID, GROUP_ID_ATTRIBUTE, OPTIONALDEPENDENCY_ATTRIBUTE, POMDERIVED_ATTRIBUTE, SCOPE_ATTRIBUTE, TEST_ATTRIBUTE, VERSION_ATTRIBUTE, WITHOUT_TEST_CODE

Constructor Summary

Constructors

Constructor and Description
BuildPathManager(IMavenProjectRegistry projectManager, IndexManager indexManager, org.osgi.framework.BundleContext bundleContext, File stateLocationDir)

Method Summary

Modifier and Type	Method and Description
ArtifactKey	findArtifact(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IPath path)
org.eclipse.jdt.core.IClasspathEntry[]	getClasspath(org.eclipse.core.resources.IProject project, int scope, boolean uniquePaths, org.eclipse.core.runtime.IProgressMonitor monitor) Calculates and returns Maven classpath of the project.
org.eclipse.jdt.core.IClasspathEntry[]	getClasspath(org.eclipse.core.resources.IProject project, int scope, org.eclipse.core.runtime.IProgressMonitor monitor)
org.eclipse.jdt.core.IClasspathEntry[]	getClasspath(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IProgressMonitor monitor)
File	getContainerStateFile(org.eclipse.core.resources.IProject project) public for unit tests only
org.eclipse.core.runtime.jobs.Job	getDownloadSourcesJob() this is for unit tests only!
String	getJavadocLocation(org.eclipse.jdt.core.IClasspathEntry entry) public for unit tests only
static org.eclipse.jdt.core.IClasspathContainer	getMaven2ClasspathContainer(org.eclipse.jdt.core.IJavaProject project)
static org.eclipse.jdt.core.IClasspathEntry	getMavenContainerEntry(org.eclipse.jdt.core.IJavaProject javaProject)
org.eclipse.jdt.core.IClasspathContainer	getSavedContainer(org.eclipse.core.resources.IProject project)
String	getSourceAttachmentEncoding(org.eclipse.jdt.core.IClasspathEntry entry)
File	getSourceAttachmentPropertiesFile(org.eclipse.core.resources.IProject project) public for unit tests only
void	mavenProjectChanged(MavenProjectChangedEvent[] events, org.eclipse.core.runtime.IProgressMonitor monitor) This method is called while holding workspace lock.
void	persistAttachedSourcesAndJavadoc(org.eclipse.jdt.core.IJavaProject project, org.eclipse.jdt.core.IClasspathContainer containerSuggestion, org.eclipse.core.runtime.IProgressMonitor monitor) Extracts and persists custom source/javadoc attachment info
void	resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event)
void	scheduleDownload(org.eclipse.jdt.core.IPackageFragmentRoot fragment, boolean downloadSources, boolean downloadJavadoc) Request download of sources and/or javadoc from Maven repositories by a background job (asynchronous execution).
void	scheduleDownload(org.eclipse.core.resources.IProject project, boolean downloadSources, boolean downloadJavadoc) Request download of sources and/or javadoc from Maven repositories by a background job for all classpath entries of the project (asynchronous execution).
boolean	setupVariables()
void	updateClasspath(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IProgressMonitor monitor) Calculates Maven classpath of the project using default dependency resolution scope and updates contents of Maven Dependencies classpath container.
boolean	variablesAreInUse()

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_DOWNLOAD_PRIORITY

public static final int SOURCE_DOWNLOAD_PRIORITY

See Also:

Constant Field Values

M2_REPO

public static final String M2_REPO

See Also:

Constant Field Values

CLASSIFIER_SOURCES

public static final String CLASSIFIER_SOURCES

See Also:

Constant Field Values

CLASSIFIER_JAVADOC

public static final String CLASSIFIER_JAVADOC

See Also:

Constant Field Values

CLASSIFIER_TESTS

public static final String CLASSIFIER_TESTS

See Also:

Constant Field Values

CLASSIFIER_TESTSOURCES

public static final String CLASSIFIER_TESTSOURCES

See Also:

Constant Field Values

SCOPE_FILTER_RUNTIME

public static final org.apache.maven.artifact.resolver.filter.ArtifactFilter SCOPE_FILTER_RUNTIME

SCOPE_FILTER_TEST

public static final org.apache.maven.artifact.resolver.filter.ArtifactFilter SCOPE_FILTER_TEST

Constructor Detail

BuildPathManager

public BuildPathManager(IMavenProjectRegistry projectManager,
                        IndexManager indexManager,
                        org.osgi.framework.BundleContext bundleContext,
                        File stateLocationDir)

Method Detail

getMavenContainerEntry

public static org.eclipse.jdt.core.IClasspathEntry getMavenContainerEntry(org.eclipse.jdt.core.IJavaProject javaProject)

getMaven2ClasspathContainer

public static org.eclipse.jdt.core.IClasspathContainer getMaven2ClasspathContainer(org.eclipse.jdt.core.IJavaProject project)
                                                                            throws org.eclipse.jdt.core.JavaModelException

Throws:

org.eclipse.jdt.core.JavaModelException

mavenProjectChanged

public void mavenProjectChanged(MavenProjectChangedEvent[] events,
                                org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IMavenProjectChangedListener

This method is called while holding workspace lock.

Specified by:

mavenProjectChanged in interface IMavenProjectChangedListener

updateClasspath

public void updateClasspath(org.eclipse.core.resources.IProject project,
                            org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IClasspathManager

Calculates Maven classpath of the project using default dependency resolution scope and updates contents of Maven Dependencies classpath container.

Specified by:

updateClasspath in interface IClasspathManager

getSavedContainer

public org.eclipse.jdt.core.IClasspathContainer getSavedContainer(org.eclipse.core.resources.IProject project)
                                                           throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

getClasspath

public org.eclipse.jdt.core.IClasspathEntry[] getClasspath(org.eclipse.core.resources.IProject project,
                                                           int scope,
                                                           org.eclipse.core.runtime.IProgressMonitor monitor)
                                                    throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

getClasspath

public org.eclipse.jdt.core.IClasspathEntry[] getClasspath(org.eclipse.core.resources.IProject project,
                                                           int scope,
                                                           boolean uniquePaths,
                                                           org.eclipse.core.runtime.IProgressMonitor monitor)
                                                    throws org.eclipse.core.runtime.CoreException

Description copied from interface: IClasspathManager

Calculates and returns Maven classpath of the project.

Specified by:

getClasspath in interface IClasspathManager

Parameters:

project - the project to calculate classpath for

scope - one of CLASPATH_* constants, that specifies Maven dependency resolution scope for the classpath

uniquePaths - enforce (true) or not to enforce (false) uniqueness of classpath entries paths.

monitor - progress monitor

Returns:

Maven classpath of the project

Throws:

org.eclipse.core.runtime.CoreException

getClasspath

public org.eclipse.jdt.core.IClasspathEntry[] getClasspath(org.eclipse.core.resources.IProject project,
                                                           org.eclipse.core.runtime.IProgressMonitor monitor)
                                                    throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

findArtifact

public ArtifactKey findArtifact(org.eclipse.core.resources.IProject project,
                                org.eclipse.core.runtime.IPath path)
                         throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

persistAttachedSourcesAndJavadoc

public void persistAttachedSourcesAndJavadoc(org.eclipse.jdt.core.IJavaProject project,
                                             org.eclipse.jdt.core.IClasspathContainer containerSuggestion,
                                             org.eclipse.core.runtime.IProgressMonitor monitor)
                                      throws org.eclipse.core.runtime.CoreException

Extracts and persists custom source/javadoc attachment info

Throws:

org.eclipse.core.runtime.CoreException

getJavadocLocation

public String getJavadocLocation(org.eclipse.jdt.core.IClasspathEntry entry)

public for unit tests only

getSourceAttachmentEncoding

public String getSourceAttachmentEncoding(org.eclipse.jdt.core.IClasspathEntry entry)

getSourceAttachmentPropertiesFile

public File getSourceAttachmentPropertiesFile(org.eclipse.core.resources.IProject project)

public for unit tests only

getContainerStateFile

public File getContainerStateFile(org.eclipse.core.resources.IProject project)

public for unit tests only

resourceChanged

public void resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event)

Specified by:

resourceChanged in interface org.eclipse.core.resources.IResourceChangeListener

setupVariables

public boolean setupVariables()

variablesAreInUse

public boolean variablesAreInUse()

getDownloadSourcesJob

public org.eclipse.core.runtime.jobs.Job getDownloadSourcesJob()

this is for unit tests only!

scheduleDownload

public void scheduleDownload(org.eclipse.jdt.core.IPackageFragmentRoot fragment,
                             boolean downloadSources,
                             boolean downloadJavadoc)

Description copied from interface: IClasspathManager

Request download of sources and/or javadoc from Maven repositories by a background job (asynchronous execution). After download has completed, sources and/or javadoc jar file will be attached to the corresponding classpath entry.

Specified by:

scheduleDownload in interface IClasspathManager

scheduleDownload

public void scheduleDownload(org.eclipse.core.resources.IProject project,
                             boolean downloadSources,
                             boolean downloadJavadoc)

Description copied from interface: IClasspathManager

Request download of sources and/or javadoc from Maven repositories by a background job for all classpath entries of the project (asynchronous execution). After download has completed, sources and/or javadoc jar file will be attached to the corresponding classpath entries.

Specified by:

scheduleDownload in interface IClasspathManager