KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > update > core > ICategory


1 /*******************************************************************************
2  * Copyright (c) 2000, 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.update.core;
12
13 import org.eclipse.core.runtime.IAdaptable;
14
15 /**
16  * Feature category definition.
17  * A site can organize its features into categories. Categories
18  * can be further organized into hierarchies. Each category name
19  * is a composed of the name of its parent and a simple identifier
20  * separated by a slash ("/"). For example <code>tools/utilities/print</code>
21  * defines a category that is a child of <code>tools/utilities</code> and
22  * grandchild of <code>tools</code>.
23  * <p>
24  * Clients may implement this interface. However, in most cases clients should
25  * directly instantiate or subclass the provided implementation of this
26  * interface.
27  * </p>
28  * <p>
29  * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
30  * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
31  * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
32  * (repeatedly) as the API evolves.
33  * </p>
34  * @see org.eclipse.update.core.Category
35  * @since 2.0
36  */
37 public interface ICategory extends IAdaptable{
38
39     /**
40      * Retrieve the name of the category. The name can be a simple
41      * token (root category) or a number of slash-separated ("/")
42      * tokens.
43      *
44      * @return the category name
45      * @since 2.0
46      */
47     public String JavaDoc getName();
48
49     /**
50      * Retrieve the displayable label for the category
51      *
52      * @return displayable category label, or <code>null</code>
53      * @since 2.0
54      */
55     public String JavaDoc getLabel();
56
57     /**
58      * Retrieve the detailed category description
59      *
60      * @return category description, or <code>null</code>
61      * @since 2.0
62      */
63     public IURLEntry getDescription();
64 }
65
Popular Tags