|
Eclipse JDT 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
conatiner variable which refers to a collection of archives derived
dynamically, on a per project basis.Clients are not intended to implement this interface.
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 |
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. |
int |
getClasspathProperty()
Returns a constant indicating where this entry should appear on the runtime classpath by default. |
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. |
IPath |
getPath()
Returns the path associated with this entry. |
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. |
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. |
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(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. |
Field Detail |
public static final int PROJECT
public static final int ARCHIVE
public static final int VARIABLE
public static final int CONTAINER
public static final int STANDARD_CLASSES
public static final int BOOTSTRAP_CLASSES
public static final int USER_CLASSES
Method Detail |
public int getType()
PROJECT
ARCHIVE
VARIABLE
CONTAINER
public String getMemento() throws CoreException
CoreException
- if an exception occurrs generating a mementopublic IPath getPath()
PROJECT
- a workspace relative path to the associated
project.ARCHIVE
- the absolute path of the assoicated archive,
which may or may not be in the workspace.VARIALBE
- the path corresponding to the associated
classpath variable entry.CONTAINER
- the path corresponding to the associated
classpath container variable entry.IClasspathEntry.getPath()
public IResource getResource()
null
if none. A project, archive, or folder entry may be associated
with a resource.null
public 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 nonepublic void setSourceAttachmentPath(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.
path
- the path to the source archive, or null
if nonepublic IPath getSourceAttachmentRootPath()
null
value
if and only if getSourceAttachmentPath
returns
a non-null
value.null
if
not applicablepublic void setSourceAttachmentRootPath(IPath path)
path
- root path within the source archive, or null
public 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
conatining user or application classespublic 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 classeslocation
- a classpat property constantpublic String getLocation()
null
if none, or if this entry is of type CONTAINER
.null
if nonepublic String getSourceAttachmentLocation()
null
if none.null
if nonepublic String getSourceAttachmentRootLocation()
null
if none.null
if nonepublic String getVariableName()
null
if this entry is not of type VARIABLE
or CONTAINER
.null
if this entry is not of type VARIABLE
or CONTAINER
public IClasspathEntry getClasspathEntry()
|
Eclipse JDT 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |