| /******************************************************************************* |
| * Copyright (c) 2000, 2010 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.update.core; |
| |
| import org.eclipse.core.runtime.IAdaptable; |
| |
| /** |
| * Feature category definition. |
| * A site can organize its features into categories. Categories |
| * can be further organized into hierarchies. Each category name |
| * is a composed of the name of its parent and a simple identifier |
| * separated by a slash ("/"). For example <code>tools/utilities/print</code> |
| * defines a category that is a child of <code>tools/utilities</code> and |
| * grandchild of <code>tools</code>. |
| * <p> |
| * Clients may implement this interface. However, in most cases clients should |
| * directly instantiate or subclass the provided implementation of this |
| * interface. |
| * </p> |
| * <p> |
| * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to |
| * change significantly before reaching stability. It is being made available at this early stage to solicit feedback |
| * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken |
| * (repeatedly) as the API evolves. |
| * </p> |
| * @see org.eclipse.update.core.Category |
| * @since 2.0 |
| * @deprecated The org.eclipse.update component has been replaced by Equinox p2. |
| * This API will be deleted in a future release. See bug 311590 for details. |
| */ |
| public interface ICategory extends IAdaptable{ |
| |
| /** |
| * Retrieve the name of the category. The name can be a simple |
| * token (root category) or a number of slash-separated ("/") |
| * tokens. |
| * |
| * @return the category name |
| * @since 2.0 |
| */ |
| public String getName(); |
| |
| /** |
| * Retrieve the displayable label for the category |
| * |
| * @return displayable category label, or <code>null</code> |
| * @since 2.0 |
| */ |
| public String getLabel(); |
| |
| /** |
| * Retrieve the detailed category description |
| * |
| * @return category description, or <code>null</code> |
| * @since 2.0 |
| */ |
| public IURLEntry getDescription(); |
| } |