org.eclipse.emf.common
Class EMFPlugin

java.lang.Object
  |
  +--org.eclipse.emf.common.EMFPlugin

All Implemented Interfaces:

Logger, ResourceLocator

Direct Known Subclasses:

CodeGenEcorePlugin, CodeGenPlugin, CommonPlugin, EcoreEditorPlugin, EcoreEditPlugin, EcorePlugin, GenModelEditPlugin, MappingPlugin, XMIPlugin

public abstract class EMFPlugin

extends java.lang.Object

implements ResourceLocator, Logger

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 (e.g., NL strings, images, and so on) is directed to the resource locator methods, which can redirect the service as appopriate to the runtime. During Eclipse invocation, the implementation delegates to a plugin implementation. During stand-alone invocation, no plugin initialization takes place, so the implementation delegates to a resource JAR on the CLASSPATH. The resource jar will typically not be on the CLASSPATH during Eclipse invocation. It will contain things like the icons and the .properties, which are available in a different way during Eclipse invocation.

See Also:

ResourceLocator, Logger

Inner Class Summary

static class

EMFPlugin.EclipsePlugin The actual implementation of an Eclipse Plugin.

Field Summary

protected java.net.URL	baseURL
protected ResourceLocator[]	delegateResourceLocators
protected java.util.Map	images
protected java.util.ResourceBundle	resourceBundle
protected java.util.Map	strings

Constructor Summary

EMFPlugin(ResourceLocator[] delegateResourceLocators)

Method Summary

protected java.lang.Object	delegatedGetImage(java.lang.String key) Does the work of fetching the image associated with the key, when the image resource is not available locally.
protected java.lang.String	delegatedGetString(java.lang.String key) Does the work of fetching the string associated with the key, when the string resource is not available locally.
protected java.lang.Object	doGetImage(java.lang.String key) Does the work of fetching the image associated with the key.
java.net.URL	getBaseURL() Returns the URL from which all resources are based.
java.lang.Object	getImage(java.lang.String key) Returns the description that can be used to create the image resource associated with the key.
Logger	getPluginLogger() Returns an Eclipse plugin implementation of a logger.
abstract ResourceLocator	getPluginResourceLocator() Returns an Eclipse plugin implementation of a resource locator.
java.lang.String	getString(java.lang.String key) Returns the string resource associated with the key.
java.lang.String	getString(java.lang.String key, java.lang.Object[] substitutions) Returns a string resource associated with the key, and peforms substitutions.
void	log(java.lang.Object logEntry) Logs an entry.

Methods inherited from class java.lang.Object

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

Field Detail

delegateResourceLocators

protected ResourceLocator[] delegateResourceLocators

baseURL

protected java.net.URL baseURL

resourceBundle

protected java.util.ResourceBundle resourceBundle

strings

protected java.util.Map strings

images

protected java.util.Map images

Constructor Detail

EMFPlugin

public EMFPlugin(ResourceLocator[] delegateResourceLocators)

Method Detail

getPluginResourceLocator

public abstract ResourceLocator getPluginResourceLocator()

Returns an Eclipse plugin implementation of a resource locator.

Returns:

an Eclipse plugin implementation of a resource locator.

getPluginLogger

public Logger getPluginLogger()

Returns an Eclipse plugin implementation of a logger.

Returns:

an Eclipse plugin implementation of a logger.

getBaseURL

public java.net.URL getBaseURL()

Description copied from interface: ResourceLocator

Returns the URL from which all resources are based.

Specified by:

getBaseURL in interface ResourceLocator

Following copied from interface: org.eclipse.emf.common.util.ResourceLocator

Returns:

the URL from which all resources are based.

getImage

public java.lang.Object getImage(java.lang.String key)

Description copied from interface: ResourceLocator

Returns the description that can be used to create the image resource associated with the key. The description will typically be in the form of a URL to the image data. Creation of an actual image depends on the GUI environment; within Eclipse, org.eclipse.emf.edit.ui.provider.ExtendedImageRegistry can be used.

Specified by:

getImage in interface ResourceLocator

Following copied from interface: org.eclipse.emf.common.util.ResourceLocator

Parameters:

key - the key of the image resource.

Returns:

the description on the image resource.

doGetImage

protected java.lang.Object doGetImage(java.lang.String key)
                               throws java.io.IOException

Does the work of fetching the image associated with the key. It ensures that the image exists.

Parameters:

key - the key of the image to fetch.

Returns:

the description of the image associated with the key.

Throws:

java.io.IOException - if an image doesn't exist.

delegatedGetImage

protected java.lang.Object delegatedGetImage(java.lang.String key)
                                      throws java.util.MissingResourceException

Does the work of fetching the image associated with the key, when the image resource is not available locally.

Parameters:

key - the key of the image to fetch.

Throws:

java.util.MissingResourceException - if the image resource doesn't exist anywhere.

See Also:

delegateResourceLocators

getString

public java.lang.String getString(java.lang.String key)

Description copied from interface: ResourceLocator

Returns the string resource associated with the key.

Specified by:

getString in interface ResourceLocator

Following copied from interface: org.eclipse.emf.common.util.ResourceLocator

Parameters:

key - the key of the string resource.

Returns:

the string resource associated with the key.

delegatedGetString

protected java.lang.String delegatedGetString(java.lang.String key)

Does the work of fetching the string associated with the key, when the string resource is not available locally.

Parameters:

key - the key of the string to fetch.

Throws:

java.util.MissingResourceException - if the string resource doesn't exist anywhere.

See Also:

delegateResourceLocators

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.Object[] substitutions)

Description copied from interface: ResourceLocator

Returns a string resource associated with the key, and peforms substitutions.

Specified by:

getString in interface ResourceLocator

Following copied from interface: org.eclipse.emf.common.util.ResourceLocator

Parameters:

key - the key of the string.

substitutions - the message substitutions.

Returns:

a string resource associated with the key.

See Also:

ResourceLocator.getString(String), MessageFormat.format(String, Object[])

log

public void log(java.lang.Object logEntry)

Description copied from interface: Logger

Logs an entry.

Specified by:

log in interface Logger

Following copied from interface: org.eclipse.emf.common.util.Logger

Parameters:

logEntry - a plastic entry to log.