IRuntimeClasspathEntry2


1   /*******************************************************************************
2    * Copyright (c) 2000, 2005 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    * 
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.jdt.launching;
12  
13  import org.eclipse.core.runtime.CoreException;
14  import org.eclipse.debug.core.ILaunchConfiguration;
15  import org.w3c.dom.Element  ;
16  
17  /**
18   * Enhancements to <code>IRuntimeClasspathEntry</code> to support
19   * extensible runtime classpath entries. Contributed runtime classpath
20   * entries have a type of <code>OTHER</code>, and are contributed to
21   * the <code>runtimeClasspathEntries</code> extension point.
22   * <p>
23   * Clients are not intended to implement this interface, as new types
24   * of runtime classpath entries are only intended to be contributed
25   * by the Java debugger.
26   * </p>
27   * @since 3.0 
28   * @see org.eclipse.jdt.launching.IRuntimeClasspathEntry
29   */
30  public interface IRuntimeClasspathEntry2 extends IRuntimeClasspathEntry {
31      
32      /**
33       * Initializes this runtime classpath entry from the given memento.
34       * 
35       * @param memento memento created by a classpath entry of the same type
36       * @throws CoreException if unable to initialize from the given memento
37       */
38      public void initializeFrom(Element   memento) throws CoreException;
39      
40      /**
41       * Returns the unique identifier of the extension that contributed
42       * this classpath entry type, or <code>null</code> if this classpath
43       * entry type was not contributed.
44       * 
45       * @return the unique identifier of the extension that contributed
46       *  this classpath entry type, or <code>null</code> if this classpath
47       *  entry type was not contributed
48       */
49      public String   getTypeId();
50      
51      /**
52       * Returns whether this classpath entry is composed of other entries.
53       * 
54       * @return whether this classpath entry is composed of other entries
55       */
56      public boolean isComposite();
57      
58      /**
59       * Returns the classpath entries this entry is composed of, or an
60       * empty collection if this entry is not a composite entry.
61       * 
62       * @param configuration the context (launch configuration) in which
63       *  this runtime classpath entry is being queried for contained
64       *  entries, possibly <code>null</code> 
65       * @return the classpath entries this entry is composed of, or an
66       * empty collection if this entry is not a composite entry
67       * @throws CoreException if unable to retrieve contained entries
68       */
69      public IRuntimeClasspathEntry[] getRuntimeClasspathEntries(ILaunchConfiguration configuration) throws CoreException;
70      
71      /**
72       * Returns a human readable name for this classpath entry.
73       * 
74       * @return a human readable name for this classpath entry
75       */
76      public String   getName();
77  }
78
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags