org.eclipse.jdt.core
Class ClasspathContainerInitializer

java.lang.Object
  |
  +--org.eclipse.jdt.core.ClasspathContainerInitializer

public abstract class ClasspathContainerInitializer

extends Object

Abstract base implementation of all classpath container initializer. Classpath variable containers are used in conjunction with the "org.eclipse.jdt.core.classpathContainerInitializer" extension point.

Clients should subclass this class to implement a specific classpath container initializer. The subclass must have a public 0-argument constructor and a concrete implementation of resolve.

Multiple classpath containers can be registered, each of them declares the container ID they can handle, so as to narrow the set of containers they can resolve, i.e. a container initializer is guaranteed to only be activated to resolve containers which match the ID they registered onto.

In case multiple container initializers collide on the same container ID, the first registered one will be invoked.

Since:

2.0

See Also:

IClasspathEntry, IClasspathContainer

Constructor Summary

ClasspathContainerInitializer()
Creates a new classpath container initializer.

Method Summary

abstract void

initialize(IPath containerPath, IJavaProject project) Binds a classpath container to a IClasspathContainer for a given project, or silently fails if unable to do so.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClasspathContainerInitializer

public ClasspathContainerInitializer()

Creates a new classpath container initializer.

Method Detail

initialize

public abstract void initialize(IPath containerPath,
                                IJavaProject project)
                         throws CoreException

Binds a classpath container to a IClasspathContainer for a given project, or silently fails if unable to do so.

A container is identified by a container path, which must be formed of two segments. The first segment is used as a unique identifier (which this initializer did register onto), and the second segment can be used as an additional hint when performing the resolution.

The initializer is invoked if a container path needs to be resolved for a given project, and no value for it was recorded so far. The implementation of the initializer can set the corresponding container using JavaCore#setClasspathContainer.

Parameters:

containerPath - a two-segment path (ID/hint) identifying the container that needs to be resolved

project - the Java project in which context the container is to be resolved. This allows generic containers to be bound with project specific values.

CoreException

See Also:

JavaCore.getClasspathContainer(IPath, IJavaProject), JavaCore.setClasspathContainer(IPath, IJavaProject[], IClasspathContainer[], IProgressMonitor), IClasspathContainer