|
Eclipse JDT Release 3.6 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRuntimeClasspathEntry
Represents an entry on a runtime classpath. A runtime classpath entry may refer to one of the following:
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.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.VARIABLE
) - a variable refers to a
classpath variable, which may refer to a jar.CONTAINER
) - a container refers to classpath
container variable which refers to a collection of archives derived
dynamically, on a per project basis.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 contributing a classpath entry
type (i.e. type OTHER
). Note, contributed classpath entries
are new in 3.0, and are only intended to be contributed by the Java debugger.
IRuntimeClasspathEntry2
Field Summary | |
---|---|
static int |
ARCHIVE
Type identifier for archive entries. |
static int |
BOOTSTRAP_CLASSES
Classpath property identifier for entries that should appear on the bootstrap path explicitly. |
static int |
CONTAINER
Type identifier for container entries. |
static int |
OTHER
Type identifier for contributed entries. |
static int |
PROJECT
Type identifier for project entries. |
static int |
STANDARD_CLASSES
Classpath property identifier for entries that appear on the bootstrap path by default. |
static int |
USER_CLASSES
Classpath property identifier for entries that should appear on the user classpath. |
static int |
VARIABLE
Type identifier for variable entries. |
Method Summary | |
---|---|
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. |
IJavaProject |
getJavaProject()
Returns the Java project associated with this runtime classpath entry or null if none. |
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 . |
String |
getMemento()
Returns a memento for this classpath entry. |
org.eclipse.core.runtime.IPath |
getPath()
Returns the path associated with this entry, or null
if none. |
org.eclipse.core.resources.IResource |
getResource()
Returns the resource associated with this entry, or null
if none. |
String |
getSourceAttachmentLocation()
Returns an absolute path in the local file system for the source attachment associated with this entry entry, or null if none. |
org.eclipse.core.runtime.IPath |
getSourceAttachmentPath()
Returns the path to the source archive associated with this entry, or null if this classpath entry has no
source attachment. |
String |
getSourceAttachmentRootLocation()
Returns a path relative to this entry's source attachment path for the root location containing source, or null if none. |
org.eclipse.core.runtime.IPath |
getSourceAttachmentRootPath()
Returns the path within the source archive where package fragments are located. |
int |
getType()
Returns this classpath entry's type. |
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 . |
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. |
void |
setSourceAttachmentPath(org.eclipse.core.runtime.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(org.eclipse.core.runtime.IPath path)
Sets the path within the source archive where package fragments are located. |
Field Detail |
---|
static final int PROJECT
static final int ARCHIVE
static final int VARIABLE
static final int CONTAINER
static final int OTHER
static final int STANDARD_CLASSES
static final int BOOTSTRAP_CLASSES
static final int USER_CLASSES
Method Detail |
---|
int getType()
PROJECT
ARCHIVE
VARIABLE
CONTAINER
OTHER
Since 3.0, a type of OTHER
may be returned.
String getMemento() throws org.eclipse.core.runtime.CoreException
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.
org.eclipse.core.runtime.CoreException
- if an exception occurs generating a mementoorg.eclipse.core.runtime.IPath getPath()
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
.
null
IClasspathEntry.getPath()
org.eclipse.core.resources.IResource getResource()
null
if none. A project, archive, or folder entry may be associated
with a resource.
null
org.eclipse.core.runtime.IPath getSourceAttachmentPath()
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.
null
if nonevoid setSourceAttachmentPath(org.eclipse.core.runtime.IPath path)
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
.
path
- the path to the source archive, or null
if noneorg.eclipse.core.runtime.IPath getSourceAttachmentRootPath()
null
value
if and only if getSourceAttachmentPath
returns
a non-null
value.
null
if
not applicablevoid setSourceAttachmentRootPath(org.eclipse.core.runtime.IPath path)
Note that an empty path (Path.EMPTY
) is considered
null
.
path
- root path within the source archive, or null
int getClasspathProperty()
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
void setClasspathProperty(int location)
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
location
- a classpat property constantString getLocation()
null
if none, or if this entry is of type CONTAINER
.
null
if noneString getSourceAttachmentLocation()
null
if none.
null
if noneString getSourceAttachmentRootLocation()
null
if none.
null
if noneString getVariableName()
null
if this entry is not of type VARIABLE
or CONTAINER
.
null
if this entry is not of type VARIABLE
or CONTAINER
IClasspathEntry getClasspathEntry()
null
if none.
Since 3.0, this method may return null
.
null
IJavaProject getJavaProject()
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.
null
if none
|
Eclipse JDT Release 3.6 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |