ISourceContainerType


1   /*******************************************************************************
2    * Copyright (c) 2000, 2006 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.debug.core.sourcelookup;
12  
13  
14  
15  /**
16   * A source container type represents a kind of container of source code.
17   * For example, a source container type may be a project or a directory. A specific
18   * project or directory is represented by an instance of a source container type,
19   * which is called a source container (<code>ISourceContainer</code>).
20   * <p>
21   * A source container type is contributed via the <code>sourceContainerTypes</code>
22   * extension point, providing a delegate to the work specific to the contributed
23   * type. Following is an example contribution.
24   * <pre>
25   * &lt;extension point=&quot;org.eclipse.debug.core.sourceContainerTypes&quot;&gt;
26   *  &lt;sourceContainerType
27   *      name=&quot;Project&quot;
28   *      class=&quot;org.eclipse.debug.internal.core.sourcelookup.containers.ProjectSourceContainerType&quot;
29   *      id=&quot;org.eclipse.debug.core.containerType.project&quot;
30   *      description=&quot;A project in the workspace&quot;&gt;
31   *  &lt;/sourceContainerType&gt;
32   * &lt;/extension&gt;
33   * </pre>
34   * </p>
35   * <p>
36   * Clients are not intended to implement this interface. Instead, clients contributing
37   * a source container type implement {@link org.eclipse.debug.core.sourcelookup.ISourceContainerTypeDelegate}.
38   * </p>
39   * @see org.eclipse.debug.core.sourcelookup.ISourceContainer
40   * @see org.eclipse.debug.core.sourcelookup.ISourceContainerTypeDelegate
41   * @since 3.0
42   */
43  public interface ISourceContainerType extends ISourceContainerTypeDelegate {
44  
45      /**
46       * Returns the name of this source container type that can be used for
47       * presentation purposes. For example, <code>Working Set</code> or
48       * <code>Project</code>.  The value returned is
49       * identical to the name specified in plugin.xml by the <code>name</code>
50       * attribute.
51       * 
52       * @return the name of this source container type
53       */
54      public String   getName();
55  
56      /**
57       * Returns the unique identifier associated with this source container type.
58       * The value returned is identical to the identifier specified in plugin.xml by
59       * the <code>id</code> attribute.
60       * 
61       * @return the unique identifier associated with this source container type
62       */
63      public String   getId();
64      
65      /**
66       * Returns a short description of this source container type that can be used
67       * for presentation purposes, or <code>null</code> if none.
68       * 
69       * @return a short description of this source container type, or <code>null</code>
70       */
71      public String   getDescription();
72      
73  }
74
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags