org.eclipse.jdt.internal.launching

Class VariableClasspathEntry

java.lang.Object

PlatformObject

org.eclipse.jdt.internal.launching.AbstractRuntimeClasspathEntry

org.eclipse.jdt.internal.launching.VariableClasspathEntry

All Implemented Interfaces:

IRuntimeClasspathEntry, IRuntimeClasspathEntry2

public class VariableClasspathEntry
extends AbstractRuntimeClasspathEntry

Specialization for a String variable classpath entry

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
VariableClasspathEntry() Constructor
VariableClasspathEntry(java.lang.String variableString) Constructor

Method Summary

Modifier and Type	Method and Description
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)
java.lang.String	getName() Returns a human readable name for this classpath entry.
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.
java.lang.String	getVariableString()
int	hashCode()
void	initializeFrom(org.w3c.dom.Element memento) Initializes this runtime classpath entry from the given memento.
void	setVariableString(java.lang.String variableString)

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

abort, getClasspathEntry, getClasspathProperty, getExternalAnnotationsPath, getJavaProject, getLocation, getMemento, getPath, getResource, getRuntimeClasspathEntries, getSourceAttachmentLocation, getSourceAttachmentPath, getSourceAttachmentRootLocation, getSourceAttachmentRootPath, getVariableName, isAutomodule, isComposite, 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

VariableClasspathEntry

public VariableClasspathEntry()

Constructor

VariableClasspathEntry

public VariableClasspathEntry(java.lang.String variableString)

Constructor

Parameters:

variableString - the string value

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

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

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

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

getVariableString

public java.lang.String getVariableString()

Returns:

Returns the variableString.

setVariableString

public void setVariableString(java.lang.String variableString)

Parameters:

variableString - The variableString to set.

hashCode

public int hashCode()

equals

public boolean equals(java.lang.Object obj)