org.eclipse.emf.common

Class CommonPlugin

java.lang.Object

org.eclipse.emf.common.util.DelegatingResourceLocator

org.eclipse.emf.common.EMFPlugin

org.eclipse.emf.common.CommonPlugin

All Implemented Interfaces:

Logger, ResourceLocator

public final class CommonPlugin
extends EMFPlugin

The Plugin for the model EMF.Common library. EMF must run within an Eclipse workbench, within a headless Eclipse workspace, or just stand-alone as part of some other application. To support this, all resource access should be directed to the resource locator, which can redirect the service as appropriate to the runtime. During stand-alone invocation no plugin initialization takes place. In this case, common.resources.jar must be on the CLASSPATH.

See Also:

INSTANCE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommonPlugin.ElementRecord A simple representation of an element in a plugin.xml.
static class	CommonPlugin.Implementation The actual implementation of the Eclipse Plugin.
static class	CommonPlugin.SimpleTargetPlatformRegistryImpl<K,V> A specialized HashMap map that supports computing information from the target platform, if the PDE is available.

Nested classes/interfaces inherited from class org.eclipse.emf.common.EMFPlugin

EMFPlugin.EclipsePlugin, EMFPlugin.InternalEclipsePlugin, EMFPlugin.InternalHelper, EMFPlugin.OSGiDelegatingBundleActivator

Field Summary

Fields

Modifier and Type	Field and Description
static CommonPlugin	INSTANCE The singleton instance of the plugin.

Fields inherited from class org.eclipse.emf.common.EMFPlugin

delegateResourceLocators, IS_ECLIPSE_RUNNING, IS_RESOURCES_BUNDLE_AVAILABLE

Fields inherited from class org.eclipse.emf.common.util.DelegatingResourceLocator

baseURL, bundleLocalization, images, resourceBundle, shouldTranslate, strings, untranslatedResourceBundle, untranslatedStrings

Method Summary

Modifier and Type	Method and Description
static URI	asLocalURI(URI uri) Use the platform, if available, to convert to a local URI.
java.util.Comparator<java.lang.String>	getComparator() Returns a string comparator appropriate for collating strings for the current locale.
java.util.Comparator<java.lang.String>	getComparator(java.util.Locale locale) Returns a string comparator appropriate for collating strings for the give locale.
static CommonPlugin.Implementation	getPlugin() Returns the singleton instance of the Eclipse plugin.
ResourceLocator	getPluginResourceLocator() Returns an Eclipse plugin implementation of a resource locator.
static java.util.Map<java.lang.String,URI>	getTargetPlatformBundleMappings() Computes a map from bundle symbolic name to the bundle's location URI.
static java.util.Map<java.lang.String,java.util.List<CommonPlugin.ElementRecord>>	getTargetPlatformExtensionPoints(java.util.Set<java.lang.String> extensionPoints) Computes a list of element records for each requested extension point.
static java.lang.Class<?>	loadClass(java.lang.String pluginID, java.lang.String className) Use the platform, if available, to load the named class using the right class loader.
static URI	resolve(URI uri) Use the platform, if available, to resolve the URI.

Methods inherited from class org.eclipse.emf.common.EMFPlugin

getDelegateResourceLocators, getPluginLogger, getPrimaryResourceLocator, getSymbolicName, log, main

Methods inherited from class org.eclipse.emf.common.util.DelegatingResourceLocator

delegatedGetImage, delegatedGetString, doGetImage, doGetString, extensionFor, getBaseURL, getBundleLocalization, getImage, getString, getString, getString, getString, setShouldTranslate, shouldTranslate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.emf.common.util.ResourceLocator

getBaseURL, getImage, getString, getString, getString, getString

Field Detail

INSTANCE

public static final CommonPlugin INSTANCE

The singleton instance of the plugin.

Method Detail

getPluginResourceLocator

public ResourceLocator getPluginResourceLocator()

Description copied from class: EMFPlugin

Returns an Eclipse plugin implementation of a resource locator.

Specified by:

getPluginResourceLocator in class EMFPlugin

Returns:

an Eclipse plugin implementation of a resource locator.

getPlugin

public static CommonPlugin.Implementation getPlugin()

Returns the singleton instance of the Eclipse plugin.

Returns:

the singleton instance.

asLocalURI

public static URI asLocalURI(URI uri)

Use the platform, if available, to convert to a local URI.

resolve

public static URI resolve(URI uri)

Use the platform, if available, to resolve the URI.

loadClass

public static java.lang.Class<?> loadClass(java.lang.String pluginID,
                                           java.lang.String className)
                                    throws java.lang.ClassNotFoundException

Use the platform, if available, to load the named class using the right class loader.

Throws:

java.lang.ClassNotFoundException

getTargetPlatformExtensionPoints

public static java.util.Map<java.lang.String,java.util.List<CommonPlugin.ElementRecord>> getTargetPlatformExtensionPoints(java.util.Set<java.lang.String> extensionPoints)

Computes a list of element records for each requested extension point. Each key in the map is extension point ID.

The corresponding value is a list of the extension point element records associated with that extension point.

Each root element record has synthetic attributes derived from the extension point:

point

The extension point ID itself.

symbolicName

The symbolic name of the bundle that contains the extension point.

location

The root location URI the bundle containing the extension point. For example, platform:/resource/org.example.plugin for an extension point in the workspace, file:/folder/org.eclipse.plugin for folder bundle in the target platform, or archive:file:/file/folder/org.example.plugin.jar!/ for a jarred bundle in the target platform. This is useful for resolving a relative path in attribute value to its absolute path in the bundle.

This method uses the Plug-in Development Environment (PDE) to compute the results. It will include results for plug-ins in the workspace as well as for plug-ins in the target platform. If PDE is not available, this information cannot be computed.

Parameters:

extensionPoints - a set of extension points to query; if it's null or empty, all extension points will be queried.

Returns:

a map of extension point data, or null if PDE is not available.

Since:

2.14

getTargetPlatformBundleMappings

public static java.util.Map<java.lang.String,URI> getTargetPlatformBundleMappings()

Computes a map from bundle symbolic name to the bundle's location URI.

This method uses the Plug-in Development Environment (PDE) to compute the results. It will include results for plug-ins in the workspace as well as for plug-ins in the target platform. If PDE is not available, this information cannot be computed.

Returns:

a map from bundle symbolic name to the bundle's location URI, or null if PDE is not available.

Since:

2.14

getComparator

public java.util.Comparator<java.lang.String> getComparator()

Returns a string comparator appropriate for collating strings for the current locale.

Returns:

a string comparator appropriate for collating strings for the current locale.

getComparator

public java.util.Comparator<java.lang.String> getComparator(java.util.Locale locale)

Returns a string comparator appropriate for collating strings for the give locale. This will use ICU, when available that plug-in is available, or Collator otherwise.

Parameters:

locale - the locale for which a comparator is needed.

Returns:

a string comparator appropriate for collating strings for the give locale.