Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.emf.common
Class EMFPlugin.EclipsePlugin

java.lang.Object
  org.eclipse.core.runtime.Plugin
      org.eclipse.emf.common.EMFPlugin.EclipsePlugin

All Implemented Interfaces:

org.osgi.framework.BundleActivator, Logger, ResourceLocator

Direct Known Subclasses:

ChangeEditPlugin.Implementation, CodeGenEcorePlugin.Implementation, CodeGenPlugin.Implementation, CommonPlugin.Implementation, CommonUIPlugin.Implementation, Ecore2EcoreEditorPlugin.Implementation, Ecore2EcorePlugin.Implementation, EcoreEditorPlugin.Implementation, EcoreEditPlugin.Implementation, EcorePlugin.Implementation, EMFEditPlugin.Implementation, EMFEditUIPlugin.Implementation, GenModelEditPlugin.Implementation, MappingPlugin.Implementation, XMIPlugin.Implementation

Enclosing class:

EMFPlugin

public abstract static class EMFPlugin.EclipsePlugin

extends Plugin

implements ResourceLocator, Logger

The actual implementation of an Eclipse Plugin.

Field Summary

Fields inherited from class org.eclipse.core.runtime.Plugin

PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME

Constructor Summary

EMFPlugin.EclipsePlugin()
Creates an instance.

EMFPlugin.EclipsePlugin(IPluginDescriptor descriptor)
Deprecated.

Method Summary

protected Object	doGetImage(String key) Does the work of fetching the image associated with the key.
URL	getBaseURL() Returns the URL from which all resources are based.
Object	getImage(String key) Returns the description that can be used to create the image resource associated with the key.
String	getString(String key) Returns the string resource associated with the key.
String	getString(String key, Object[] substitutions) Returns a string resource associated with the key, and peforms substitutions.
String	getSymbolicName() Return the plugin ID.
void	log(Object logEntry) Logs an entry.

Methods inherited from class org.eclipse.core.runtime.Plugin

find, find, getBundle, getDescriptor, getLog, getPluginPreferences, getStateLocation, initializeDefaultPluginPreferences, internalInitializeDefaultPluginPreferences, isDebugging, openStream, openStream, savePluginPreferences, setDebugging, shutdown, start, startup, stop, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EMFPlugin.EclipsePlugin

public EMFPlugin.EclipsePlugin()

Creates an instance.

EMFPlugin.EclipsePlugin

public EMFPlugin.EclipsePlugin(IPluginDescriptor descriptor)

Deprecated.

Creates an instance.

Parameters:

descriptor - the description of the plugin.

Method Detail

getSymbolicName

public String getSymbolicName()

Return the plugin ID.

getBaseURL

public URL getBaseURL()

Description copied from interface: ResourceLocator

Returns the URL from which all resources are based.

Specified by:

getBaseURL in interface ResourceLocator

Returns:

the URL from which all resources are based.

getImage

public Object getImage(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

Parameters:

key - the key of the image resource.

Returns:

the description on the image resource.

doGetImage

protected Object doGetImage(String key)
                     throws 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:

IOException - if an image doesn't exist.

getString

public String getString(String key)

Description copied from interface: ResourceLocator

Returns the string resource associated with the key.

Specified by:

getString in interface ResourceLocator

Parameters:

key - the key of the string resource.

Returns:

the string resource associated with the key.

getString

public String getString(String key,
                        Object[] substitutions)

Description copied from interface: ResourceLocator

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

Specified by:

getString in interface 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(Object logEntry)

Description copied from interface: Logger

Logs an entry.

Specified by:

log in interface Logger

Parameters:

logEntry - a plastic entry to log.