org.eclipse.jdt.internal.launching

Class DefaultProjectClasspathEntry

java.lang.Object

PlatformObject

org.eclipse.jdt.internal.launching.AbstractRuntimeClasspathEntry

org.eclipse.jdt.internal.launching.DefaultProjectClasspathEntry

All Implemented Interfaces:

IRuntimeClasspathEntry, IRuntimeClasspathEntry2

public class DefaultProjectClasspathEntry
extends AbstractRuntimeClasspathEntry

Default user classpath entries for a Java project

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_ID

Fields inherited from interface org.eclipse.jdt.launching.IRuntimeClasspathEntry

ARCHIVE, BOOTSTRAP_CLASSES, CLASS_PATH, CONTAINER, MODULE_PATH, OTHER, PATCH_MODULE, PROJECT, STANDARD_CLASSES, USER_CLASSES, VARIABLE

Constructor Summary

Constructors

Constructor and Description
DefaultProjectClasspathEntry() Default constructor need to instantiate extensions
DefaultProjectClasspathEntry(IJavaProject project) Constructs a new classpath entry for the given project.

Method Summary

Modifier and Type	Method and Description
static void	adjustClasspathProperty(IRuntimeClasspathEntry r, IClasspathEntry entry)
protected void	buildMemento(org.w3c.dom.Document document, org.w3c.dom.Element memento) Constructs a memento for this classpath entry in the given document and element.
boolean	equals(java.lang.Object obj)
static void	expandProject(IClasspathEntry projectEntry, java.util.List<java.lang.Object> expandedPath, java.util.List<IClasspathEntry> expanding, boolean excludeTestCode, boolean exportedEntriesOnly, IJavaProject rootProject, boolean isModularJVM) Returns the transitive closure of classpath entries for the given project entry.
static void	expandProjectInternal(IClasspathEntry projectEntry, java.util.List<java.lang.Object> expandedPath, java.util.Set<java.lang.Object> visitedEntries, java.util.List<IClasspathEntry> expanding, boolean excludeTestCode, boolean exportedEntriesOnly, IJavaProject rootProject, boolean isModularJVM)
java.lang.String	getLocation() Returns an absolute path in the local file system for this entry, or null if none, or if this entry is of type CONTAINER.
java.lang.String	getName() Returns a human readable name for this classpath entry.
IPath	getPath() Returns the path associated with this entry, or null if none.
protected IProject	getProject()
IResource	getResource() Returns the resource associated with this entry, or null if none.
IRuntimeClasspathEntry[]	getRuntimeClasspathEntries(ILaunchConfiguration configuration) Returns the classpath entries this entry is composed of, or an empty collection if this entry is not a composite entry.
int	getType() Returns this classpath entry's type.
java.lang.String	getTypeId() Returns the unique identifier of the extension that contributed this classpath entry type, or null if this classpath entry type was not contributed.
int	hashCode()
void	initializeFrom(org.w3c.dom.Element memento) Initializes this runtime classpath entry from the given memento.
boolean	isComposite() Returns whether this classpath entry is composed of other entries.
boolean	isExportedEntriesOnly() Returns whether the classpath computation only includes exported entries in referenced projects.
void	setExportedEntriesOnly(boolean exportedOnly) Sets whether the runtime classpath computation should only include exported entries in referenced projects.

Methods inherited from class org.eclipse.jdt.internal.launching.AbstractRuntimeClasspathEntry

abort, getClasspathEntry, getClasspathProperty, getExternalAnnotationsPath, getJavaProject, getMemento, getRuntimeClasspathEntries, getSourceAttachmentLocation, getSourceAttachmentPath, getSourceAttachmentRootLocation, getSourceAttachmentRootPath, getVariableName, isAutomodule, setClasspathProperty, setExternalAnnotationsPath, setJavaProject, setSourceAttachmentPath, setSourceAttachmentRootPath

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_ID

public static final java.lang.String TYPE_ID

See Also:

Constant Field Values

Constructor Detail

DefaultProjectClasspathEntry

public DefaultProjectClasspathEntry()

Default constructor need to instantiate extensions

DefaultProjectClasspathEntry

public DefaultProjectClasspathEntry(IJavaProject project)

Constructs a new classpath entry for the given project.

Parameters:

project - Java project

Method Detail

buildMemento

protected void buildMemento(org.w3c.dom.Document document,
                            org.w3c.dom.Element memento)
                     throws CoreException

Description copied from class: AbstractRuntimeClasspathEntry

Constructs a memento for this classpath entry in the given document and element. The memento element has already been appended to the document.

Specified by:

buildMemento in class AbstractRuntimeClasspathEntry

Parameters:

document - XML document

memento - element node for client specific attributes

Throws:

CoreException - if unable to create a memento

initializeFrom

public void initializeFrom(org.w3c.dom.Element memento)
                    throws CoreException

Description copied from interface: IRuntimeClasspathEntry2

Initializes this runtime classpath entry from the given memento.

Parameters:

memento - memento created by a classpath entry of the same type

Throws:

CoreException - if unable to initialize from the given memento

getTypeId

public java.lang.String getTypeId()

Description copied from interface: IRuntimeClasspathEntry2

Returns the unique identifier of the extension that contributed this classpath entry type, or null if this classpath entry type was not contributed.

Returns:

the unique identifier of the extension that contributed this classpath entry type, or null if this classpath entry type was not contributed

getType

public int getType()

Description copied from interface: IRuntimeClasspathEntry

Returns this classpath entry's type. The type of a runtime classpath entry is identified by one of the following constants:

• PROJECT
• ARCHIVE
• VARIABLE
• CONTAINER
• OTHER

Since 3.0, a type of OTHER may be returned.

Returns:

this classpath entry's type

getProject

protected IProject getProject()

getLocation

public java.lang.String getLocation()

Description copied from interface: IRuntimeClasspathEntry

Returns an absolute path in the local file system for this entry, or null if none, or if this entry is of type CONTAINER.

Specified by:

getLocation in interface IRuntimeClasspathEntry

Overrides:

getLocation in class AbstractRuntimeClasspathEntry

Returns:

an absolute path in the local file system for this entry, or null if none

getPath

public IPath getPath()

Description copied from interface: IRuntimeClasspathEntry

Returns the path associated with this entry, or null if none. The format of the path returned depends on this entry's type:

• PROJECT - a workspace relative path to the associated project.
• ARCHIVE - the absolute path of the associated archive, which may or may not be in the workspace.
• VARIABLE - the path corresponding to the associated classpath variable entry.
• CONTAINER - the path corresponding to the associated classpath container variable entry.
• OTHER - the path returned is client defined.

Since 3.0, this method may return null.

Specified by:

getPath in interface IRuntimeClasspathEntry

Overrides:

getPath in class AbstractRuntimeClasspathEntry

Returns:

the path associated with this entry, or null

See Also:

org.eclipse.jdt.core.IClasspathEntry#getPath()

getResource

public IResource getResource()

Description copied from interface: IRuntimeClasspathEntry

Returns the resource associated with this entry, or null if none. A project, archive, or folder entry may be associated with a resource.

Specified by:

getResource in interface IRuntimeClasspathEntry

Overrides:

getResource in class AbstractRuntimeClasspathEntry

Returns:

the resource associated with this entry, or null

getRuntimeClasspathEntries

public IRuntimeClasspathEntry[] getRuntimeClasspathEntries(ILaunchConfiguration configuration)
                                                    throws CoreException

Description copied from interface: IRuntimeClasspathEntry2

Returns the classpath entries this entry is composed of, or an empty collection if this entry is not a composite entry.

Parameters:

configuration - the context (launch configuration) in which this runtime classpath entry is being queried for contained entries, possibly null

Returns:

the classpath entries this entry is composed of, or an empty collection if this entry is not a composite entry

Throws:

CoreException - if unable to retrieve contained entries

expandProject

public static void expandProject(IClasspathEntry projectEntry,
                                 java.util.List<java.lang.Object> expandedPath,
                                 java.util.List<IClasspathEntry> expanding,
                                 boolean excludeTestCode,
                                 boolean exportedEntriesOnly,
                                 IJavaProject rootProject,
                                 boolean isModularJVM)
                          throws CoreException

Returns the transitive closure of classpath entries for the given project entry.

Parameters:

projectEntry - project classpath entry

expandedPath - a list of entries already expanded, should be empty to begin, and contains the result

expanding - a list of projects that have been or are currently being expanded (to detect cycles)

excludeTestCode - if true, test dependencies will be excluded

exportedEntriesOnly - if true, only add exported transitive dependencies

rootProject - the root project for which the classpath is computed

isModularJVM - if jvm is java 9 or later

Throws:

CoreException - if unable to expand the classpath

expandProjectInternal

public static void expandProjectInternal(IClasspathEntry projectEntry,
                                         java.util.List<java.lang.Object> expandedPath,
                                         java.util.Set<java.lang.Object> visitedEntries,
                                         java.util.List<IClasspathEntry> expanding,
                                         boolean excludeTestCode,
                                         boolean exportedEntriesOnly,
                                         IJavaProject rootProject,
                                         boolean isModularJVM)
                                  throws CoreException

Throws:

CoreException

adjustClasspathProperty

public static void adjustClasspathProperty(IRuntimeClasspathEntry r,
                                           IClasspathEntry entry)

isComposite

public boolean isComposite()

Description copied from interface: IRuntimeClasspathEntry2

Returns whether this classpath entry is composed of other entries.

Specified by:

isComposite in interface IRuntimeClasspathEntry2

Overrides:

isComposite in class AbstractRuntimeClasspathEntry

Returns:

whether this classpath entry is composed of other entries

getName

public java.lang.String getName()

Description copied from interface: IRuntimeClasspathEntry2

Returns a human readable name for this classpath entry.

Returns:

a human readable name for this classpath entry

equals

public boolean equals(java.lang.Object obj)

hashCode

public int hashCode()

setExportedEntriesOnly

public void setExportedEntriesOnly(boolean exportedOnly)

Sets whether the runtime classpath computation should only include exported entries in referenced projects.

Parameters:

exportedOnly - if the runtime classpath computation should only include exported entries in referenced projects.

Since:

3.2

isExportedEntriesOnly

public boolean isExportedEntriesOnly()

Returns whether the classpath computation only includes exported entries in referenced projects.

Returns:

if the classpath computation only includes exported entries in referenced projects.

Since:

3.2