org.eclipse.jdt.internal.core
Class UserLibraryClasspathContainer

java.lang.Object
  org.eclipse.jdt.internal.core.UserLibraryClasspathContainer

All Implemented Interfaces:

IClasspathContainer

public class UserLibraryClasspathContainer
extends java.lang.Object
implements IClasspathContainer

Field Summary

Fields inherited from interface org.eclipse.jdt.core.IClasspathContainer

K_APPLICATION, K_DEFAULT_SYSTEM, K_SYSTEM

Constructor Summary

UserLibraryClasspathContainer(java.lang.String name)

Method Summary

IClasspathEntry[]	getClasspathEntries() Answers the set of classpath entries this container is mapping to.
java.lang.String	getDescription() Answers a readable description of this container
int	getKind() Answers the kind of this container.
org.eclipse.core.runtime.IPath	getPath() Answers the container path identifying this container.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserLibraryClasspathContainer

public UserLibraryClasspathContainer(java.lang.String name)

Method Detail

getClasspathEntries

public IClasspathEntry[] getClasspathEntries()

Description copied from interface: IClasspathContainer

Answers the set of classpath entries this container is mapping to.

The set of entries associated with a classpath container may contain any of the following:

• library entries (CPE_LIBRARY)
• project entries (CPE_PROJECT)

A classpath container can neither reference further classpath containers or classpath variables.

This method is called by the Java model when it needs to resolve this classpath container entry into a list of library and project entries. The method is typically called exactly once for a given Java project, and the resulting list of entries cached internally by the Java model. This method must not be called by other clients.

There are a wide variety of conditions under which this method may be invoked. To ensure that the implementation does not interfere with correct functioning of the Java model, the implementation should use only the following Java model APIs:

• JavaCore.newLibraryEntry(IPath, IPath, IPath, boolean) and variants
• JavaCore.newProjectEntry(IPath, boolean) and variants
• JavaCore.create(org.eclipse.core.resources.IWorkspaceRoot)
• JavaCore.create(org.eclipse.core.resources.IProject)
• IJavaModel.getJavaProjects()
• IJavaProject.getRawClasspath()
• IJavaProject.readRawClasspath()
• IJavaProject.getOutputLocation()
• IJavaProject.readOutputLocation()
• Java element operations marked as "handle-only"

The effects of using other Java model APIs are unspecified.

Specified by:

getClasspathEntries in interface IClasspathContainer

Returns:

IClasspathEntry[] - the classpath entries this container represents

See Also:

IClasspathEntry

getDescription

public java.lang.String getDescription()

Description copied from interface: IClasspathContainer

Answers a readable description of this container

Specified by:

getDescription in interface IClasspathContainer

Returns:

String - a string description of the container

getKind

public int getKind()

Description copied from interface: IClasspathContainer

Answers the kind of this container. Can be either:

• K_APPLICATION if this container maps to an application library
• K_SYSTEM if this container maps to a system library
• K_DEFAULT_SYSTEM if this container maps to a default system library (library implicitly contributed by the runtime).

Typically, system containers should be placed first on a build path.

Specified by:

getKind in interface IClasspathContainer

Returns:

the kind of this container

getPath

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

Description copied from interface: IClasspathContainer

Answers the container path identifying this container. A container path is formed by a first ID segment followed with extra segments, which can be used as additional hints for resolving to this container.

The container ID is also used to identify aClasspathContainerInitializer registered on the extension point "org.eclipse.jdt.core.classpathContainerInitializer", which can be invoked if needing to resolve the container before it is explicitly set.

Specified by:

getPath in interface IClasspathContainer

Returns:

IPath - the container path that is associated with this container