|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Bundle groups represent a logical collection of plug-ins (aka bundles). Bundle groups do not contain their constituents but rather collect them together under a common label. The main role of a bundle group is to report to the system (e.g., the About dialog) what bundles have been installed. They are not intended for use in managing the set of bundles they represent.
Since the bulk of the branding related information is specific to the consumer, bundle groups also carry an arbitrary set of properties. The valid set of key-value pairs and their interpretation defined by the consumer in the target environment.
The Eclipse UI is the typical consumer of bundle groups and defines various
property keys that it will use, for example, to display About information. See
org.eclipse.ui.branding.IBundleGroupConstants
.
IBundleGroupProvider
Method Summary | |
---|---|
Bundle[] |
getBundles()
Returns a list of all bundles supplied by this bundle group. |
String |
getDescription()
Returns a text description of this bundle group. |
String |
getIdentifier()
Returns the identifier of this bundle group. |
String |
getName()
Returns the human-readable name of this bundle group. |
String |
getProperty(String key)
Returns the property of this bundle group with the given key. |
String |
getProviderName()
Returns the name of the provider of this bundle group. |
String |
getVersion()
Returns the version of this bundle group. |
Method Detail |
public String getIdentifier()
getVersion()
public String getName()
public String getVersion()
getIdentifier()
public String getDescription()
public String getProviderName()
null
if nonepublic Bundle[] getBundles()
public String getProperty(String key)
null
is returned if there is no such key/value pair.
key
- the name of the property to return
null
if none
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.