org.eclipse.core.internal.registry

Class ExtensionRegistry

java.lang.Object

org.eclipse.core.internal.registry.ExtensionRegistry

All Implemented Interfaces:

IExtensionRegistry, IDynamicExtensionRegistry

public class ExtensionRegistry
extends java.lang.Object
implements IExtensionRegistry, IDynamicExtensionRegistry

An implementation for the extension registry API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ExtensionRegistry.ListenerInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected StorageManager	cacheStorageManager
protected java.util.List<org.eclipse.core.internal.registry.ExtensionRegistry.QueueElement>	queue
protected RegistryStrategy	strategy
protected RegistryObjectFactory	theRegistryObjectFactory
protected TableReader	theTableReader

Constructor Summary

Constructors

Constructor and Description
ExtensionRegistry(RegistryStrategy registryStrategy, java.lang.Object masterToken, java.lang.Object userToken)

Method Summary

Modifier and Type	Method and Description
boolean	addContribution(java.io.InputStream is, IContributor contributor, boolean persist, java.lang.String contributionName, java.util.ResourceBundle translationBundle, java.lang.Object key) Adds to this extension registry an extension point(s), extension(s), or a combination of those described by the XML file.
boolean	addContribution(java.io.InputStream is, IContributor contributor, boolean persist, java.lang.String contributionName, java.util.ResourceBundle translationBundle, java.lang.Object key, long timestamp)
boolean	addExtension(java.lang.String identifier, IContributor contributor, boolean persist, java.lang.String label, java.lang.String extensionPointId, ConfigurationElementDescription configurationElements, java.lang.Object token) Adds an extension to the extension registry.
boolean	addExtensionPoint(java.lang.String identifier, IContributor contributor, boolean persist, java.lang.String label, java.lang.String schemaReference, java.lang.Object token) Adds an extension point to the extension registry.
void	addListener(IRegistryEventListener listener) Adds the given listener for registry change events.
void	addListener(IRegistryEventListener listener, java.lang.String extensionPointId) Adds the given listener for registry change events related to specified extension point.
void	addRegistryChangeListener(IRegistryChangeListener listener) Note: for new implementations consider using IExtensionRegistry.addListener(IRegistryEventListener).
void	addRegistryChangeListener(IRegistryChangeListener listener, java.lang.String filter) Note: for new implementations consider using IExtensionRegistry.addListener(IRegistryEventListener, String).
protected boolean	checkCache()
void	clearRegistryCache()
long	computeState()
java.lang.Object	createExecutableExtension(RegistryContributor defaultContributor, java.lang.String className, java.lang.String requestedContributorName)
boolean	debug()
boolean	debugEvents()
IContributor[]	getAllContributors() Returns all contributors associated with the registry at this time.
IConfigurationElement[]	getConfigurationElementsFor(java.lang.String extensionPointId) Returns all configuration elements from all extensions configured into the identified extension point.
IConfigurationElement[]	getConfigurationElementsFor(java.lang.String pluginId, java.lang.String extensionPointSimpleId) Returns all configuration elements from all extensions configured into the identified extension point.
IConfigurationElement[]	getConfigurationElementsFor(java.lang.String pluginId, java.lang.String extensionPointName, java.lang.String extensionId) Returns all configuration elements from the identified extension.
RegistryObjectFactory	getElementFactory()
IExtension	getExtension(java.lang.String extensionId) Returns the specified extension in this extension registry, or null if there is no such extension.
IExtension	getExtension(java.lang.String extensionPointId, java.lang.String extensionId) Returns the specified extension in this extension registry, or null if there is no such extension.
IExtension	getExtension(java.lang.String pluginId, java.lang.String extensionPointName, java.lang.String extensionId) Returns the specified extension in this extension registry, or null if there is no such extension.
IExtensionPoint	getExtensionPoint(java.lang.String xptUniqueId) Returns the extension point with the given extension point identifier in this extension registry, or null if there is no such extension point.
IExtensionPoint	getExtensionPoint(java.lang.String elementName, java.lang.String xpt) Returns the extension point in this extension registry with the given namespace and extension point simple identifier, or null if there is no such extension point.
IExtensionPoint[]	getExtensionPoints() Returns all extension points known to this extension registry.
IExtensionPoint[]	getExtensionPoints(IContributor contributor) Returns all extension points supplied by the contributor, or null if there are no such extension points.
IExtensionPoint[]	getExtensionPoints(java.lang.String namespaceName) Returns all extension points declared in the given namespace.
IExtension[]	getExtensions(IContributor contributor) Returns all extensions supplied by the contributor, or null if there are no such extensions.
IExtension[]	getExtensions(java.lang.String namespaceName) Returns all extensions declared in the given namespace.
java.lang.String	getLocale()
java.lang.String[]	getNamespaces() Returns all namespaces currently used by extensions and extension points in this registry.
RegistryObjectManager	getObjectManager()
java.lang.Object	getTemporaryUserToken() EXPERIMENTAL.
boolean	hasContributor(IContributor contributor) Finds out if registry has the contributor.
boolean	hasContributor(java.lang.String contributorId)
boolean	isMultiLanguage() Call this method to determine if this extension registry supports multiple languages.
void	log(IStatus status)
void	logMultiLangError()
IStatus	processChangeEvent(java.lang.Object[] listenerInfos, java.util.Map<java.lang.String,?> scheduledDeltas)
void	remove(java.lang.String removedContributorId) Unresolves and removes all extensions and extension points provided by the plug-in.
void	remove(java.lang.String removedContributorId, long timestamp)
void	removeContributor(IContributor contributor, java.lang.Object key) Removes all extensions and extension points provided by the contributor.
boolean	removeExtension(IExtension extension, java.lang.Object token) Removes the given extension from this registry.
boolean	removeExtensionPoint(IExtensionPoint extensionPoint, java.lang.Object token) Removes the specified extension point from this registry.
void	removeListener(IRegistryEventListener listener) Removes the given registry change listener from this registry.
void	removeRegistryChangeListener(IRegistryChangeListener listener) Removes the given registry change listener from this registry.
void	scheduleChangeEvent(java.lang.Object[] listenerInfos, java.util.Map<java.lang.String,?> scheduledDeltas)
protected void	setElementFactory()
protected void	setFileManager(java.io.File cacheBase, boolean isCacheReadOnly) Sets new cache file manager.
void	stop(java.lang.Object key) Stops the registry.
protected void	stopChangeEventScheduler()
java.lang.String[]	translate(java.lang.String[] nonTranslated, IContributor contributor, java.lang.String locale)
java.lang.String	translate(java.lang.String key, java.util.ResourceBundle resources) With multi-locale support enabled this method returns the non-translated key so that they can be cached and translated later into desired languages.
boolean	useLazyCacheLoading()

Methods inherited from class java.lang.Object

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

Field Detail

cacheStorageManager

protected StorageManager cacheStorageManager

theTableReader

protected TableReader theTableReader

strategy

protected RegistryStrategy strategy

theRegistryObjectFactory

protected RegistryObjectFactory theRegistryObjectFactory

queue

protected final java.util.List<org.eclipse.core.internal.registry.ExtensionRegistry.QueueElement> queue

Constructor Detail

ExtensionRegistry

public ExtensionRegistry(RegistryStrategy registryStrategy,
                         java.lang.Object masterToken,
                         java.lang.Object userToken)

Method Detail

getObjectManager

public RegistryObjectManager getObjectManager()

setFileManager

protected void setFileManager(java.io.File cacheBase,
                              boolean isCacheReadOnly)

Sets new cache file manager. If existing file manager was owned by the registry, closes it.

Parameters:

cacheBase - the base location for the registry cache

isCacheReadOnly - whether the file cache is read only

addListener

public void addListener(IRegistryEventListener listener)

Description copied from interface: IExtensionRegistry

Adds the given listener for registry change events. Listener will be notified on changes to all extension points and underlying extensions.

Depending on activity, listeners of this type might receive a large number of modifications and negatively impact overall system performance. Whenever possible, consider registering listener specific to an extension point rather than a "global" listener.

Once registered, a listener starts receiving notification of changes to the registry. Registry change notifications are sent asynchronously. The listener continues to receive notifications until it is removed.

This method has no effect if the listener is already registered.

Specified by:

addListener in interface IExtensionRegistry

Parameters:

listener - the listener

addListener

public void addListener(IRegistryEventListener listener,
                        java.lang.String extensionPointId)

Description copied from interface: IExtensionRegistry

Adds the given listener for registry change events related to specified extension point.

Once registered, a listener starts receiving notification of changes to the registry. Registry change notifications are sent asynchronously. The listener continues to receive notifications until it is removed.

This method has no effect if the listener is already registered.

Specified by:

addListener in interface IExtensionRegistry

Parameters:

listener - the listener

extensionPointId - the unique identifier of extension point

See Also:

IExtensionPoint.getUniqueIdentifier()

addRegistryChangeListener

public void addRegistryChangeListener(IRegistryChangeListener listener)

Description copied from interface: IExtensionRegistry

Note: for new implementations consider using IExtensionRegistry.addListener(IRegistryEventListener).

Adds the given listener for registry change events. Has no effect if an identical listener is already registered.

This method is equivalent to:

     addRegistryChangeListener(listener,null);
 

Specified by:

addRegistryChangeListener in interface IExtensionRegistry

Parameters:

listener - the listener

See Also:

IRegistryChangeListener, IRegistryChangeEvent, IExtensionRegistry.addRegistryChangeListener(IRegistryChangeListener, String), IExtensionRegistry.removeRegistryChangeListener(IRegistryChangeListener)

addRegistryChangeListener

public void addRegistryChangeListener(IRegistryChangeListener listener,
                                      java.lang.String filter)

Description copied from interface: IExtensionRegistry

Note: for new implementations consider using IExtensionRegistry.addListener(IRegistryEventListener, String).

Adds the given listener for registry change events related to extension points in the given namespace. Has no effect if an identical listener is already registered. After completion of this method, the given listener will be registered for events related to extension points in the specified namespace. If no namespace is specified, the listener will receive notifications for changes to extension points in any namespace.

Once registered, a listener starts receiving notification of changes to the registry. Registry change notifications are sent asynchronously. The listener continues to receive notifications until it is removed.

Specified by:

addRegistryChangeListener in interface IExtensionRegistry

Parameters:

listener - the listener

filter - the namespace in which to listen for changes

See Also:

IRegistryChangeListener, IRegistryChangeEvent, IExtensionRegistry.removeRegistryChangeListener(IRegistryChangeListener)

getConfigurationElementsFor

public IConfigurationElement[] getConfigurationElementsFor(java.lang.String extensionPointId)

Description copied from interface: IExtensionRegistry

Returns all configuration elements from all extensions configured into the identified extension point. Returns an empty array if the extension point does not exist, has no extensions configured, or none of the extensions contain configuration elements.

Specified by:

getConfigurationElementsFor in interface IExtensionRegistry

Parameters:

extensionPointId - the unique identifier of the extension point (e.g. "org.eclipse.core.resources.builders")

Returns:

the configuration elements

getConfigurationElementsFor

public IConfigurationElement[] getConfigurationElementsFor(java.lang.String pluginId,
                                                           java.lang.String extensionPointSimpleId)

Description copied from interface: IExtensionRegistry

Returns all configuration elements from all extensions configured into the identified extension point. Returns an empty array if the extension point does not exist, has no extensions configured, or none of the extensions contain configuration elements.

Specified by:

getConfigurationElementsFor in interface IExtensionRegistry

Parameters:

pluginId - the namespace for the extension point (e.g. "org.eclipse.core.resources")

extensionPointSimpleId - the simple identifier of the extension point (e.g. "builders")

Returns:

the configuration elements

getConfigurationElementsFor

public IConfigurationElement[] getConfigurationElementsFor(java.lang.String pluginId,
                                                           java.lang.String extensionPointName,
                                                           java.lang.String extensionId)

Description copied from interface: IExtensionRegistry

Returns all configuration elements from the identified extension. Returns an empty array if the extension does not exist or contains no configuration elements.

Specified by:

getConfigurationElementsFor in interface IExtensionRegistry

Parameters:

pluginId - the namespace for the extension point (e.g. "org.eclipse.core.resources")

extensionPointName - the simple identifier of the extension point (e.g. "builders")

extensionId - the unique identifier of the extension (e.g. "com.example.acme.coolbuilder")

Returns:

the configuration elements

getExtension

public IExtension getExtension(java.lang.String extensionId)

Description copied from interface: IExtensionRegistry

Returns the specified extension in this extension registry, or null if there is no such extension.

Specified by:

getExtension in interface IExtensionRegistry

Parameters:

extensionId - the unique identifier of the extension (e.g. "com.example.acme.coolbuilder")

Returns:

the extension, or null

getExtension

public IExtension getExtension(java.lang.String extensionPointId,
                               java.lang.String extensionId)

Description copied from interface: IExtensionRegistry

Returns the specified extension in this extension registry, or null if there is no such extension. The first parameter identifies the extension point, and the second parameter identifies an extension plugged in to that extension point.

Specified by:

getExtension in interface IExtensionRegistry

Parameters:

extensionPointId - the unique identifier of the extension point (e.g. "org.eclipse.core.resources.builders")

extensionId - the unique identifier of the extension (e.g. "com.example.acme.coolbuilder")

Returns:

the extension, or null

getExtension

public IExtension getExtension(java.lang.String pluginId,
                               java.lang.String extensionPointName,
                               java.lang.String extensionId)

Description copied from interface: IExtensionRegistry

Returns the specified extension in this extension registry, or null if there is no such extension. The first two parameters identify the extension point, and the third parameter identifies an extension plugged in to that extension point.

Specified by:

getExtension in interface IExtensionRegistry

Parameters:

pluginId - the namespace for the extension point (e.g. "org.eclipse.core.resources")

extensionPointName - the simple identifier of the extension point (e.g. "builders")

extensionId - the unique identifier of the extension (e.g. "com.example.acme.coolbuilder")

Returns:

the extension, or null

getExtensionPoint

public IExtensionPoint getExtensionPoint(java.lang.String xptUniqueId)

Description copied from interface: IExtensionRegistry

Returns the extension point with the given extension point identifier in this extension registry, or null if there is no such extension point.

Specified by:

getExtensionPoint in interface IExtensionRegistry

Parameters:

xptUniqueId - the unique identifier of the extension point (e.g., "org.eclipse.core.resources.builders")

Returns:

the extension point, or null

getExtensionPoint

public IExtensionPoint getExtensionPoint(java.lang.String elementName,
                                         java.lang.String xpt)

Description copied from interface: IExtensionRegistry

Returns the extension point in this extension registry with the given namespace and extension point simple identifier, or null if there is no such extension point.

Specified by:

getExtensionPoint in interface IExtensionRegistry

Parameters:

elementName - the namespace for the given extension point (e.g. "org.eclipse.core.resources")

xpt - the simple identifier of the extension point (e.g. "builders")

Returns:

the extension point, or null

getExtensionPoints

public IExtensionPoint[] getExtensionPoints()

Description copied from interface: IExtensionRegistry

Returns all extension points known to this extension registry. Returns an empty array if there are no extension points.

Specified by:

getExtensionPoints in interface IExtensionRegistry

Returns:

the extension points known to this extension registry

getExtensionPoints

public IExtensionPoint[] getExtensionPoints(java.lang.String namespaceName)

Description copied from interface: IExtensionRegistry

Returns all extension points declared in the given namespace. Returns an empty array if there are no extension points declared in the namespace.

Specified by:

getExtensionPoints in interface IExtensionRegistry

Parameters:

namespaceName - the namespace for the extension points (e.g. "org.eclipse.core.resources")

Returns:

the extension points in this registry declared in the given namespace

getExtensions

public IExtension[] getExtensions(java.lang.String namespaceName)

Description copied from interface: IExtensionRegistry

Returns all extensions declared in the given namespace. Returns an empty array if no extensions are declared in the namespace.

Specified by:

getExtensions in interface IExtensionRegistry

Parameters:

namespaceName - the namespace for the extensions (e.g. "org.eclipse.core.resources")

Returns:

the extensions in this registry declared in the given namespace

getExtensions

public IExtension[] getExtensions(IContributor contributor)

Description copied from interface: IExtensionRegistry

Returns all extensions supplied by the contributor, or null if there are no such extensions.

Specified by:

getExtensions in interface IExtensionRegistry

Parameters:

contributor - the contributor for the extensions (for OSGi registry, bundles and fragments are different contributors)

Returns:

the extensions, or null

getExtensionPoints

public IExtensionPoint[] getExtensionPoints(IContributor contributor)

Description copied from interface: IExtensionRegistry

Returns all extension points supplied by the contributor, or null if there are no such extension points.

Specified by:

getExtensionPoints in interface IExtensionRegistry

Parameters:

contributor - the contributor for the extensions (for OSGi registry, bundles and fragments are different contributors)

Returns:

the extension points, or null

getNamespaces

public java.lang.String[] getNamespaces()

Description copied from interface: IExtensionRegistry

Returns all namespaces currently used by extensions and extension points in this registry. Returns an empty array if there are no known extensions/extension points in this registry.

The fully-qualified name of an extension point or an extension consist of a namespace and a simple name (much like a qualified Java class name consist of a package name and a class name). The simple names are presumed to be unique in the namespace.

Specified by:

getNamespaces in interface IExtensionRegistry

Returns:

all namespaces known to this registry

hasContributor

public boolean hasContributor(IContributor contributor)

Description copied from interface: IDynamicExtensionRegistry

Finds out if registry has the contributor.

Specified by:

hasContributor in interface IDynamicExtensionRegistry

Parameters:

contributor - registry contributor

Returns:

true if the registry has this contributor; false otherwise

hasContributor

public boolean hasContributor(java.lang.String contributorId)

remove

public void remove(java.lang.String removedContributorId,
                   long timestamp)

removeContributor

public void removeContributor(IContributor contributor,
                              java.lang.Object key)

Description copied from interface: IDynamicExtensionRegistry

Removes all extensions and extension points provided by the contributor.

This method is an access controlled method. Access tokens are specified when the registry is constructed by the registry implementers.

Specified by:

removeContributor in interface IDynamicExtensionRegistry

Parameters:

contributor - the contributor to be removed

key - registry access key

See Also:

RegistryFactory.createRegistry(RegistryStrategy, Object, Object)

remove

public void remove(java.lang.String removedContributorId)

Unresolves and removes all extensions and extension points provided by the plug-in.

A corresponding IRegistryChangeEvent will be broadcast to all listeners interested on changes in the given plug-in.

removeRegistryChangeListener

public void removeRegistryChangeListener(IRegistryChangeListener listener)

Description copied from interface: IExtensionRegistry

Removes the given registry change listener from this registry. Has no effect if an identical listener is not registered.

Specified by:

removeRegistryChangeListener in interface IExtensionRegistry

Parameters:

listener - the listener

See Also:

IRegistryChangeListener, IExtensionRegistry.addRegistryChangeListener(IRegistryChangeListener), IExtensionRegistry.addRegistryChangeListener(IRegistryChangeListener, String)

removeListener

public void removeListener(IRegistryEventListener listener)

Description copied from interface: IExtensionRegistry

Removes the given registry change listener from this registry.

This method has no effect if the listener is not registered.

Specified by:

removeListener in interface IExtensionRegistry

Parameters:

listener - the listener

See Also:

IExtensionRegistry.addListener(IRegistryEventListener), IExtensionRegistry.addListener(IRegistryEventListener, String)

stop

public void stop(java.lang.Object key)

Stops the registry. Registry has to be stopped to properly close cache and dispose of listeners.

Specified by:

stop in interface IExtensionRegistry

Parameters:

key - - key token for this registry

See Also:

RegistryFactory.createRegistry(org.eclipse.core.runtime.spi.RegistryStrategy, Object, Object)

clearRegistryCache

public void clearRegistryCache()

setElementFactory

protected void setElementFactory()

getElementFactory

public RegistryObjectFactory getElementFactory()

log

public void log(IStatus status)

translate

public java.lang.String translate(java.lang.String key,
                                  java.util.ResourceBundle resources)

With multi-locale support enabled this method returns the non-translated key so that they can be cached and translated later into desired languages. In the absence of the multi-locale support the key gets translated immediately and only translated values is cached.

debug

public boolean debug()

debugEvents

public boolean debugEvents()

useLazyCacheLoading

public boolean useLazyCacheLoading()

computeState

public long computeState()

checkCache

protected boolean checkCache()

createExecutableExtension

public java.lang.Object createExecutableExtension(RegistryContributor defaultContributor,
                                                  java.lang.String className,
                                                  java.lang.String requestedContributorName)
                                           throws CoreException

Throws:

CoreException

processChangeEvent

public IStatus processChangeEvent(java.lang.Object[] listenerInfos,
                                  java.util.Map<java.lang.String,?> scheduledDeltas)

scheduleChangeEvent

public void scheduleChangeEvent(java.lang.Object[] listenerInfos,
                                java.util.Map<java.lang.String,?> scheduledDeltas)

stopChangeEventScheduler

protected void stopChangeEventScheduler()

addContribution

public boolean addContribution(java.io.InputStream is,
                               IContributor contributor,
                               boolean persist,
                               java.lang.String contributionName,
                               java.util.ResourceBundle translationBundle,
                               java.lang.Object key,
                               long timestamp)

addContribution

public boolean addContribution(java.io.InputStream is,
                               IContributor contributor,
                               boolean persist,
                               java.lang.String contributionName,
                               java.util.ResourceBundle translationBundle,
                               java.lang.Object key)

Description copied from interface: IExtensionRegistry

Adds to this extension registry an extension point(s), extension(s), or a combination of those described by the XML file. The information in the XML file should be supplied in the same format as the plugin.xml; in fact, Plug-in Manifest editor can be used to prepare the XML file. The top token of the contribution (normally, "plugin" or "fragment" in the Plug-in Manifest editor) is ignored by this method.

This method is an access controlled method. Proper token (master token or user token) should be passed as an argument. Two registry keys are set in the registry constructor RegistryFactory.createRegistry(org.eclipse.core.runtime.spi.RegistryStrategy, Object, Object): master token and a user token. Master token allows all operations; user token allows non-persisted registry elements to be modified.

Specified by:

addContribution in interface IExtensionRegistry

Parameters:

is - stream open on the XML file. The XML file can contain an extension point(s) or/and extension(s) described in the format similar to plugin.xml. The method closes the stream before returning

contributor - the contributor making this contribution.

persist - indicates if the contribution(s) should be stored in the registry cache. If false, contribution is not persisted in the registry cache and is lost on Eclipse restart

contributionName - optional name of the contribution. Used for error reporting; might be null

translationBundle - optional resource bundle used for translations; might be null

key - the key used to check permissions

Returns:

true if the contribution was successfully processed and false otherwise

See Also:

IContributor

addExtensionPoint

public boolean addExtensionPoint(java.lang.String identifier,
                                 IContributor contributor,
                                 boolean persist,
                                 java.lang.String label,
                                 java.lang.String schemaReference,
                                 java.lang.Object token)
                          throws java.lang.IllegalArgumentException

Adds an extension point to the extension registry.

If the registry is not modifiable, this method is an access controlled method. Proper token should be passed as an argument for non-modifiable registries.

Parameters:

identifier - Id of the extension point. If non-qualified names is supplied, it will be converted internally into a fully qualified name

contributor - the contributor of this extension point

persist - indicates if contribution should be stored in the registry cache. If false, contribution is not persisted in the registry cache and is lost on Eclipse restart

label - display string for the extension point

schemaReference - reference to the extension point schema. The schema reference is a URL path relative to the plug-in installation URL. May be null

token - the key used to check permissions. Two registry keys are set in the registry constructor RegistryFactory.createRegistry(org.eclipse.core.runtime.spi.RegistryStrategy, Object, Object): master token and a user token. Master token allows all operations; user token allows non-persisted registry elements to be modified.

Returns:

true if successful, false if a problem was encountered

Throws:

java.lang.IllegalArgumentException - if incorrect token is passed in

addExtension

public boolean addExtension(java.lang.String identifier,
                            IContributor contributor,
                            boolean persist,
                            java.lang.String label,
                            java.lang.String extensionPointId,
                            ConfigurationElementDescription configurationElements,
                            java.lang.Object token)
                     throws java.lang.IllegalArgumentException

Adds an extension to the extension registry.

If the registry is not modifiable, this method is an access controlled method. Proper token should be passed as an argument for non-modifiable registries.

Parameters:

identifier - Id of the extension. If non-qualified name is supplied, it will be converted internally into a fully qualified name

contributor - the contributor of this extension

persist - indicates if contribution should be stored in the registry cache. If false, contribution is not persisted in the registry cache and is lost on Eclipse restart

label - display string for this extension

extensionPointId - Id of the point being extended. If non-qualified name is supplied, it is assumed to have the same contributorId as this extension

configurationElements - contents of the extension

token - the key used to check permissions. Two registry keys are set in the registry constructor RegistryFactory.createRegistry(org.eclipse.core.runtime.spi.RegistryStrategy, Object, Object): master token and a user token. Master token allows all operations; user token allows non-persisted registry elements to be modified.

Returns:

true if successful, false if a problem was encountered

Throws:

java.lang.IllegalArgumentException - if incorrect token is passed in

See Also:

ConfigurationElementDescription

removeExtension

public boolean removeExtension(IExtension extension,
                               java.lang.Object token)
                        throws java.lang.IllegalArgumentException

Description copied from interface: IExtensionRegistry

Removes the given extension from this registry.

This method is an access controlled method. Proper token (master token or user token) should be passed as an argument. Two registry keys are set in the registry constructor RegistryFactory.createRegistry(org.eclipse.core.runtime.spi.RegistryStrategy, Object, Object): master token and a user token. Master token allows all operations; user token only allows non-persisted registry elements to be modified.

Specified by:

removeExtension in interface IExtensionRegistry

Parameters:

extension - extension to be removed

token - the key used to check permissions

Returns:

true if the extension was successfully removed, and false otherwise

Throws:

java.lang.IllegalArgumentException - if an incorrect token is passed

removeExtensionPoint

public boolean removeExtensionPoint(IExtensionPoint extensionPoint,
                                    java.lang.Object token)
                             throws java.lang.IllegalArgumentException

Description copied from interface: IExtensionRegistry

Removes the specified extension point from this registry.

This method is an access controlled method. Proper token (master token or user token) should be passed as an argument. Two registry keys are set in the registry constructor RegistryFactory.createRegistry(org.eclipse.core.runtime.spi.RegistryStrategy, Object, Object): master token and a user token. Master token allows all operations; user token only allows non-persisted registry elements to be modified.

Specified by:

removeExtensionPoint in interface IExtensionRegistry

Parameters:

extensionPoint - extension point to be removed

token - the key used to check permissions

Returns:

true if the extension point was successfully removed, and false otherwise

Throws:

java.lang.IllegalArgumentException - if incorrect token is passed

getAllContributors

public IContributor[] getAllContributors()

Description copied from interface: IDynamicExtensionRegistry

Returns all contributors associated with the registry at this time.

Specified by:

getAllContributors in interface IDynamicExtensionRegistry

Returns:

all contributors associated with the registry

getTemporaryUserToken

public java.lang.Object getTemporaryUserToken()

EXPERIMENTAL. This method has been added as part of a work in progress. There is a guarantee neither that this API will work nor that it will remain the same. Please do not use this method without consulting with the Equinox team.

isMultiLanguage

public boolean isMultiLanguage()

Description copied from interface: IExtensionRegistry

Call this method to determine if this extension registry supports multiple languages.

See the runtime option "-registryMultiLanguage" for enabling multi-language support.

Specified by:

isMultiLanguage in interface IExtensionRegistry

Returns:

true if multiple languages are supported by this instance of the extension registry; false otherwise.

translate

public java.lang.String[] translate(java.lang.String[] nonTranslated,
                                    IContributor contributor,
                                    java.lang.String locale)

getLocale

public java.lang.String getLocale()

logMultiLangError

public void logMultiLangError()