| org.eclipse.jdt.launching.IRuntimeClasspathEntry
All known Subclasses: org.eclipse.jdt.internal.launching.RuntimeClasspathEntry,
| IRuntimeClasspathEntry | | public interface IRuntimeClasspathEntry (Code) | | Represents an entry on a runtime classpath. A runtime classpath entry
may refer to one of the following:
- A Java project (type
PROJECT) - a project entry refers
to all of the built classes in a project, and resolves to the output
location(s) of the associated Java project.
- An archive (type
ARCHIVE) - an archive refers to a jar, zip, or
folder in the workspace or in the local file system containing class
files. An archive may have attached source.
- A variable (type
VARIABLE) - a variable refers to a
classpath variable, which may refer to a jar.
- A library (type
CONTAINER) - a container refers to classpath
container variable which refers to a collection of archives derived
dynamically, on a per project basis.
- A contributed classpath entry (type
OTHER) - a contributed
classpath entry is an extension contributed by a plug-in. The resolution
of a contributed classpath entry is client defined. See
IRuntimeClasspathEntry2.
Clients may implement this interface for contributed a classpath entry
types (i.e. type OTHER). Note, contributed classpath entries
are new in 3.0, and are only intended to be contributed by the Java debugger.
since:
2.0
See Also: org.eclipse.jdt.launching.IRuntimeClasspathEntry2 |
| Field Summary | |
| final public static int | ARCHIVE
Type identifier for archive entries. | | final public static int | BOOTSTRAP_CLASSES
Classpath property identifier for entries that should appear on the
bootstrap path explicitly. | | final public static int | CONTAINER
Type identifier for container entries. | | final public static int | OTHER
Type identifier for contributed entries. | | final public static int | PROJECT
Type identifier for project entries. | | final public static int | STANDARD_CLASSES
Classpath property identifier for entries that appear on the
bootstrap path by default. | | final public static int | USER_CLASSES
Classpath property identifier for entries that should appear on the
user classpath. | | final public static int | VARIABLE
Type identifier for variable entries. |
| Method Summary | |
| public IClasspathEntry | getClasspathEntry()
Returns a classpath entry equivalent to this runtime classpath entry,
or null if none. | | public int | getClasspathProperty()
Returns a constant indicating where this entry should appear on the
runtime classpath by default. | | public IJavaProject | getJavaProject()
Returns the Java project associated with this runtime classpath entry
or null if none. | | public 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. | | public String | getMemento()
Returns a memento for this classpath entry.
Since 3.0, the memento for a contributed classpath entry (i.e. | | public IPath | getPath()
Returns the path associated with this entry, or null
if none. | | public IResource | getResource()
Returns the resource associated with this entry, or null
if none. | | public String | getSourceAttachmentLocation()
Returns an absolute path in the local file system for the source
attachment associated with this entry entry, or null if none. | | public IPath | getSourceAttachmentPath()
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. | | public String | getSourceAttachmentRootLocation()
Returns a path relative to this entry's source attachment path for the
root location containing source, or null if none. | | public IPath | getSourceAttachmentRootPath()
Returns the path within the source archive where package fragments
are located. | | public int | getType()
Returns this classpath entry's type. | | public 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. | | public void | setClasspathProperty(int location)
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. | | public 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.
Only archive and variable entries may have source attachments.
For archive entries, the path refers to a source
archive. | | public void | setSourceAttachmentRootPath(IPath path)
Sets the path within the source archive where package fragments
are located. |
| ARCHIVE | | final public static int ARCHIVE(Code) | | Type identifier for archive entries.
|
| BOOTSTRAP_CLASSES | | final public static int BOOTSTRAP_CLASSES(Code) | | Classpath property identifier for entries that should appear on the
bootstrap path explicitly.
|
| CONTAINER | | final public static int CONTAINER(Code) | | Type identifier for container entries.
|
| OTHER | | final public static int OTHER(Code) | | Type identifier for contributed entries.
since:
3.0 |
| PROJECT | | final public static int PROJECT(Code) | | Type identifier for project entries.
|
| STANDARD_CLASSES | | final public static int STANDARD_CLASSES(Code) | | Classpath property identifier for entries that appear on the
bootstrap path by default.
|
| USER_CLASSES | | final public static int USER_CLASSES(Code) | | Classpath property identifier for entries that should appear on the
user classpath.
|
| VARIABLE | | final public static int VARIABLE(Code) | | Type identifier for variable entries.
|
| getClasspathEntry | | public IClasspathEntry getClasspathEntry()(Code) | | Returns a classpath entry equivalent to this runtime classpath entry,
or null if none.
Since 3.0, this method may return null.
a classpath entry equivalent to this runtime classpath entry,or null
since:
2.1 |
| getClasspathProperty | | public int getClasspathProperty()(Code) | | 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 classpathBOOTSTRAP_CLASSES - a bootstrap entry should appear on the
boot pathUSER_CLASSES - a user entry should appear on the path
containing user or application classes
where this entry should appear on the runtime classpath |
| getJavaProject | | public IJavaProject getJavaProject()(Code) | | 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.
the Java project associated with this runtime classpath entryor null if none
since:
3.0 |
| getLocation | | public String getLocation()(Code) | | Returns an absolute path in the local file system for this entry,
or null if none, or if this entry is of type CONTAINER.
an absolute path in the local file system for this entry,or null if none |
| getMemento | | public String getMemento() throws CoreException(Code) | | 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:
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.
a memento for this classpath entry
exception:
CoreException - if an exception occurs generating a memento |
| getPath | | public IPath getPath()(Code) | | 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.
the path associated with this entry, or null
See Also: org.eclipse.jdt.core.IClasspathEntry.getPath |
| getResource | | public IResource getResource()(Code) | | Returns the resource associated with this entry, or null
if none. A project, archive, or folder entry may be associated
with a resource.
the resource associated with this entry, or null |
| getSourceAttachmentLocation | | public String getSourceAttachmentLocation()(Code) | | Returns an absolute path in the local file system for the source
attachment associated with this entry entry, or null if none.
an absolute path in the local file system for the sourceattachment associated with this entry entry, or null if none |
| getSourceAttachmentPath | | public IPath getSourceAttachmentPath()(Code) | | 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.
the path to the source archive, or null if none |
| getSourceAttachmentRootLocation | | public String getSourceAttachmentRootLocation()(Code) | | Returns a path relative to this entry's source attachment path for the
root location containing source, or null if none.
a path relative to this entry's source attachment path for theroot location containing source, or null if none |
| getSourceAttachmentRootPath | | public IPath getSourceAttachmentRootPath()(Code) | | 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.
root path within the source archive, or null ifnot applicable |
| getType | | public int getType()(Code) | | Returns this classpath entry's type. The type of a runtime classpath entry is
identified by one of the following constants:
PROJECTARCHIVEVARIABLECONTAINEROTHER
Since 3.0, a type of OTHER may be returned.
this classpath entry's type |
| getVariableName | | public String getVariableName()(Code) | | Returns the first segment of the path associated with this entry, or null
if this entry is not of type VARIABLE or CONTAINER.
the first segment of the path associated with this entry, or nullif this entry is not of type VARIABLE or CONTAINER |
| setClasspathProperty | | public void setClasspathProperty(int location)(Code) | | 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 classpathBOOTSTRAP_CLASSES - a bootstrap entry should appear on the
boot pathUSER_CLASSES - a user entry should appear on the path
conatining user or application classes
Parameters:
location - a classpat property constant |
| setSourceAttachmentPath | | public void setSourceAttachmentPath(IPath path)(Code) | | 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.
Parameters:
path - the path to the source archive, or null if none |
| setSourceAttachmentRootPath | | public void setSourceAttachmentRootPath(IPath path)(Code) | | 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.
Parameters:
path - root path within the source archive, or null |
|
|