public class RegistryStrategy extends Object
In this strategy:
System.out
;'%'/;
This class can be used without OSGi running.
This class can be overridden and/or instantiated by clients.
Constructor and Description |
---|
RegistryStrategy(File[] storageDirs,
boolean[] cacheReadOnly)
Constructor for this default registry strategy.
|
Modifier and Type | Method and Description |
---|---|
boolean |
cacheLazyLoading()
Specifies if lazy cache loading is used.
|
boolean |
cacheUse()
Specifies if the extension registry should use cache to store registry data between
invocations.
|
Object |
createExecutableExtension(RegistryContributor contributor,
String className,
String overridenContributorName)
Creates an executable extension.
|
boolean |
debug()
Override this method to specify debug requirements to the registry.
|
boolean |
debugRegistryEvents()
Override this method to specify debug requirements for the registry event processing.
|
long |
getContainerTimestamp()
This method is called as a part of the registry cache validation.
|
long |
getContributionsTimestamp()
This method is called as a part of the registry cache validation.
|
String |
getLocale()
Returns the current locale for the extension registry with enabled
multi-language support.
|
int |
getLocationsLength()
Returns the number of possible cache locations for this registry.
|
File |
getStorage(int index)
Returns the possible registry cache location identified by the index.
|
SAXParserFactory |
getXMLParser()
Returns the parser used by the registry to parse descriptions of extension points and extensions.
|
boolean |
isCacheReadOnly(int index)
Returns the read-only status of the registry cache location.
|
void |
log(IStatus status)
Override this method to provide customized logging functionality
to the registry.
|
void |
onStart(IExtensionRegistry registry)
Deprecated.
|
void |
onStart(IExtensionRegistry registry,
boolean loadedFromCache)
Override this method to provide additional processing performed
when the registry is created and started.
|
void |
onStop(IExtensionRegistry registry)
Override this method to provide additional processing to be performed
just before the registry is stopped.
|
static IStatus |
processChangeEvent(Object[] listeners,
Map deltas,
Object registry)
This method performs actual processing of the registry change event.
|
void |
scheduleChangeEvent(Object[] listeners,
Map deltas,
Object registry)
Override this method to customize scheduling of an extension registry event.
|
String[] |
translate(String[] nonTranslated,
IContributor contributor,
String locale)
Translates array of keys supplied by the contributor to the requested locale.
|
String |
translate(String key,
ResourceBundle resources)
Translates key using the supplied resource bundle.
|
public RegistryStrategy(File[] storageDirs, boolean[] cacheReadOnly)
The strategy sequentially checks the array of storage directories to
discover the location of the registry cache formed by previous invocations of the extension
registry. Once found, the location is used to store registry cache. If this value
is null
then caching of the registry content is disabled.
The cache read-only array is an array the same length as the storage directory array.
It contains boolean values indicating whether or not each storage directory is read-only.
If the value at an index is true
then the location at the corresponding index
in the storage directories array is read-only; if false
then the cache location
is read-write. The array can be null
if the storageDirs
parameter
is null
.
storageDirs
- array of file system directories, or null
cacheReadOnly
- array of read only attributes, or null
public final int getLocationsLength()
public final File getStorage(int index)
index
- index of the possible registry locationpublic final boolean isCacheReadOnly(int index)
index
- the index of the possible registry locationtrue
if the location is read only and
false
if the location is read/writepublic void log(IStatus status)
This method writes a message to System.out
in the following format:
[Error|Warning|Log]: Main error message [Error|Warning|Log]: Child error message 1 ... [Error|Warning|Log]: Child error message N
status
- the status to logpublic String translate(String key, ResourceBundle resources)
null
.
The default translation routine assumes that keys are prefixed with '%'. If no resource bundle is present, the key itself (without leading '%') is returned. There is no decoding for the leading '%%'.
key
- message key to be translatedresources
- resource bundle, or null
null
public void onStart(IExtensionRegistry registry)
onStart(IExtensionRegistry, boolean)
.super.onStart()
at the beginning of the processing.
NOTE: Avoid placing duplicate functionality in
this method and onStart(IExtensionRegistry, boolean)
as
both methods will be called on the registry startup.
registry
- the extension registry being startedpublic void onStart(IExtensionRegistry registry, boolean loadedFromCache)
super.onStart()
at the beginning of the processing.registry
- the extension registry being startedloadedFromCache
- true is registry contents was loaded from
cache when the registry was createdpublic void onStop(IExtensionRegistry registry)
super.onStop()
at the end of the processing.registry
- the extension registry being stoppedpublic Object createExecutableExtension(RegistryContributor contributor, String className, String overridenContributorName) throws CoreException
This method receives the contributor of the executable extension and, possibly,
an optional contributor name if specified by the executable extension. The overridden
contributor name might be null
.
In this implementation registry attempts to instantiate the class specified via
the class name (must not be null
) using standard Java reflection mechanism.
This method assumes that such class has a default constructor with no arguments.
contributor
- the contributor of this executable extensionclassName
- the name of the class to be instantiatedoverridenContributorName
- the contributor to be used, or null
if not specifiednull
CoreException
- if there was a problem creating the executable extensionIConfigurationElement.createExecutableExtension(String)
,
IExecutableExtension
public void scheduleChangeEvent(Object[] listeners, Map deltas, Object registry)
RegistryStrategy.processChangeEvent(listeners, deltas, registry);
In the default implementation, the method registry events are executed in a queue on a separate thread (i.e. asynchronously, sequentially).
listeners
- the list of active listeners (thread safe); may not be null
deltas
- the registry deltas (thread safe); may not be null
registry
- the extension registry (NOT thread safe); may not be null
public static final IStatus processChangeEvent(Object[] listeners, Map deltas, Object registry)
null
if an unexpected registry type was encountered.listeners
- the list of active listeners; may not be null
deltas
- the extension registry deltas; may not be null
registry
- the extension registry; may not be null
null
public boolean debug()
false
indicating that debug functionality
is turned off.
Note that in a general case the extension registry plug-in doesn't depend on OSGI and therefore cannot use Eclipse .options files to discover debug options.
true
if debug logging and validation should be performed and
false
otherwisepublic boolean debugRegistryEvents()
false
indicating that
debug of the registry events is turned off.
Note that in a general case the extension registry plug-in doesn't depend on OSGI and therefore cannot use Eclipse .options files to discover debug options.
true
if debug logging and validation of the registry events
should be performed and false
otherwisepublic boolean cacheUse()
The default implementation enables caching returning true
.
true
if the cache should be used and false
otherwisepublic boolean cacheLazyLoading()
The default implementation specifies that lazy cache loading is going to be used
and therefore returns true
.
true
if lazy cache loading is used and false
otherwisepublic long getContainerTimestamp()
The method produces a number that corresponds to the current state of the data stored by the container. Increment the stamp if the data stored in the container has been updated so that the data cached by the registry is no longer valid. For instance, in Eclipse addition or removal of a bundle results in the number returned by this method being incremented. As a result, if a bundle that contributed plugin.xml into the extension registry was modified, the state doesn't match the state stored in the registry cache. In this case the cache content becomes invalid and the registry needs to be re-created from the original data.
Generally, treat this number as a hash code for the data stored in the registry. It stays the same as long as the registry content is not changing. It becomes a different number as the registry content gets modified.
Return 0 to indicate that state verification is not required.
public long getContributionsTimestamp()
The value returned by the method is compared with the timestamp tracked by the registry.
If contributions changed since they have been added to the registry (i.e., plugin.xml
file was modified since the last run), the value of the getContributionsTimestamp()
will change and no longer will be the same as the value tracked by the registry. In this case
the cache is considered to be invalid and the registry is going to be re-populated form scratch.
(The word "timestamp" is used very loosely here. In this context, "timestamp" is more likely to be a hash value aggregating a number of actual timestamps from the contributions.)
This method may return 0 to indicate that no time stamp verification is required.
public SAXParserFactory getXMLParser()
null
.IExtensionRegistry.addContribution(java.io.InputStream, IContributor, boolean, String, ResourceBundle, Object)
public String[] translate(String[] nonTranslated, IContributor contributor, String locale)
This method is intended to be overridden by specialized registry strategies that know translation conventions for the contributors, for instance, the agreed upon locations of the translated keys for bundle contributors. The base implementation simply returns the array of non-translated keys.
This method is only used if multi-language support is enabled.
nonTranslated
- message keys to be translatedcontributor
- the contributor of the keys to be translatedlocale
- the requested locale for the keysIExtensionRegistry.isMultiLanguage()
public String getLocale()
The default implementation assumes that there is a single system wide
locale, equivalent to Locale.getDefault()
.
The result of this method should not be retained or passed to other threads. The current locale can change any time and may be different for each thread.
This method can be overridden by subclasses that wish to provide a way to change the default locale.
This method is only used if multi-language support is enabled.
IExtensionRegistry.isMultiLanguage()
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.