Eclipse Platform
Release 3.4

org.eclipse.ui.model
Interface IComparableContribution

All Superinterfaces:
IAdaptable

public interface IComparableContribution
extends IAdaptable

Instances of this interface represent a contribution within the workbench. This interface is typically implemented by the workbench itself although extension developers may wish to implement it as well for their own extensions.

Since:
3.4

Field Summary
static int PRIORITY_DEFAULT
          The default priority (0);
 
Method Summary
 Object getAdapter(Class adapter)
          Possible adaptations include: IConfigurationElement useful for contributions that eventually work back to registry elements.
 String getLabel()
          Return the human readable label for this contribution.
 int getPriority()
          Return the priority of this contribution.
 

Field Detail

PRIORITY_DEFAULT

public static final int PRIORITY_DEFAULT
The default priority (0);

See Also:
Constant Field Values
Method Detail

getPriority

public int getPriority()
Return the priority of this contribution. Lower values constitute higher priorities.

Returns:
the priority

getLabel

public String getLabel()
Return the human readable label for this contribution. Must not be null.

Returns:
the label for this contribution

getAdapter

public Object getAdapter(Class adapter)
Possible adaptations include:
IConfigurationElement
useful for contributions that eventually work back to registry elements. The majority of IComparableContribution instances provided by the platform will provide this adapter.

Specified by:
getAdapter in interface IAdaptable
Parameters:
adapter - the adapter class to look up
Returns:
a object castable to the given class, or null if this object does not have an adapter for the given class

Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.