ILogicalStructureType


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.debug.core;
12  
13  import org.eclipse.debug.core.model.ILogicalStructureTypeDelegate;
14  import org.eclipse.debug.core.model.ILogicalStructureTypeDelegate2;
15  
16  /**
17   * Provides a value representing the logical structure of a raw implementation value
18   * from a debug model. Logical structures are useful for navigating complex data
19   * structures. Logical structure types are contributed via extensions in plug-in XML,
20   * and provide a delegate for performing logical value computation. Logical 
21   * structure types can be retrieved from the <code>DebugPlugin</code>.
22   * <p>
23   * Following is example plug-in XML to define a logical structure type.
24   * </p>
25   * <pre>
26   * &lt;extension point=&quot;org.eclipse.debug.core.logicalStructureTypes&quot;&gt;
27   *  &lt;logicalStructureType
28   *   id=&quot;com.example.ExampleLogicalStructure&quot;
29   *   class=&quot;com.example.ExampleLogicalStructureDelegate&quot;
30   *   modelIdentifier=&quot;com.example.debug.model&quot;
31   *   description=&quot;Ordered Collection&quot;&gt;
32   *  &lt;/logicalStructureType&gt;
33   * &lt;/extension&gt;
34   * </pre>
35   * <p>
36   * The attributes are specified as follows:
37   * <ul>
38   * <li>id - unique identifier for this logical structure type</li>
39   * <li>class - fully qualified name of class that implements 
40   *   <code>ILogicalStructureTypeDelegate</code></li>
41   * <li>modelIdentifier - identifier of the debug model this logical structure
42   *   type is associated with</li>
43   * <li>description - description of the logical structure provided</li>
44   * </ul>
45   * </p>
46   * <p>
47   * Clients contributing logicalStructureType extensions are not intended to implement
48   * this interface. Rather, they provide an <code>ILogicalStructureTypeDelegate</code>
49   * that optionally implements <code>ILogicalStructureTypeDelegate2</code> to provide
50   * dynamic descriptions of logical structures.
51   * Since 3.1, clients contributing logicalStructureProviders extensions may implement this
52   * interface to return a collection of logical structure types applicable to a value.
53   * </p>
54   * @since 3.0
55   * @see org.eclipse.debug.core.model.ILogicalStructureTypeDelegate
56   * @see org.eclipse.debug.core.ILogicalStructureProvider
57   */
58  public interface ILogicalStructureType extends ILogicalStructureTypeDelegate, ILogicalStructureTypeDelegate2 {
59      
60      /**
61       * Returns a simple description of the logical structure provided by this
62       * structure type.
63       * <p>
64       * Since 3.1, this method can return <code>null</code> if this logical structure
65       * type's delegate implements <code>ILogicalStructureTypeDelegate2</code>.
66       * </p>
67       * 
68       * @return a simple description of the logical structure provided by this
69       * structure type, possibly <code>null</code>
70       */
71      public String   getDescription();
72      
73      /**
74       * Returns this logical structure type's unique identifier, as defined
75       * in plug-in XML.
76       * 
77       * @return this logical structure type's unique identifier
78       */
79      public String   getId();
80  
81  }
82
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags