ILogicalStructureTypeDelegate2


1   /*******************************************************************************
2    * Copyright (c) 2000, 2007 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.model;
12  
13  
14  /**
15   * Optional extension to <code>ILogicalStructureTypeDelegate</code> that allows
16   * a logical structure type delegate to provide a description for a value.
17   * This allows a logical structure type to provide logical structures and
18   * descriptions for more than one type of value.
19   * <p>
20   * If a logical structure type delegate implements this interface, it will
21   * be consulted for a description rather than using the description attribute
22   * provided in plug-in XML.
23   * </p>
24   * <p>
25   * Clients contributing logical structure types can implement this
26   * interface.
27   * </p>
28   * @since 3.1
29   * @see org.eclipse.debug.core.ILogicalStructureType
30   */
31  public interface ILogicalStructureTypeDelegate2 {
32      
33      /**
34       * Returns a simple description of the logical structure provided by this
35       * structure type delegate, for the given value.
36       * Cannot return <code>null</code>. This method is only called if this
37       * logical structure type delegate returns <code>true</code> for
38       * <code>providesLogicalStructure(IValue)</code>.
39       * 
40       * @param value a value a description is requested for
41       * @return a simple description of the logical structure provided by this
42       * structure type delegate, for the given value
43       */
44      public String   getDescription(IValue value);
45  
46  }
47
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags