blob: 617f8daeb3796c59165a93459e752117e420fbce (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
/*******************************************************************************
* Copyright (c) 2000, 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.debug.core;
import org.eclipse.debug.core.model.ILogicalStructureTypeDelegate;
import org.eclipse.debug.core.model.ILogicalStructureTypeDelegate2;
/**
* Provides a value representing the logical structure of a raw implementation value
* from a debug model. Logical structures are useful for navigating complex data
* structures. Logical structure types are contributed via extensions in plug-in XML,
* and provide a delegate for performing logical value computation. Logical
* structure types can be retrieved from the <code>DebugPlugin</code>.
* <p>
* Following is example plug-in XML to define a logical structure type.
* </p>
* <pre>
* <extension point="org.eclipse.debug.core.logicalStructureTypes">
* <logicalStructureType
* id="com.example.ExampleLogicalStructure"
* class="com.example.ExampleLogicalStructureDelegate"
* modelIdentifier="com.example.debug.model"
* description="Ordered Collection">
* </logicalStructureType>
* </extension>
* </pre>
* <p>
* The attributes are specified as follows:
* <ul>
* <li>id - unique identifier for this logical structure type</li>
* <li>class - fully qualified name of class that implements
* <code>ILogicalStructureTypeDelegate</code></li>
* <li>modelIdentifier - identifier of the debug model this logical structure
* type is associated with</li>
* <li>description - description of the logical structure provided</li>
* </ul>
* </p>
* <p>
* Clients contributing logicalStructureType extensions are not intended to implement
* this interface. Rather, they provide an <code>ILogicalStructureTypeDelegate</code>
* that optionally implements <code>ILogicalStructureTypeDelegate2</code> to provide
* dynamic descriptions of logical structures.
* Since 3.1, clients contributing logicalStructureProviders extensions may implement this
* interface to return a collection of logical structure types applicable to a value.
* </p>
* @since 3.0
* @see org.eclipse.debug.core.model.ILogicalStructureTypeDelegate
* @see org.eclipse.debug.core.ILogicalStructureProvider
*/
public interface ILogicalStructureType extends ILogicalStructureTypeDelegate, ILogicalStructureTypeDelegate2 {
/**
* Returns a simple description of the logical structure provided by this
* structure type.
* <p>
* Since 3.1, this method can return <code>null</code> if this logical structure
* type's delegate implements <code>ILogicalStructureTypeDelegate2</code>.
* </p>
*
* @return a simple description of the logical structure provided by this
* structure type, possibly <code>null</code>
*/
public String getDescription();
/**
* Returns this logical structure type's unique identifier, as defined
* in plug-in XML.
*
* @return this logical structure type's unique identifier
*/
public String getId();
}
|