KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > debug > ui > memory > IMemoryRenderingType


1 /*******************************************************************************
2  * Copyright (c) 2004, 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.ui.memory;
12
13 import org.eclipse.core.runtime.CoreException;
14
15 /**
16  * Represents a type of memory rendering contributed via the <code>memoryRenderings</code>
17  * extension point.
18  * <p>
19  * Clients contributing a rendering usually
20  * implement {@link org.eclipse.debug.ui.memory.IMemoryRenderingTypeDelegate}
21  * and {@link org.eclipse.debug.ui.memory.IMemoryRendering}. Clients providing
22  * dynamic rendering bindings via an
23  * {@link org.eclipse.debug.ui.memory.IMemoryRenderingBindingsProvider}
24  * may implement this interface.
25  * </p>
26  * @since 3.1
27  */
28 public interface IMemoryRenderingType {
29     
30     /**
31      * Returns a label for this type of memory rendering.
32      *
33      * @return a label for this type of memory rendering
34      */
35     public String JavaDoc getLabel();
36     
37     /**
38      * Returns the unique identifier for this rendering type.
39      *
40      * @return the unique identifier for this rendering type
41      */
42     public String JavaDoc getId();
43     
44     /**
45      * Creates and returns a new rendering of this type or <code>null</code>
46      * if none.
47      *
48      * @return a new rendering of this type
49      * @exception CoreException if an exception occurs creating
50      * the rendering
51      */
52     public IMemoryRendering createRendering() throws CoreException;
53
54 }
55
Popular Tags