org.eclipse.m2e.jdt.internal

Class ClasspathDescriptor

java.lang.Object

org.eclipse.m2e.jdt.internal.ClasspathDescriptor

All Implemented Interfaces:

IClasspathDescriptor

public class ClasspathDescriptor
extends Object
implements IClasspathDescriptor

This class is an attempt to encapsulate list of IClasspathEntry's and operations on the list such as "removeEntry", "addSourceEntry" and "addEntryAttribute". The idea is to provide JavaProjectConfigurator's classpath whiteboard they can use to incrementally define classpath in a consistent manner.

Author:

igor

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.m2e.jdt.IClasspathDescriptor

IClasspathDescriptor.EntryFilter

Constructor Summary

Constructors

Constructor and Description
ClasspathDescriptor(boolean uniquePaths)
ClasspathDescriptor(org.eclipse.jdt.core.IJavaProject javaProject)

Method Summary

Modifier and Type	Method and Description
ClasspathEntryDescriptor	addEntry(org.eclipse.jdt.core.IClasspathEntry cpe) Adds fully populated IClasspathEntry instance to the classpath.
ClasspathEntryDescriptor	addLibraryEntry(org.apache.maven.artifact.Artifact artifact, org.eclipse.core.runtime.IPath srcPath, org.eclipse.core.runtime.IPath srcRoot, String javaDocUrl) Adds Maven artifact with corresponding sources and javadoc paths to the classpath.
ClasspathEntryDescriptor	addLibraryEntry(org.eclipse.core.runtime.IPath entryPath) Adds and returns new library entry to the classpath
ClasspathEntryDescriptor	addProjectEntry(org.apache.maven.artifact.Artifact a, IMavenProjectFacade projectFacade) Adds worksapce Maven project dependency to the classpath
ClasspathEntryDescriptor	addProjectEntry(org.eclipse.core.runtime.IPath entryPath) Adds and returns new project classpath entry.
ClasspathEntryDescriptor	addSourceEntry(org.eclipse.core.runtime.IPath sourcePath, org.eclipse.core.runtime.IPath outputLocation, boolean generated) Convenience method, equivalent to addSourceEntry(sourcePath, outputLocation, new IPath[0], new IPath[0], generated)
ClasspathEntryDescriptor	addSourceEntry(org.eclipse.core.runtime.IPath sourcePath, org.eclipse.core.runtime.IPath outputLocation, org.eclipse.core.runtime.IPath[] inclusion, org.eclipse.core.runtime.IPath[] exclusion, boolean generated) Adds project source folder to the classpath.
boolean	containsPath(org.eclipse.core.runtime.IPath path)
org.eclipse.jdt.core.IClasspathEntry[]	getEntries() Renders classpath as IClasspathEntry[] array
List<IClasspathEntryDescriptor>	getEntryDescriptors() Returns underlying "live" list of IClasspathEntryDescriptor instances.
List<IClasspathEntryDescriptor>	removeEntry(IClasspathDescriptor.EntryFilter filter) Removes entries that match EntryFilter (i.e.
List<IClasspathEntryDescriptor>	removeEntry(org.eclipse.core.runtime.IPath path) Removes entry with specified path from the classpath.
IClasspathEntryDescriptor	replaceEntry(IClasspathDescriptor.EntryFilter filter, org.eclipse.jdt.core.IClasspathEntry cpe) Replaces a single ClasspathEntry instance matched by filter.
void	touchEntry(org.eclipse.core.runtime.IPath sourcePath) Removes entry from stale entries list.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClasspathDescriptor

public ClasspathDescriptor(boolean uniquePaths)

ClasspathDescriptor

public ClasspathDescriptor(org.eclipse.jdt.core.IJavaProject javaProject)
                    throws org.eclipse.jdt.core.JavaModelException

Throws:

org.eclipse.jdt.core.JavaModelException

Method Detail

containsPath

public boolean containsPath(org.eclipse.core.runtime.IPath path)

Specified by:

containsPath in interface IClasspathDescriptor

Returns:

true if classpath contains entry with specified path, false otherwise.

addSourceEntry

public ClasspathEntryDescriptor addSourceEntry(org.eclipse.core.runtime.IPath sourcePath,
                                               org.eclipse.core.runtime.IPath outputLocation,
                                               boolean generated)

Description copied from interface: IClasspathDescriptor

Convenience method, equivalent to addSourceEntry(sourcePath, outputLocation, new IPath[0], new IPath[0], generated)

Specified by:

addSourceEntry in interface IClasspathDescriptor

removeEntry

public List<IClasspathEntryDescriptor> removeEntry(org.eclipse.core.runtime.IPath path)

Description copied from interface: IClasspathDescriptor

Removes entry with specified path from the classpath. That this can remove multiple entries because classpath does not enforce uniqueness of entry paths

Specified by:

removeEntry in interface IClasspathDescriptor

removeEntry

public List<IClasspathEntryDescriptor> removeEntry(IClasspathDescriptor.EntryFilter filter)

Description copied from interface: IClasspathDescriptor

Removes entries that match EntryFilter (i.e. EntryFilter#accept(entry) returns true) from the classpath

Specified by:

removeEntry in interface IClasspathDescriptor

addSourceEntry

public ClasspathEntryDescriptor addSourceEntry(org.eclipse.core.runtime.IPath sourcePath,
                                               org.eclipse.core.runtime.IPath outputLocation,
                                               org.eclipse.core.runtime.IPath[] inclusion,
                                               org.eclipse.core.runtime.IPath[] exclusion,
                                               boolean generated)

Description copied from interface: IClasspathDescriptor

Adds project source folder to the classpath. The source folder must exist in the workspace unless generated is true. In the latter case, the source classpath entry will be marked as optional.

Specified by:

addSourceEntry in interface IClasspathDescriptor

touchEntry

public void touchEntry(org.eclipse.core.runtime.IPath sourcePath)

Description copied from interface: IClasspathDescriptor

Removes entry from stale entries list.

Specified by:

touchEntry in interface IClasspathDescriptor

getEntries

public org.eclipse.jdt.core.IClasspathEntry[] getEntries()

Description copied from interface: IClasspathDescriptor

Renders classpath as IClasspathEntry[] array

Specified by:

getEntries in interface IClasspathDescriptor

getEntryDescriptors

public List<IClasspathEntryDescriptor> getEntryDescriptors()

Description copied from interface: IClasspathDescriptor

Returns underlying "live" list of IClasspathEntryDescriptor instances. Changes to the list will be immediately reflected in the classpath.

Specified by:

getEntryDescriptors in interface IClasspathDescriptor

addEntry

public ClasspathEntryDescriptor addEntry(org.eclipse.jdt.core.IClasspathEntry cpe)

Description copied from interface: IClasspathDescriptor

Adds fully populated IClasspathEntry instance to the classpath.

Specified by:

addEntry in interface IClasspathDescriptor

replaceEntry

public IClasspathEntryDescriptor replaceEntry(IClasspathDescriptor.EntryFilter filter,
                                              org.eclipse.jdt.core.IClasspathEntry cpe)

Description copied from interface: IClasspathDescriptor

Replaces a single ClasspathEntry instance matched by filter. Returns null if none were replaced.

Specified by:

replaceEntry in interface IClasspathDescriptor

addProjectEntry

public ClasspathEntryDescriptor addProjectEntry(org.apache.maven.artifact.Artifact a,
                                                IMavenProjectFacade projectFacade)

Description copied from interface: IClasspathDescriptor

Adds worksapce Maven project dependency to the classpath

Specified by:

addProjectEntry in interface IClasspathDescriptor

addProjectEntry

public ClasspathEntryDescriptor addProjectEntry(org.eclipse.core.runtime.IPath entryPath)

Description copied from interface: IClasspathDescriptor

Adds and returns new project classpath entry.

Specified by:

addProjectEntry in interface IClasspathDescriptor

addLibraryEntry

public ClasspathEntryDescriptor addLibraryEntry(org.apache.maven.artifact.Artifact artifact,
                                                org.eclipse.core.runtime.IPath srcPath,
                                                org.eclipse.core.runtime.IPath srcRoot,
                                                String javaDocUrl)

Description copied from interface: IClasspathDescriptor

Adds Maven artifact with corresponding sources and javadoc paths to the classpath.

Specified by:

addLibraryEntry in interface IClasspathDescriptor

addLibraryEntry

public ClasspathEntryDescriptor addLibraryEntry(org.eclipse.core.runtime.IPath entryPath)

Description copied from interface: IClasspathDescriptor

Adds and returns new library entry to the classpath

Specified by:

addLibraryEntry in interface IClasspathDescriptor