org.eclipse.jdt.internal.launching

Class AbstractRuntimeClasspathEntry

java.lang.Object

PlatformObject

org.eclipse.jdt.internal.launching.AbstractRuntimeClasspathEntry

All Implemented Interfaces:

IRuntimeClasspathEntry, IRuntimeClasspathEntry2

Direct Known Subclasses:

DefaultProjectClasspathEntry, VariableClasspathEntry

public abstract class AbstractRuntimeClasspathEntry
extends PlatformObject
implements IRuntimeClasspathEntry2

Common function for runtime classpath entries.

Clients implementing runtime classpath entries must subclass this class.

Since:

3.0

Field Summary

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
AbstractRuntimeClasspathEntry()

Method Summary

Modifier and Type	Method and Description
protected void	abort(java.lang.String message, java.lang.Throwable exception) Throws an exception with the given message and underlying exception.
protected abstract 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.
IClasspathEntry	getClasspathEntry() Returns a classpath entry equivalent to this runtime classpath entry, or null if none.
int	getClasspathProperty() Returns a constant indicating where this entry should appear on the runtime classpath by default.
IPath	getExternalAnnotationsPath() Returns the path to the external annotations file or directory, or null if no external annotations are associated with this classpath entry.
IJavaProject	getJavaProject() Returns the Java project associated with this runtime classpath entry or null if none.
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	getMemento() Returns a memento for this classpath entry.
IPath	getPath() Returns the path associated with this entry, or null if none.
IResource	getResource() Returns the resource associated with this entry, or null if none.
IRuntimeClasspathEntry[]	getRuntimeClasspathEntries() Default implementation returns an empty collection.
java.lang.String	getSourceAttachmentLocation() Returns an absolute path in the local file system for the source attachment associated with this entry entry, or null if none.
IPath	getSourceAttachmentPath() Returns the path to the source archive associated with this entry, or null if this classpath entry has no source attachment.
java.lang.String	getSourceAttachmentRootLocation() Returns a path relative to this entry's source attachment path for the root location containing source, or null if none.
IPath	getSourceAttachmentRootPath() Returns the path within the source archive where package fragments are located.
java.lang.String	getVariableName() Returns the first segment of the path associated with this entry, or null if this entry is not of type VARIABLE or CONTAINER.
boolean	isAutomodule() Returns true if the java project associated is an AutoModule.
boolean	isComposite() Returns whether this classpath entry is composed of other entries.
void	setClasspathProperty(int property) Sets whether this entry should appear on the bootstrap classpath, the user classpath, or whether this entry is a standard bootstrap entry that does not need to appear on the classpath.
void	setExternalAnnotationsPath(IPath path) Sets the path to the external annotations file or directory.
protected void	setJavaProject(IJavaProject javaProject) Sets the Java project associated with this entry.
void	setSourceAttachmentPath(IPath path) Sets the path to the source archive associated with this entry, or null if this classpath entry has no source attachment.
void	setSourceAttachmentRootPath(IPath path) Sets the path within the source archive where package fragments are located.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jdt.launching.IRuntimeClasspathEntry2

getName, getRuntimeClasspathEntries, getTypeId, initializeFrom

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

getType

Constructor Detail

AbstractRuntimeClasspathEntry

public AbstractRuntimeClasspathEntry()

Method Detail

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

Returns:

whether this classpath entry is composed of other entries

getRuntimeClasspathEntries

public IRuntimeClasspathEntry[] getRuntimeClasspathEntries()
                                                    throws CoreException

Default implementation returns an empty collection. Subclasses should override if required.

Returns:

the array of entries

Throws:

CoreException - if computing the entries fails

See Also:

IRuntimeClasspathEntry2

abort

protected void abort(java.lang.String message,
                     java.lang.Throwable exception)
              throws CoreException

Throws an exception with the given message and underlying exception.

Parameters:

message - error message

exception - underlying exception or null if none

Throws:

CoreException - the new CoreException

getMemento

public java.lang.String getMemento()
                            throws CoreException

Description copied from interface: IRuntimeClasspathEntry

Returns a memento for this classpath entry.

Since 3.0, the memento for a contributed classpath entry (i.e. of type OTHER), must be in the form of an XML document, with the following element structure:

 <runtimeClasspathEntry id="exampleId">
    <memento
       key1="value1"
                 ...>
    </memento>
 </runtimeClasspathEntry>
 

The id attribute is the unique identifier of the extension that contributed this runtime classpath entry type, via the extension point org.eclipse.jdt.launching.runtimeClasspathEntries. The memento element will be used to initialize a restored runtime classpath entry, via the method IRuntimeClasspathEntry2.initializeFrom(Element memento). The attributes of the memento element are client defined.

Specified by:

getMemento in interface IRuntimeClasspathEntry

Returns:

a memento for this classpath entry

Throws:

CoreException - if an exception occurs generating a memento

buildMemento

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

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

Parameters:

document - XML document

memento - element node for client specific attributes

Throws:

CoreException - if unable to create a memento

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

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

Returns:

the resource associated with this entry, or null

getSourceAttachmentPath

public IPath getSourceAttachmentPath()

Description copied from interface: IRuntimeClasspathEntry

Returns the path to the source archive associated with this entry, or null if this classpath entry has no source attachment.

Only archive and variable entries may have source attachments. For archive entries, the path (if present) locates a source archive. For variable entries, the path (if present) has an analogous form and meaning as the variable path, namely the first segment is the name of a classpath variable.

Specified by:

getSourceAttachmentPath in interface IRuntimeClasspathEntry

Returns:

the path to the source archive, or null if none

setSourceAttachmentPath

public void setSourceAttachmentPath(IPath path)

Description copied from interface: IRuntimeClasspathEntry

Sets the path to the source archive associated with this entry, or null if this classpath entry has no source attachment.

Only archive and variable entries may have source attachments. For archive entries, the path refers to a source archive. For variable entries, the path has an analogous form and meaning as the variable path, namely the first segment is the name of a classpath variable.

Note that an empty path (Path.EMPTY) is considered null.

Specified by:

setSourceAttachmentPath in interface IRuntimeClasspathEntry

Parameters:

path - the path to the source archive, or null if none

getSourceAttachmentRootPath

public IPath getSourceAttachmentRootPath()

Description copied from interface: IRuntimeClasspathEntry

Returns the path within the source archive where package fragments are located. An empty path indicates that packages are located at the root of the source archive. Returns a non-null value if and only if getSourceAttachmentPath returns a non-null value.

Specified by:

getSourceAttachmentRootPath in interface IRuntimeClasspathEntry

Returns:

root path within the source archive, or null if not applicable

setSourceAttachmentRootPath

public void setSourceAttachmentRootPath(IPath path)

Description copied from interface: IRuntimeClasspathEntry

Sets the path within the source archive where package fragments are located. A root path indicates that packages are located at the root of the source archive. Only valid if a source attachment path is also specified.

Note that an empty path (Path.EMPTY) is considered null.

Specified by:

setSourceAttachmentRootPath in interface IRuntimeClasspathEntry

Parameters:

path - root path within the source archive, or null

getExternalAnnotationsPath

public IPath getExternalAnnotationsPath()

Description copied from interface: IRuntimeClasspathEntry

Returns the path to the external annotations file or directory, or null if no external annotations are associated with this classpath entry.

Specified by:

getExternalAnnotationsPath in interface IRuntimeClasspathEntry

Returns:

The path to the external annotations file or directory, or null if not present.

setExternalAnnotationsPath

public void setExternalAnnotationsPath(IPath path)

Description copied from interface: IRuntimeClasspathEntry

Sets the path to the external annotations file or directory. It should be set to null if no annotations are associated with this entry.

Specified by:

setExternalAnnotationsPath in interface IRuntimeClasspathEntry

Parameters:

path - The file or directory holding external annotations.

getClasspathProperty

public int getClasspathProperty()

Description copied from interface: IRuntimeClasspathEntry

Returns a constant indicating where this entry should appear on the runtime classpath by default. The value returned is one of the following:

• STANDARD_CLASSES - a standard entry does not need to appear on the runtime classpath
• BOOTSTRAP_CLASSES - a bootstrap entry should appear on the boot path
• USER_CLASSES - a user entry should appear on the path containing user or application classes

Specified by:

getClasspathProperty in interface IRuntimeClasspathEntry

Returns:

where this entry should appear on the runtime classpath

setClasspathProperty

public void setClasspathProperty(int property)

Description copied from interface: IRuntimeClasspathEntry

Sets whether this entry should appear on the bootstrap classpath, the user classpath, or whether this entry is a standard bootstrap entry that does not need to appear on the classpath. The location is one of:

• STANDARD_CLASSES - a standard entry does not need to appear on the runtime classpath
• BOOTSTRAP_CLASSES - a bootstrap entry should appear on the boot path
• USER_CLASSES - a user entry should appear on the path conatining user or application classes

Specified by:

setClasspathProperty in interface IRuntimeClasspathEntry

Parameters:

property - a classpat property constant

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

Returns:

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

getSourceAttachmentLocation

public java.lang.String getSourceAttachmentLocation()

Description copied from interface: IRuntimeClasspathEntry

Returns an absolute path in the local file system for the source attachment associated with this entry entry, or null if none.

Specified by:

getSourceAttachmentLocation in interface IRuntimeClasspathEntry

Returns:

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

getSourceAttachmentRootLocation

public java.lang.String getSourceAttachmentRootLocation()

Description copied from interface: IRuntimeClasspathEntry

Returns a path relative to this entry's source attachment path for the root location containing source, or null if none.

Specified by:

getSourceAttachmentRootLocation in interface IRuntimeClasspathEntry

Returns:

a path relative to this entry's source attachment path for the root location containing source, or null if none

getVariableName

public java.lang.String getVariableName()

Description copied from interface: IRuntimeClasspathEntry

Returns the first segment of the path associated with this entry, or null if this entry is not of type VARIABLE or CONTAINER.

Specified by:

getVariableName in interface IRuntimeClasspathEntry

Returns:

the first segment of the path associated with this entry, or null if this entry is not of type VARIABLE or CONTAINER

getClasspathEntry

public IClasspathEntry getClasspathEntry()

Description copied from interface: IRuntimeClasspathEntry

Returns a classpath entry equivalent to this runtime classpath entry, or null if none.

Since 3.0, this method may return null.

Specified by:

getClasspathEntry in interface IRuntimeClasspathEntry

Returns:

a classpath entry equivalent to this runtime classpath entry, or null

getJavaProject

public IJavaProject getJavaProject()

Description copied from interface: IRuntimeClasspathEntry

Returns the Java project associated with this runtime classpath entry or null if none. Runtime classpath entries of type CONTAINER may be associated with a project for the purposes of resolving the entries in a container.

Specified by:

getJavaProject in interface IRuntimeClasspathEntry

Returns:

the Java project associated with this runtime classpath entry or null if none

setJavaProject

protected void setJavaProject(IJavaProject javaProject)

Sets the Java project associated with this entry.

Parameters:

javaProject - the Java project context

isAutomodule

public boolean isAutomodule()

Description copied from interface: IRuntimeClasspathEntry

Returns true if the java project associated is an AutoModule.

Specified by:

isAutomodule in interface IRuntimeClasspathEntry

Returns:

true if the Java project associated is an AutoModule or false if not