IBreakpointOrganizer


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.internal.ui.views.breakpoints;
12  
13  import org.eclipse.debug.ui.IBreakpointOrganizerDelegate;
14  import org.eclipse.jface.resource.ImageDescriptor;
15  
16  /**
17   * A breakpoint organizer is used to categorize breakpoints and provides
18   * change notification when categorization has changed. Breakpoint organizers
19   * are contributed via the <code>breakpointOrganizers</code> extension point.
20   * <p>
21   * This interface is not intended to be implemented. Clients contributing a breakpoint
22   * organizer are intended to implement <code>IBreakpointOrganizerDelegate</code>.
23   * </p>
24   * @since 3.1
25   */
26  public interface IBreakpointOrganizer extends IBreakpointOrganizerDelegate {
27      
28      /**
29       * Returns a label for this breakpoint organizer.
30       * 
31       * @return a label for this breakpoint organizer
32       */
33      public String   getLabel();
34      
35      /**
36       * Returns an image descriptor for this breakpoint organizer or <code>null</code>.
37       * 
38       * @return an image descriptor for this breakpoint organizer or <code>null</code>
39       */
40      public ImageDescriptor getImageDescriptor();
41      
42      /**
43       * Returns a unique identifier for this breakpoint organizer.
44       * 
45       * @return a unique identifier for this breakpoint organizer
46       */
47      public String   getIdentifier();
48      
49      /**
50       * Returns the label for breakpoints that do not fall into a category
51       * for this organizer.
52       * 
53       * @return label for breakpoints that do not fall into a category
54       * for this organizer
55       */
56      public String   getOthersLabel();
57  
58  }
59
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags