diff options
Diffstat (limited to 'bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime')
23 files changed, 481 insertions, 481 deletions
diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/ContributorFactoryOSGi.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/ContributorFactoryOSGi.java index e33b9095e..fe1fe8177 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/ContributorFactoryOSGi.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/ContributorFactoryOSGi.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -15,8 +15,8 @@ import org.eclipse.core.runtime.spi.RegistryContributor; import org.osgi.framework.Bundle; /** - * The contributor factory creates new registry contributors for use in OSGi-based - * registries. + * The contributor factory creates new registry contributors for use in OSGi-based + * registries. * <p> * This class can not be extended or instantiated by clients. * </p> @@ -27,9 +27,9 @@ import org.osgi.framework.Bundle; public final class ContributorFactoryOSGi { /** - * Creates registry contributor object based on a Bundle. The bundle must not + * Creates registry contributor object based on a Bundle. The bundle must not * be <code>null</code>. - * + * * @param contributor bundle associated with the contribution * @return new registry contributor based on the Bundle */ @@ -54,12 +54,12 @@ public final class ContributorFactoryOSGi { /** * Returns the OSGi bundle used to define this contributor. If a fragment - * was used to create the contributor, the fragment is returned. - * - * <p>The method may return null if the contributor is not based on a bundle, - * if the bundle can't be found, or if the bundle is presently unresolved or + * was used to create the contributor, the fragment is returned. + * + * <p>The method may return null if the contributor is not based on a bundle, + * if the bundle can't be found, or if the bundle is presently unresolved or * uninstalled.</p> - * + * * @param contributor bundle-based registry contributor * @return the actual OSGi bundle associated with this contributor * @since org.eclipse.equinox.registry 3.3 diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/ContributorFactorySimple.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/ContributorFactorySimple.java index ec5f2796c..722481036 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/ContributorFactorySimple.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/ContributorFactorySimple.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -27,9 +27,9 @@ import org.eclipse.core.runtime.spi.RegistryContributor; public final class ContributorFactorySimple { /** - * Creates registry contributor object based on a determining object.The determining + * Creates registry contributor object based on a determining object.The determining * object must not be <code>null</code>. - * + * * @param determiningObject object associated with the contribution * @return new registry contributor based on the determining object */ diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IConfigurationElement.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IConfigurationElement.java index 068b7481d..f9a9d1c9e 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IConfigurationElement.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IConfigurationElement.java @@ -4,14 +4,14 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.core.runtime; /** - * A configuration element, with its attributes and children, + * A configuration element, with its attributes and children, * directly reflects the content and structure of the extension section * within the declaring plug-in's manifest (<code>plugin.xml</code>) file. * <p> @@ -19,8 +19,8 @@ package org.eclipse.core.runtime; * objects. * </p> * <p> - * These registry objects are intended for relatively short-term use. Clients that - * deal with these objects must be aware that they may become invalid if the + * These registry objects are intended for relatively short-term use. Clients that + * deal with these objects must be aware that they may become invalid if the * declaring plug-in is updated or uninstalled. If this happens, all methods except * {@link #isValid()} will throw {@link InvalidRegistryObjectException}. * For configuration element objects, the most common case is code in a plug-in dealing @@ -34,7 +34,7 @@ package org.eclipse.core.runtime; * are vulnerable. Client code can pre-test for invalid objects by calling {@link #isValid()}, * which never throws this exception. However, pre-tests are usually not sufficient * because of the possibility of the extension or configuration element object becoming - * invalid as a result of a concurrent activity. At-risk clients must treat + * invalid as a result of a concurrent activity. At-risk clients must treat * <code>InvalidRegistryObjectException</code> as if it were a checked exception. * Also, such clients should probably register a listener with the extension registry * so that they receive notification of any changes to the registry. @@ -47,26 +47,26 @@ package org.eclipse.core.runtime; */ public interface IConfigurationElement { /** - * Creates and returns a new instance of the executable extension + * Creates and returns a new instance of the executable extension * identified by the named attribute of this configuration element. * The named attribute value must contain a fully qualified name - * of a Java class. The class can either refer to a class implementing - * the executable extension or to a factory capable of returning the + * of a Java class. The class can either refer to a class implementing + * the executable extension or to a factory capable of returning the * executable extension. * <p> * The specified class is instantiated using its 0-argument public constructor. * <p> * Then the following checks are done:<br> - * If the specified class implements the {@link IExecutableExtension} - * interface, the method {@link IExecutableExtension#setInitializationData(IConfigurationElement, String, Object)} - * is called, passing to the object the configuration information that was used to create it. + * If the specified class implements the {@link IExecutableExtension} + * interface, the method {@link IExecutableExtension#setInitializationData(IConfigurationElement, String, Object)} + * is called, passing to the object the configuration information that was used to create it. * <p> - * If the specified class implements {@link IExecutableExtensionFactory} - * interface, the method {@link IExecutableExtensionFactory#create()} + * If the specified class implements {@link IExecutableExtensionFactory} + * interface, the method {@link IExecutableExtensionFactory#create()} * is invoked. * </p> * <p> - * Unlike other methods on this object, invoking this method may activate + * Unlike other methods on this object, invoking this method may activate * the plug-in. * </p> * @@ -82,11 +82,11 @@ public interface IConfigurationElement { /** * Returns the named attribute of this configuration element, or - * <code>null</code> if none. + * <code>null</code> if none. * <p> * The names of configuration element attributes * are the same as the attribute names of the corresponding XML element. - * For example, the configuration markup + * For example, the configuration markup * <pre> * <bg pattern="stripes"/> * </pre> @@ -105,14 +105,14 @@ public interface IConfigurationElement { public String getAttribute(String name) throws InvalidRegistryObjectException; /** - * When multi-language support is enabled, this method returns the named attribute of this - * configuration element in the specified locale, or <code>null</code> if none. + * When multi-language support is enabled, this method returns the named attribute of this + * configuration element in the specified locale, or <code>null</code> if none. * <p> - * The locale matching tries to find the best match between available translations and - * the requested locale, falling back to a more generic locale ("en") when the specific - * locale ("en_US") is not available. + * The locale matching tries to find the best match between available translations and + * the requested locale, falling back to a more generic locale ("en") when the specific + * locale ("en_US") is not available. * </p><p> - * If multi-language support is not enabled, this method is equivalent to the method + * If multi-language support is not enabled, this method is equivalent to the method * {@link #getAttribute(String)}. * </p> * @param attrName the name of the attribute @@ -127,11 +127,11 @@ public interface IConfigurationElement { /** * Returns the named attribute of this configuration element, or - * <code>null</code> if none. + * <code>null</code> if none. * <p> * The names of configuration element attributes * are the same as the attribute names of the corresponding XML element. - * For example, the configuration markup + * For example, the configuration markup * <pre> * <bg pattern="stripes"/> * </pre> @@ -158,7 +158,7 @@ public interface IConfigurationElement { * <p> * The names of configuration element attributes * are the same as the attribute names of the corresponding XML element. - * For example, the configuration markup + * For example, the configuration markup * <pre> * <bg color="blue" pattern="stripes"/> * </pre> @@ -167,19 +167,19 @@ public interface IConfigurationElement { * and <code>"pattern"</code>. * </p> * - * @return the names of the attributes + * @return the names of the attributes * @throws InvalidRegistryObjectException if this configuration element is no longer valid */ public String[] getAttributeNames() throws InvalidRegistryObjectException; /** * Returns all configuration elements that are children of this - * configuration element. + * configuration element. * Returns an empty array if this configuration element has no children. * <p> * Each child corresponds to a nested * XML element in the configuration markup. - * For example, the configuration markup + * For example, the configuration markup * <pre> * <view> *     <verticalHint>top</verticalHint> @@ -197,7 +197,7 @@ public interface IConfigurationElement { public IConfigurationElement[] getChildren() throws InvalidRegistryObjectException; /** - * Returns all child configuration elements with the given name. + * Returns all child configuration elements with the given name. * Returns an empty array if this configuration element has no children * with the given name. * @@ -208,7 +208,7 @@ public interface IConfigurationElement { */ public IConfigurationElement[] getChildren(String name) throws InvalidRegistryObjectException; - /** + /** * Returns the extension that declares this configuration element. * * @return the extension @@ -217,12 +217,12 @@ public interface IConfigurationElement { public IExtension getDeclaringExtension() throws InvalidRegistryObjectException; /** - * Returns the name of this configuration element. + * Returns the name of this configuration element. * The name of a configuration element is the same as - * the XML tag of the corresponding XML element. - * For example, the configuration markup + * the XML tag of the corresponding XML element. + * For example, the configuration markup * <pre> - * <wizard name="Create Project"/> + * <wizard name="Create Project"/> * </pre> * corresponds to a configuration element named <code>"wizard"</code>. * @@ -235,7 +235,7 @@ public interface IConfigurationElement { * Returns the element which contains this element. If this element * is an immediate child of an extension, the * returned value can be downcast to <code>IExtension</code>. - * Otherwise the returned value can be downcast to + * Otherwise the returned value can be downcast to * <code>IConfigurationElement</code>. * * @return the parent of this configuration element @@ -247,7 +247,7 @@ public interface IConfigurationElement { /** * Returns the text value of this configuration element. - * For example, the configuration markup + * For example, the configuration markup * <pre> * <script lang="javascript">.\scripts\cp.js</script> * </pre> @@ -265,14 +265,14 @@ public interface IConfigurationElement { public String getValue() throws InvalidRegistryObjectException; /** - * When multi-language support is enabled, this method returns the text value of this + * When multi-language support is enabled, this method returns the text value of this * configuration element in the specified locale, or <code>null</code> if none. - * <p> - * The locale matching tries to find the best match between available translations and - * the requested locale, falling back to a more generic locale ("en") when the specific - * locale ("en_US") is not available. + * <p> + * The locale matching tries to find the best match between available translations and + * the requested locale, falling back to a more generic locale ("en") when the specific + * locale ("en_US") is not available. * </p><p> - * If multi-language support is not enabled, this method is equivalent to the method + * If multi-language support is not enabled, this method is equivalent to the method * {@link #getValue()}. * </p> * @param locale the requested locale @@ -287,7 +287,7 @@ public interface IConfigurationElement { /** * Returns the untranslated text value of this configuration element. - * For example, the configuration markup + * For example, the configuration markup * <pre> * <script lang="javascript">.\scripts\cp.js</script> * </pre> @@ -298,7 +298,7 @@ public interface IConfigurationElement { * <p> * Note that translation specified in the plug-in manifest * file is <b>not</b> automatically applied. - * For example, the configuration markup + * For example, the configuration markup * <pre> * <tooltip>#hattip</tooltip> * </pre> @@ -316,40 +316,40 @@ public interface IConfigurationElement { /** * Returns the namespace for this configuration element. This value can be used * in various global facilities to discover this configuration element's contributor. - * + * * @return the namespace for this configuration element * @throws InvalidRegistryObjectException if this configuration element is no longer valid * @see IExtensionRegistry * @since 3.1 - * @deprecated As namespace is no longer restricted to the contributor name, + * @deprecated As namespace is no longer restricted to the contributor name, * use {@link #getNamespaceIdentifier()} to obtain namespace name or {@link #getContributor()} * to get the name of the contributor of this registry element. * <p> - * In the past namespace was dictated by the name of the bundle. If bundle <code>org.abc</code> - * contributed registry element with Id of <code>MyId</code>, the namespace of - * the element was always set to <code>org.abc</code>, producing the qualified name of + * In the past namespace was dictated by the name of the bundle. If bundle <code>org.abc</code> + * contributed registry element with Id of <code>MyId</code>, the namespace of + * the element was always set to <code>org.abc</code>, producing the qualified name of * <code>org.abc.MyId</code>. * </p><p> - * The namespace used to be the same as the bundle name. As a result, the {@link #getNamespace()} - * method was used both to obtain the name of the bundle and to obtain the namespace of a registry + * The namespace used to be the same as the bundle name. As a result, the {@link #getNamespace()} + * method was used both to obtain the name of the bundle and to obtain the namespace of a registry * element. * </p><p> - * Since 3.2, the extension registry allows elements to specify qualified name. The extension point - * of the plug-in <code>org.abc</code> could specify <code>org.zzz.MyExtPoint</code> as - * an Id. In this case, namespace name is <code>org.zzz</code>, but the contributor - * name is <code>org.abc</code>. + * Since 3.2, the extension registry allows elements to specify qualified name. The extension point + * of the plug-in <code>org.abc</code> could specify <code>org.zzz.MyExtPoint</code> as + * an Id. In this case, namespace name is <code>org.zzz</code>, but the contributor + * name is <code>org.abc</code>. * </p><p> - * (The use of a simple Id is still a preferred way. Whenever possible, specify only the simple + * (The use of a simple Id is still a preferred way. Whenever possible, specify only the simple * Id and let runtime take care of the rest.) * </p><p> - * If your code used the {@link #getNamespace()} to obtain the name of the contributing bundle, - * use {@link #getContributor()}. The typical usage pattern here is to find a bundle name to obtain - * some information from the corresponding OSGi bundle. For example, deducing the file location + * If your code used the {@link #getNamespace()} to obtain the name of the contributing bundle, + * use {@link #getContributor()}. The typical usage pattern here is to find a bundle name to obtain + * some information from the corresponding OSGi bundle. For example, deducing the file location * specified as a relative path to the bundle install location would fall into this group. * </p><p> - * If your code used the {@link #getNamespace()} to obtain the namespace of the registry element, - * use {@link #getNamespaceIdentifier()}. Typically, this is the case when code is trying to process - * registry elements belonging to some logical group. For example, processing notifications for all + * If your code used the {@link #getNamespace()} to obtain the namespace of the registry element, + * use {@link #getNamespaceIdentifier()}. Typically, this is the case when code is trying to process + * registry elements belonging to some logical group. For example, processing notifications for all * elements belonging to the <code>org.abc</code> namespace would fall into this category. * </p> */ @@ -357,23 +357,23 @@ public interface IConfigurationElement { /** * Returns the namespace name for this configuration element. - * + * * @return the namespace name for this configuration element * @throws InvalidRegistryObjectException if this configuration element is no longer valid - * @since org.eclipse.equinox.registry 3.2 + * @since org.eclipse.equinox.registry 3.2 */ public String getNamespaceIdentifier() throws InvalidRegistryObjectException; /** * Returns the contributor of this configuration element. - * + * * @return the contributor for this configuration element * @throws InvalidRegistryObjectException if this configuration element is no longer valid - * @since org.eclipse.equinox.registry 3.2 + * @since org.eclipse.equinox.registry 3.2 */ public IContributor getContributor() throws InvalidRegistryObjectException; - /* (non-javadoc) + /* (non-javadoc) * @see Object#equals(java.lang.Object) */ @Override @@ -381,7 +381,7 @@ public interface IConfigurationElement { /** * Returns whether this configuration element object is valid. - * + * * @return <code>true</code> if the object is valid, and <code>false</code> * if it is no longer valid * @since 3.1 diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IContributor.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IContributor.java index 20399eb3a..bc568afb4 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IContributor.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IContributor.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -12,9 +12,9 @@ package org.eclipse.core.runtime; /** * This interface describes a registry contributor - an entity that supplies information - * to the extension registry. + * to the extension registry. * <p> - * Registry contributor objects can be obtained by calling {@link IExtensionPoint#getContributor()}, + * Registry contributor objects can be obtained by calling {@link IExtensionPoint#getContributor()}, * {@link IExtension#getContributor()}, and {@link IConfigurationElement#getContributor()}. * Alternatively, a contributor factory appropriate for the registry in use can be called to directly * obtain an IContributor object. @@ -25,7 +25,7 @@ package org.eclipse.core.runtime; * </p> * @see org.eclipse.core.runtime.ContributorFactoryOSGi * @see org.eclipse.core.runtime.ContributorFactorySimple - * + * * @since org.eclipse.equinox.registry 3.2 * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. @@ -34,8 +34,8 @@ public interface IContributor { /** * Provides name of the contributor (e.g., "org.eclipse.core.runtime"). - * - * @return name of the registry contributor + * + * @return name of the registry contributor */ public String getName(); } diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExecutableExtension.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExecutableExtension.java index ccf305999..a72620d7a 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExecutableExtension.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExecutableExtension.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -13,7 +13,7 @@ package org.eclipse.core.runtime; import org.eclipse.core.runtime.CoreException; /** - * Interface for executable extension classes that require access to + * Interface for executable extension classes that require access to * their configuration element, or implement an extension adapter. * <p> * Extension adapters are typically required in cases where the extension @@ -28,19 +28,19 @@ import org.eclipse.core.runtime.CoreException; * </p><p> * Clients may implement this interface. * </p> - * + * * @see IConfigurationElement#createExecutableExtension(String) */ public interface IExecutableExtension { /** * This method is called by the implementation of the method * <code>IConfigurationElement.createExecutableExtension</code> - * on a newly constructed extension, passing it its relevant configuration - * information. Most executable extensions only make use of the first + * on a newly constructed extension, passing it its relevant configuration + * information. Most executable extensions only make use of the first * two call arguments. * <p> - * Regular executable extensions specify their Java implementation - * class name as an attribute of the configuration element for the + * Regular executable extensions specify their Java implementation + * class name as an attribute of the configuration element for the * extension. For example * <pre> * <action run="com.example.BaseAction"/> @@ -105,14 +105,14 @@ public interface IExecutableExtension { * </ul> * </p> * - * @param config the configuration element used to trigger this execution. + * @param config the configuration element used to trigger this execution. * It can be queried by the executable extension for specific * configuration properties * @param propertyName the name of an attribute of the configuration element * used on the <code>createExecutableExtension(String)</code> call. This * argument can be used in the cases where a single configuration element * is used to define multiple executable extensions. - * @param data adapter data in the form of a <code>String</code>, + * @param data adapter data in the form of a <code>String</code>, * a <code>Hashtable</code>, or <code>null</code>. * @exception CoreException if error(s) detected during initialization processing * @see IConfigurationElement#createExecutableExtension(String) diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExecutableExtensionFactory.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExecutableExtensionFactory.java index 3da4a09d6..5be12399e 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExecutableExtensionFactory.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExecutableExtensionFactory.java @@ -11,17 +11,17 @@ package org.eclipse.core.runtime; /** - * This interface allows extension providers to control how the instances provided to extension-points are being created - * by referring to the factory instead of referring to a class. For example, the following extension to the preference page - * extension-point uses a factory called <code>PreferencePageFactory</code>. + * This interface allows extension providers to control how the instances provided to extension-points are being created + * by referring to the factory instead of referring to a class. For example, the following extension to the preference page + * extension-point uses a factory called <code>PreferencePageFactory</code>. * <code><pre> * <extension point="org.eclipse.ui.preferencePages"> - * <page name="..." class="org.eclipse.update.ui.PreferencePageFactory:org.eclipse.update.ui.preferences.MainPreferencePage"> + * <page name="..." class="org.eclipse.update.ui.PreferencePageFactory:org.eclipse.update.ui.preferences.MainPreferencePage"> * </page> * </extension> * </pre> * </code> - * + * * <p> * Effectively, factories give full control over the create executable extension process. * </p><p> @@ -37,7 +37,7 @@ package org.eclipse.core.runtime; public interface IExecutableExtensionFactory { /** * Creates and returns a new instance. - * + * * @exception CoreException if an instance of the executable extension * could not be created for any reason */ diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtension.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtension.java index 9c6337829..1a91f763c 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtension.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtension.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -12,11 +12,11 @@ package org.eclipse.core.runtime; /** * An extension declared in a plug-in. - * All information is obtained from the declaring plug-in's + * All information is obtained from the declaring plug-in's * manifest (<code>plugin.xml</code>) file. * <p> - * These registry objects are intended for relatively short-term use. Clients that - * deal with these objects must be aware that they may become invalid if the + * These registry objects are intended for relatively short-term use. Clients that + * deal with these objects must be aware that they may become invalid if the * declaring plug-in is updated or uninstalled. If this happens, all methods except * {@link #isValid()} will throw {@link InvalidRegistryObjectException}. * For extension objects, the most common case is code in a plug-in dealing @@ -30,7 +30,7 @@ package org.eclipse.core.runtime; * Client code can pre-test for invalid objects by calling {@link #isValid()}, * which never throws this exception. However, pre-tests are usually not sufficient * because of the possibility of the extension object becoming invalid as a - * result of a concurrent activity. At-risk clients must treat + * result of a concurrent activity. At-risk clients must treat * <code>InvalidRegistryObjectException</code> as if it were a checked exception. * Also, such clients should probably register a listener with the extension registry * so that they receive notification of any changes to the registry. @@ -44,7 +44,7 @@ package org.eclipse.core.runtime; public interface IExtension { /** * Returns all configuration elements declared by this extension. - * These elements are a direct reflection of the configuration + * These elements are a direct reflection of the configuration * markup supplied in the manifest (<code>plugin.xml</code>) * file for the plug-in that declares this extension. * Returns an empty array if this extension does not declare any @@ -58,40 +58,40 @@ public interface IExtension { /** * Returns the namespace for this extension. This value can be used * in various global facilities to discover this extension's provider. - * + * * @return the namespace for this extension * @throws InvalidRegistryObjectException if this extension is no longer valid * @see IExtensionRegistry * @since 3.0 - * @deprecated As namespace is no longer restricted to the contributor name, + * @deprecated As namespace is no longer restricted to the contributor name, * use {@link #getNamespaceIdentifier()} to obtain namespace name or {@link #getContributor()} - * to get the name of the contributor of this registry element. + * to get the name of the contributor of this registry element. * <p> - * In the past namespace was dictated by the name of the bundle. If bundle <code>org.abc</code> - * contributed registry element with Id of <code>MyId</code>, the namespace of - * the element was always set to <code>org.abc</code>, producing the qualified name of + * In the past namespace was dictated by the name of the bundle. If bundle <code>org.abc</code> + * contributed registry element with Id of <code>MyId</code>, the namespace of + * the element was always set to <code>org.abc</code>, producing the qualified name of * <code>org.abc.MyId</code>. * </p><p> - * The namespace used to be the same as the bundle name. As a result, the {@link #getNamespace()} - * method was used both to obtain the name of the bundle and to obtain the namespace of a registry + * The namespace used to be the same as the bundle name. As a result, the {@link #getNamespace()} + * method was used both to obtain the name of the bundle and to obtain the namespace of a registry * element. * </p><p> - * Since 3.2, the extension registry allows elements to specify qualified name. The extension point - * of the plug-in <code>org.abc</code> could specify <code>org.zzz.MyExtPoint</code> as - * an Id. In this case, namespace name is <code>org.zzz</code>, but the contributor - * name is <code>org.abc</code>. + * Since 3.2, the extension registry allows elements to specify qualified name. The extension point + * of the plug-in <code>org.abc</code> could specify <code>org.zzz.MyExtPoint</code> as + * an Id. In this case, namespace name is <code>org.zzz</code>, but the contributor + * name is <code>org.abc</code>. * </p><p> - * (The use of a simple Id is still a preferred way. Whenever possible, specify only the simple + * (The use of a simple Id is still a preferred way. Whenever possible, specify only the simple * Id and let runtime take care of the rest.) * </p><p> - * If your code used the {@link #getNamespace()} to obtain the name of the contributing bundle, - * use {@link #getContributor()}. The typical usage pattern here is to find a bundle name to obtain - * some information from the corresponding OSGi bundle. For example, deducing the file location + * If your code used the {@link #getNamespace()} to obtain the name of the contributing bundle, + * use {@link #getContributor()}. The typical usage pattern here is to find a bundle name to obtain + * some information from the corresponding OSGi bundle. For example, deducing the file location * specified as a relative path to the bundle install location would fall into this group. * </p><p> - * If your code used the {@link #getNamespace()} to obtain the namespace of the registry element, - * use {@link #getNamespaceIdentifier()}. Typically, this is the case when code is trying to process - * registry elements belonging to some logical group. For example, processing notifications for all + * If your code used the {@link #getNamespace()} to obtain the namespace of the registry element, + * use {@link #getNamespaceIdentifier()}. Typically, this is the case when code is trying to process + * registry elements belonging to some logical group. For example, processing notifications for all * elements belonging to the <code>org.abc</code> namespace would fall into this category. * </p> */ @@ -99,19 +99,19 @@ public interface IExtension { /** * Returns the namespace name for this extension. - * + * * @return the namespace name for this extension * @throws InvalidRegistryObjectException if this extension is no longer valid - * @since org.eclipse.equinox.registry 3.2 + * @since org.eclipse.equinox.registry 3.2 */ public String getNamespaceIdentifier() throws InvalidRegistryObjectException; /** * Returns the contributor of this extension. - * + * * @return the contributor for this extension * @throws InvalidRegistryObjectException if this extension is no longer valid - * @since org.eclipse.equinox.registry 3.2 + * @since org.eclipse.equinox.registry 3.2 */ public IContributor getContributor() throws InvalidRegistryObjectException; @@ -139,15 +139,15 @@ public interface IExtension { public String getLabel() throws InvalidRegistryObjectException; /** - * When multi-language support is enabled, this method returns a displayable label for this + * When multi-language support is enabled, this method returns a displayable label for this * extension in the specified locale. Returns the empty string if no label for this extension * is specified in the plug-in manifest file. - * <p> - * The locale matching tries to find the best match between available translations and - * the requested locale, falling back to a more generic locale ("en") when the specific - * locale ("en_US") is not available. + * <p> + * The locale matching tries to find the best match between available translations and + * the requested locale, falling back to a more generic locale ("en") when the specific + * locale ("en_US") is not available. * </p><p> - * If multi-language support is not enabled, this method is equivalent to the method + * If multi-language support is not enabled, this method is equivalent to the method * {@link #getLabel()}. * </p> * @param locale the requested locale @@ -162,8 +162,8 @@ public interface IExtension { /** * Returns the simple identifier of this extension, or <code>null</code> * if this extension does not have an identifier. - * This identifier is specified in the plug-in manifest (<code>plugin.xml</code>) - * file as a non-empty string containing no period characters + * This identifier is specified in the plug-in manifest (<code>plugin.xml</code>) + * file as a non-empty string containing no period characters * (<code>'.'</code>) and must be unique within the namespace. * * @return the simple identifier of the extension (e.g. <code>"main"</code>) @@ -176,7 +176,7 @@ public interface IExtension { * Returns the unique identifier of this extension, or <code>null</code> * if this extension does not have an identifier. * If available, this identifier is unique within the plug-in registry, and - * is composed of the namespace where this extension + * is composed of the namespace where this extension * was declared and this extension's simple identifier. * * @return the unique identifier of the extension @@ -185,7 +185,7 @@ public interface IExtension { */ public String getUniqueIdentifier() throws InvalidRegistryObjectException; - /* (non-javadoc) + /* (non-javadoc) * @see Object#equals(java.lang.Object) */ @Override @@ -193,7 +193,7 @@ public interface IExtension { /** * Returns whether this extension object is valid. - * + * * @return <code>true</code> if the object is valid, and <code>false</code> * if it is no longer valid * @since 3.1 diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionDelta.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionDelta.java index 2347a61ac..a43dc5e94 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionDelta.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionDelta.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -22,13 +22,13 @@ package org.eclipse.core.runtime; */ public interface IExtensionDelta { /** - * Delta kind constant indicating that an extension has been added to an + * Delta kind constant indicating that an extension has been added to an * extension point. * @see IExtensionDelta#getKind() */ public int ADDED = 1; /** - * Delta kind constant indicating that an extension has been removed from an + * Delta kind constant indicating that an extension has been removed from an * extension point. * @see IExtensionDelta#getKind() */ @@ -36,7 +36,7 @@ public interface IExtensionDelta { /** * The kind of this extension delta. - * + * * @return the kind of change this delta represents * @see #ADDED * @see #REMOVED @@ -45,14 +45,14 @@ public interface IExtensionDelta { /** * Returns the affected extension. - * + * * @return the affected extension */ public IExtension getExtension(); /** * Returns the affected extension point. - * + * * @return the affected extension point */ public IExtensionPoint getExtensionPoint(); diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionPoint.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionPoint.java index 4eb6cb64b..59f14c185 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionPoint.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionPoint.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -12,12 +12,12 @@ package org.eclipse.core.runtime; /** * An extension point declared in a plug-in. - * Except for the list of extensions plugged in to it, the information - * available for an extension point is obtained from the declaring plug-in's + * Except for the list of extensions plugged in to it, the information + * available for an extension point is obtained from the declaring plug-in's * manifest (<code>plugin.xml</code>) file. * <p> - * These registry objects are intended for relatively short-term use. Clients that - * deal with these objects must be aware that they may become invalid if the + * These registry objects are intended for relatively short-term use. Clients that + * deal with these objects must be aware that they may become invalid if the * declaring plug-in is updated or uninstalled. If this happens, all methods except * {@link #isValid()} will throw {@link InvalidRegistryObjectException}. * For extension point objects, the most common case is code in a plug-in dealing @@ -32,7 +32,7 @@ package org.eclipse.core.runtime; * Client code can pre-test for invalid objects by calling {@link #isValid()}, * which never throws this exception. However, pre-tests are usually not sufficient * because of the possibility of the extension point object becoming invalid as a - * result of a concurrent activity. At-risk clients must treat + * result of a concurrent activity. At-risk clients must treat * <code>InvalidRegistryObjectException</code> as if it were a checked exception. * Also, such clients should probably register a listener with the extension registry * so that they receive notification of any changes to the registry. @@ -46,11 +46,11 @@ package org.eclipse.core.runtime; public interface IExtensionPoint { /** * Returns all configuration elements from all extensions configured - * into this extension point. Returns an empty array if this extension - * point has no extensions configured, or none of the extensions + * into this extension point. Returns an empty array if this extension + * point has no extensions configured, or none of the extensions * contain configuration elements. * - * @return the configuration elements for all extension configured + * @return the configuration elements for all extension configured * into this extension point * @throws InvalidRegistryObjectException if this extension point is no longer valid */ @@ -59,40 +59,40 @@ public interface IExtensionPoint { /** * Returns the namespace for this extension point. This value can be used * in various global facilities to discover this extension point's provider. - * + * * @return the namespace for this extension point * @throws InvalidRegistryObjectException if this extension point is no longer valid * @see IExtensionRegistry * @since 3.0 - * @deprecated As namespace is no longer restricted to the contributor name, + * @deprecated As namespace is no longer restricted to the contributor name, * use {@link #getNamespaceIdentifier()} to obtain namespace name or {@link #getContributor()} - * to get the name of the contributor of this registry element. + * to get the name of the contributor of this registry element. * <p> - * In the past namespace was dictated by the name of the bundle. If bundle <code>org.abc</code> - * contributed registry element with Id of <code>MyId</code>, the namespace of - * the element was always set to <code>org.abc</code>, producing the qualified name of + * In the past namespace was dictated by the name of the bundle. If bundle <code>org.abc</code> + * contributed registry element with Id of <code>MyId</code>, the namespace of + * the element was always set to <code>org.abc</code>, producing the qualified name of * <code>org.abc.MyId</code>. * </p><p> - * The namespace used to be the same as the bundle name. As a result, the {@link #getNamespace()} - * method was used both to obtain the name of the bundle and to obtain the namespace of a registry + * The namespace used to be the same as the bundle name. As a result, the {@link #getNamespace()} + * method was used both to obtain the name of the bundle and to obtain the namespace of a registry * element. * </p><p> - * Since 3.2, the extension registry allows elements to specify qualified name. The extension point - * of the plug-in <code>org.abc</code> could specify <code>org.zzz.MyExtPoint</code> as - * an Id. In this case, namespace name is <code>org.zzz</code>, but the contributor - * name is <code>org.abc</code>. + * Since 3.2, the extension registry allows elements to specify qualified name. The extension point + * of the plug-in <code>org.abc</code> could specify <code>org.zzz.MyExtPoint</code> as + * an Id. In this case, namespace name is <code>org.zzz</code>, but the contributor + * name is <code>org.abc</code>. * </p><p> - * (The use of a simple Id is still a preferred way. Whenever possible, specify only the simple + * (The use of a simple Id is still a preferred way. Whenever possible, specify only the simple * Id and let runtime take care of the rest.) * </p><p> - * If your code used the {@link #getNamespace()} to obtain the name of the contributing bundle, - * use {@link #getContributor()}. The typical usage pattern here is to find a bundle name to obtain - * some information from the corresponding OSGi bundle. For example, deducing the file location + * If your code used the {@link #getNamespace()} to obtain the name of the contributing bundle, + * use {@link #getContributor()}. The typical usage pattern here is to find a bundle name to obtain + * some information from the corresponding OSGi bundle. For example, deducing the file location * specified as a relative path to the bundle install location would fall into this group. * </p><p> - * If your code used the {@link #getNamespace()} to obtain the namespace of the registry element, - * use {@link #getNamespaceIdentifier()}. Typically, this is the case when code is trying to process - * registry elements belonging to some logical group. For example, processing notifications for all + * If your code used the {@link #getNamespace()} to obtain the namespace of the registry element, + * use {@link #getNamespaceIdentifier()}. Typically, this is the case when code is trying to process + * registry elements belonging to some logical group. For example, processing notifications for all * elements belonging to the <code>org.abc</code> namespace would fall into this category. * </p> */ @@ -100,19 +100,19 @@ public interface IExtensionPoint { /** * Returns the namespace name for this extension point. - * + * * @return the namespace name for this extension point * @throws InvalidRegistryObjectException if this extension point is no longer valid - * @since org.eclipse.equinox.registry 3.2 + * @since org.eclipse.equinox.registry 3.2 */ public String getNamespaceIdentifier() throws InvalidRegistryObjectException; /** * Returns the contributor of this extension point. - * + * * @return the contributor for this extension point * @throws InvalidRegistryObjectException if this extension point is no longer valid - * @since org.eclipse.equinox.registry 3.2 + * @since org.eclipse.equinox.registry 3.2 */ public IContributor getContributor() throws InvalidRegistryObjectException; @@ -122,7 +122,7 @@ public interface IExtensionPoint { * Since an extension might not have an identifier, some extensions * can only be found via the <code>getExtensions</code> method. * - * @param extensionId the unique identifier of an extension + * @param extensionId the unique identifier of an extension * (e.g. <code>"com.example.acme.main"</code>). * @return an extension, or <code>null</code> * @throws InvalidRegistryObjectException if this extension point is no longer valid @@ -153,16 +153,16 @@ public interface IExtensionPoint { public String getLabel() throws InvalidRegistryObjectException; /** - * When multi-language support is enabled, this method returns a displayable label + * When multi-language support is enabled, this method returns a displayable label * for this extension point in the specified locale. * Returns the empty string if no label for this extension point * is specified in the plug-in manifest file. - * <p> - * The locale matching tries to find the best match between available translations and - * the requested locale, falling back to a more generic locale ("en") when the specific - * locale ("en_US") is not available. + * <p> + * The locale matching tries to find the best match between available translations and + * the requested locale, falling back to a more generic locale ("en") when the specific + * locale ("en_US") is not available. * </p><p> - * If multi-language support is not enabled, this method is equivalent to the method + * If multi-language support is not enabled, this method is equivalent to the method * {@link #getLabel()}. * </p> * @param locale the requested locale @@ -175,9 +175,9 @@ public interface IExtensionPoint { public String getLabel(String locale) throws InvalidRegistryObjectException; /** - * Returns reference to the extension point schema. The schema - * reference is returned as a URL path relative to the plug-in - * installation URL. + * Returns reference to the extension point schema. The schema + * reference is returned as a URL path relative to the plug-in + * installation URL. * Returns the empty string if no schema for this extension point * is specified in the plug-in manifest file. * @@ -200,9 +200,9 @@ public interface IExtensionPoint { /** * Returns the unique identifier of this extension point. * This identifier is unique within the plug-in registry, and - * is composed of the namespace for this extension point + * is composed of the namespace for this extension point * and this extension point's simple identifier. - * + * * * @return the unique identifier of the extension point * (e.g. <code>"org.eclipse.core.resources.builders"</code>) @@ -210,7 +210,7 @@ public interface IExtensionPoint { */ public String getUniqueIdentifier() throws InvalidRegistryObjectException; - /* (non-javadoc) + /* (non-javadoc) * @see Object#equals(java.lang.Object) */ @Override @@ -218,7 +218,7 @@ public interface IExtensionPoint { /** * Returns whether this extension point object is valid. - * + * * @return <code>true</code> if the object is valid, and <code>false</code> * if it is no longer valid * @since 3.1 diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionRegistry.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionRegistry.java index 2036bb19b..f505504a7 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionRegistry.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionRegistry.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -15,10 +15,10 @@ import java.util.ResourceBundle; /** * The extension registry holds the master list of all - * discovered namespaces, extension points and extensions. + * discovered namespaces, extension points and extensions. * <p> - * The extension registry can be queried, by name, for - * extension points and extensions. + * The extension registry can be queried, by name, for + * extension points and extensions. * </p> * <p> * The various objects that describe the contents of the extension registry @@ -42,9 +42,9 @@ import java.util.ResourceBundle; * the registry. * </p> * <p> - * Extensions and extension points are declared by generic entities called - * <cite>namespaces</cite>. The only fact known about namespaces is that they - * have unique string-based identifiers. One example of a namespace + * Extensions and extension points are declared by generic entities called + * <cite>namespaces</cite>. The only fact known about namespaces is that they + * have unique string-based identifiers. One example of a namespace * is a plug-in, for which the namespace id is the plug-in id. * </p><p> * This interface can be used without OSGi running. @@ -57,24 +57,24 @@ import java.util.ResourceBundle; public interface IExtensionRegistry { /** * <b>Note:</b> for new implementations consider using {@link #addListener(IRegistryEventListener, String)}. - * <p> - * Adds the given listener for registry change events related to extension points + * <p> + * 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. + * 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. * </p><p> * 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. + * The listener continues to receive notifications until it is removed. * </p> * @param listener the listener * @param namespace the namespace in which to listen for changes * @see IRegistryChangeListener * @see IRegistryChangeEvent - * @see #removeRegistryChangeListener(IRegistryChangeListener) + * @see #removeRegistryChangeListener(IRegistryChangeListener) */ public void addRegistryChangeListener(IRegistryChangeListener listener, String namespace); @@ -83,14 +83,14 @@ public interface IExtensionRegistry { * <p> * Adds the given listener for registry change events. * Has no effect if an identical listener is already registered. - * + * * </p><p> * This method is equivalent to: * <pre> * addRegistryChangeListener(listener,null); * </pre> * </p> - * + * * @param listener the listener * @see IRegistryChangeListener * @see IRegistryChangeEvent @@ -101,8 +101,8 @@ public 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 + * 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. * * @param extensionPointId the unique identifier of the extension point @@ -113,13 +113,13 @@ public 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 + * 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. * - * @param namespace the namespace for the extension point + * @param namespace the namespace for the extension point * (e.g. <code>"org.eclipse.core.resources"</code>) - * @param extensionPointName the simple identifier of the + * @param extensionPointName the simple identifier of the * extension point (e.g. <code>"builders"</code>) * @return the configuration elements */ @@ -127,54 +127,54 @@ public interface IExtensionRegistry { /** * Returns all configuration elements from the identified extension. - * Returns an empty array if the extension does not exist or + * Returns an empty array if the extension does not exist or * contains no configuration elements. * - * @param namespace the namespace for the extension point + * @param namespace the namespace for the extension point * (e.g. <code>"org.eclipse.core.resources"</code>) - * @param extensionPointName the simple identifier of the + * @param extensionPointName the simple identifier of the * extension point (e.g. <code>"builders"</code>) - * @param extensionId the unique identifier of the extension + * @param extensionId the unique identifier of the extension * (e.g. <code>"com.example.acme.coolbuilder"</code>) * @return the configuration elements */ public IConfigurationElement[] getConfigurationElementsFor(String namespace, String extensionPointName, String extensionId); /** - * Returns the specified extension in this extension registry, + * Returns the specified extension in this extension registry, * or <code>null</code> if there is no such extension. * - * @param extensionId the unique identifier of the extension + * @param extensionId the unique identifier of the extension * (e.g. <code>"com.example.acme.coolbuilder"</code>) * @return the extension, or <code>null</code> */ public IExtension getExtension(String extensionId); /** - * Returns the specified extension in this extension registry, + * Returns the specified extension in this extension registry, * or <code>null</code> 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. * * @param extensionPointId the unique identifier of the extension point * (e.g. <code>"org.eclipse.core.resources.builders"</code>) - * @param extensionId the unique identifier of the extension + * @param extensionId the unique identifier of the extension * (e.g. <code>"com.example.acme.coolbuilder"</code>) * @return the extension, or <code>null</code> */ public IExtension getExtension(String extensionPointId, String extensionId); /** - * Returns the specified extension in this extension registry, + * Returns the specified extension in this extension registry, * or <code>null</code> 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. * - * @param namespace the namespace for the extension point + * @param namespace the namespace for the extension point * (e.g. <code>"org.eclipse.core.resources"</code>) - * @param extensionPointName the simple identifier of the + * @param extensionPointName the simple identifier of the * extension point (e.g. <code>"builders"</code>) - * @param extensionId the unique identifier of the extension + * @param extensionId the unique identifier of the extension * (e.g. <code>"com.example.acme.coolbuilder"</code>) * @return the extension, or <code>null</code> */ @@ -185,7 +185,7 @@ public interface IExtensionRegistry { * in this extension registry, or <code>null</code> if there is no such * extension point. * - * @param extensionPointId the unique identifier of the extension point + * @param extensionPointId the unique identifier of the extension point * (e.g., <code>"org.eclipse.core.resources.builders"</code>) * @return the extension point, or <code>null</code> */ @@ -196,9 +196,9 @@ public interface IExtensionRegistry { * with the given namespace and extension point simple identifier, * or <code>null</code> if there is no such extension point. * - * @param namespace the namespace for the given extension point + * @param namespace the namespace for the given extension point * (e.g. <code>"org.eclipse.core.resources"</code>) - * @param extensionPointName the simple identifier of the + * @param extensionPointName the simple identifier of the * extension point (e.g. <code>"builders"</code>) * @return the extension point, or <code>null</code> */ @@ -213,20 +213,20 @@ public interface IExtensionRegistry { public IExtensionPoint[] getExtensionPoints(); /** - * Returns all extension points declared in the given namespace. Returns an empty array if + * Returns all extension points declared in the given namespace. Returns an empty array if * there are no extension points declared in the namespace. - * - * @param namespace the namespace for the extension points - * (e.g. <code>"org.eclipse.core.resources"</code>) - * @return the extension points in this registry declared in the given namespace + * + * @param namespace the namespace for the extension points + * (e.g. <code>"org.eclipse.core.resources"</code>) + * @return the extension points in this registry declared in the given namespace */ public IExtensionPoint[] getExtensionPoints(String namespace); /** - * Returns all extension points supplied by the contributor, or <code>null</code> + * Returns all extension points supplied by the contributor, or <code>null</code> * if there are no such extension points. - * - * @param contributor the contributor for the extensions (for OSGi registry, bundles and + * + * @param contributor the contributor for the extensions (for OSGi registry, bundles and * fragments are different contributors) * @return the extension points, or <code>null</code> * @since 3.4 @@ -234,19 +234,19 @@ public interface IExtensionRegistry { public IExtensionPoint[] getExtensionPoints(IContributor contributor); /** - * Returns all extensions declared in the given namespace. Returns an empty array if + * Returns all extensions declared in the given namespace. Returns an empty array if * no extensions are declared in the namespace. - * - * @param namespace the namespace for the extensions + * + * @param namespace the namespace for the extensions * (e.g. <code>"org.eclipse.core.resources"</code>) - * @return the extensions in this registry declared in the given namespace + * @return the extensions in this registry declared in the given namespace */ public IExtension[] getExtensions(String namespace); /** - * Returns all extensions supplied by the contributor, or <code>null</code> if there + * Returns all extensions supplied by the contributor, or <code>null</code> if there * are no such extensions. - * @param contributor the contributor for the extensions (for OSGi registry, bundles and + * @param contributor the contributor for the extensions (for OSGi registry, bundles and * fragments are different contributors) * @return the extensions, or <code>null</code> * @since 3.4 @@ -254,20 +254,20 @@ public interface IExtensionRegistry { public IExtension[] getExtensions(IContributor contributor); /** - * Returns all namespaces currently used by extensions and extension points in this + * 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. * <p> - * The fully-qualified name of an extension point or an extension consist of + * 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. - * </p> + * </p> * @return all namespaces known to this registry */ public String[] getNamespaces(); - /** + /** * Removes the given registry change listener from this registry. * Has no effect if an identical listener is not registered. * @@ -279,20 +279,20 @@ public interface IExtensionRegistry { public void removeRegistryChangeListener(IRegistryChangeListener listener); /** - * Adds to this extension registry an extension point(s), extension(s), or - * a combination of those described by the XML file. The information in + * 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. + * of the contribution (normally, "plugin" or "fragment" in the Plug-in Manifest + * editor) is ignored by this method. * <p> - * 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 - * {@link RegistryFactory#createRegistry(org.eclipse.core.runtime.spi.RegistryStrategy, Object, Object)}: - * master token and a user token. Master token allows all operations; user token allows + * 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 + * {@link 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. * </p> - * @param is stream open on the XML file. The XML file can contain an extension + * @param 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 * @param contributor the contributor making this contribution. @@ -304,18 +304,18 @@ public interface IExtensionRegistry { * @return <code>true</code> if the contribution was successfully processed and <code>false</code> * otherwise * @throws IllegalArgumentException if an incorrect token is passed - * + * * @see IContributor - * @since org.eclipse.equinox.registry 3.2 + * @since org.eclipse.equinox.registry 3.2 */ public boolean addContribution(InputStream is, IContributor contributor, boolean persist, String name, ResourceBundle translationBundle, Object token) throws IllegalArgumentException; /** * Removes the given extension from this registry. * <p> - * 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 - * {@link RegistryFactory#createRegistry(org.eclipse.core.runtime.spi.RegistryStrategy, Object, Object)}: + * 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 + * {@link 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. * </p> @@ -323,33 +323,33 @@ public interface IExtensionRegistry { * @param token the key used to check permissions * @return <code>true</code> if the extension was successfully removed, and <code>false</code> otherwise * @throws IllegalArgumentException if an incorrect token is passed - * - * @since org.eclipse.equinox.registry 3.2 + * + * @since org.eclipse.equinox.registry 3.2 */ public boolean removeExtension(IExtension extension, Object token) throws IllegalArgumentException; /** * Removes the specified extension point from this registry. * <p> - * 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 - * {@link RegistryFactory#createRegistry(org.eclipse.core.runtime.spi.RegistryStrategy, Object, Object)}: + * 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 + * {@link 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. * </p> * @param extensionPoint extension point to be removed * @param token the key used to check permissions - * @return <code>true</code> if the extension point was successfully removed, and + * @return <code>true</code> if the extension point was successfully removed, and * <code>false</code> otherwise * @throws IllegalArgumentException if incorrect token is passed - * - * @since org.eclipse.equinox.registry 3.2 + * + * @since org.eclipse.equinox.registry 3.2 */ public boolean removeExtensionPoint(IExtensionPoint extensionPoint, Object token) throws IllegalArgumentException; /** * Call this method to properly stop the registry. The method stops registry event processing - * and writes out cache information to be used in the next run. This is an access controlled + * and writes out cache information to be used in the next run. This is an access controlled * method; master token is required. * <p> * This method is an access controlled method. Master token should be passed as an argument. @@ -357,7 +357,7 @@ public interface IExtensionRegistry { * @see RegistryFactory#createRegistry(org.eclipse.core.runtime.spi.RegistryStrategy, Object, Object) * @param token master token for the registry * @throws IllegalArgumentException if incorrect token is passed - * + * * @since org.eclipse.equinox.registry 3.2 */ public void stop(Object token) throws IllegalArgumentException; @@ -366,48 +366,48 @@ public interface IExtensionRegistry { * Adds the given listener for registry change events. Listener will be notified * on changes to all extension points and underlying extensions. * <p> - * Depending on activity, listeners of this type might receive a large number + * 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. * </p><p> * 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. + * The listener continues to receive notifications until it is removed. * </p><p> - * This method has no effect if the listener is already registered. + * This method has no effect if the listener is already registered. * </p> * @param listener the listener - * @since org.eclipse.equinox.registry 3.4 + * @since org.eclipse.equinox.registry 3.4 */ public void addListener(IRegistryEventListener listener); /** - * Adds the given listener for registry change events related to specified + * Adds the given listener for registry change events related to specified * extension point. * <p> * 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. + * The listener continues to receive notifications until it is removed. * </p><p> - * This method has no effect if the listener is already registered. + * This method has no effect if the listener is already registered. * </p> * @param listener the listener * @param extensionPointId the unique identifier of extension point * @see IExtensionPoint#getUniqueIdentifier() - * @since org.eclipse.equinox.registry 3.4 + * @since org.eclipse.equinox.registry 3.4 */ public void addListener(IRegistryEventListener listener, String extensionPointId); /** * Removes the given registry change listener from this registry. * <p> - * This method has no effect if the listener is not registered. + * This method has no effect if the listener is not registered. * </p> * @param listener the listener * @see #addListener(IRegistryEventListener) * @see #addListener(IRegistryEventListener, String) - * @since org.eclipse.equinox.registry 3.4 + * @since org.eclipse.equinox.registry 3.4 */ public void removeListener(IRegistryEventListener listener); @@ -417,7 +417,7 @@ public interface IExtensionRegistry { * See the runtime option "-registryMultiLanguage" for enabling multi-language * support. * </p> - * @return <code>true</code> if multiple languages are supported by this + * @return <code>true</code> if multiple languages are supported by this * instance of the extension registry; <code>false</code> otherwise. * @since org.eclipse.equinox.registry 3.5 */ diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IRegistryChangeEvent.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IRegistryChangeEvent.java index 410c6e08d..48809cc3a 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IRegistryChangeEvent.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IRegistryChangeEvent.java @@ -4,14 +4,14 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.core.runtime; /** - * Registry change events describe changes to the extension registry. + * Registry change events describe changes to the extension registry. * <p> * This interface can be used without OSGi running. * </p><p> @@ -23,40 +23,40 @@ package org.eclipse.core.runtime; * @noimplement This interface is not intended to be implemented by clients. */ public interface IRegistryChangeEvent { - /** - * Returns all extension deltas for all hosts. Returns an empty array if there are + /** + * Returns all extension deltas for all hosts. Returns an empty array if there are * no deltas in this event. - * - * @return all extension deltas + * + * @return all extension deltas */ public IExtensionDelta[] getExtensionDeltas(); - /** + /** * Returns all extension deltas for the given namespace. Returns an empty array if there are - * no deltas in this event for any extension points provided in the given namespace. - * - * @param namespace the namespace for the extension deltas - * @return all extension deltas for the given namespace + * no deltas in this event for any extension points provided in the given namespace. + * + * @param namespace the namespace for the extension deltas + * @return all extension deltas for the given namespace */ public IExtensionDelta[] getExtensionDeltas(String namespace); - /** - * Returns all the extension deltas for the given namespace and extension point. Returns an + /** + * Returns all the extension deltas for the given namespace and extension point. Returns an * empty array if there are no deltas in this event for the given extension point. - * + * * @param namespace the namespace for the extension point - * @param extensionPoint the simple identifier of the + * @param extensionPoint the simple identifier of the * extension point (e.g. <code>"builders"</code>) * @return all extension deltas for the given extension point */ public IExtensionDelta[] getExtensionDeltas(String namespace, String extensionPoint); - /** - * Returns the delta for the given namespace, extension point and extension. + /** + * Returns the delta for the given namespace, extension point and extension. * Returns <code>null</code> if none exists in this event. - * + * * @param namespace the namespace for the extension point - * @param extensionPoint the simple identifier of the + * @param extensionPoint the simple identifier of the * extension point (e.g. <code>"builders"</code>) * @param extension the unique identifier of the extension * @return the extension delta, or <code>null</code> diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IRegistryChangeListener.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IRegistryChangeListener.java index ce1f55d26..d68d0f145 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IRegistryChangeListener.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IRegistryChangeListener.java @@ -15,31 +15,31 @@ import java.util.EventListener; /** * <b>Note:</b> for new implementations consider using {@link IRegistryEventListener}. * <p> - * A registry change listener is notified of changes to extensions points in the - * registry. These changes arise from subsequent manipulation of the registry after + * A registry change listener is notified of changes to extensions points in the + * registry. These changes arise from subsequent manipulation of the registry after * it was initially created. * </p><p> * This interface can be used without OSGi running. * </p><p> * Clients may implement this interface. * </p> - * + * * @since 3.0 * @see IExtensionRegistry * @see IRegistryChangeEvent */ public interface IRegistryChangeListener extends EventListener { /** - * Notifies this listener that some registry changes are happening, or have + * Notifies this listener that some registry changes are happening, or have * already happened. * <p> - * The supplied event gives details. This event object (and the deltas in it) is valid + * The supplied event gives details. This event object (and the deltas in it) is valid * only for the duration of the invocation of this method. * </p> <p> * Note: This method is called by the platform; it is not intended * to be called directly by clients. * </p> - * + * * @param event the registry change event * @see IRegistryChangeEvent */ diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IRegistryEventListener.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IRegistryEventListener.java index 4c9edb10e..6cd9a021f 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IRegistryEventListener.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IRegistryEventListener.java @@ -30,7 +30,7 @@ public interface IRegistryEventListener extends EventListener { /** * Notifies this listener that extensions were added to the registry. * <p> - * The extensions supplied as the argument are valid only for the duration of the + * The extensions supplied as the argument are valid only for the duration of the * invocation of this method. * </p> * @param extensions extensions added to the registry @@ -40,7 +40,7 @@ public interface IRegistryEventListener extends EventListener { /** * Notifies this listener that extensions were removed from the registry. * <p> - * The extensions supplied as the argument are valid only for the duration of the + * The extensions supplied as the argument are valid only for the duration of the * invocation of this method. * </p> * @param extensions extensions removed from the registry @@ -50,7 +50,7 @@ public interface IRegistryEventListener extends EventListener { /** * Notifies this listener that extension points were added to the registry. * <p> - * The extension points supplied as the argument are valid only for the duration of the + * The extension points supplied as the argument are valid only for the duration of the * invocation of this method. * </p> * @param extensionPoints extension points added to the registry @@ -60,7 +60,7 @@ public interface IRegistryEventListener extends EventListener { /** * Notifies this listener that extension points were removed from the registry. * <p> - * The extension points supplied as the argument are valid only for the duration of the + * The extension points supplied as the argument are valid only for the duration of the * invocation of this method. * </p> * @param extensionPoints extension points removed from the registry diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/InvalidRegistryObjectException.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/InvalidRegistryObjectException.java index 4304b2e7c..c4fbb246a 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/InvalidRegistryObjectException.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/InvalidRegistryObjectException.java @@ -4,13 +4,13 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.core.runtime; -/** +/** * An unchecked exception indicating that an attempt to access * an extension registry object that is no longer valid. * <p> diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/RegistryFactory.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/RegistryFactory.java index aba884f75..a0d0bf1cc 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/RegistryFactory.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/RegistryFactory.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -36,17 +36,17 @@ public final class RegistryFactory { /** * Creates a new extension registry based on the given set of parameters. * <p> - * The strategy is an optional collection of methods that supply additional registry - * functionality. Users may pass in <code>null</code> for the strategy if default + * The strategy is an optional collection of methods that supply additional registry + * functionality. Users may pass in <code>null</code> for the strategy if default * behavior is sufficient. * </p><p> - * The master token is stored by the registry and later used as an identifier of callers - * who are allowed full control over the registry functionality. Users may pass in + * The master token is stored by the registry and later used as an identifier of callers + * who are allowed full control over the registry functionality. Users may pass in * <code>null</code> as a master token. * </p><p> * The user token is stored by the registry and later used as an identifier of callers - * who are allowed to control registry at the user level. For instance, users attempting to - * modify dynamic contributions to the registry have to use the user token. Users may pass + * who are allowed to control registry at the user level. For instance, users attempting to + * modify dynamic contributions to the registry have to use the user token. Users may pass * in <code>null</code> as a user token. * </p> * @param strategy registry strategy or <code>null</code> @@ -60,9 +60,9 @@ public final class RegistryFactory { /** * Returns the default extension registry specified by the registry provider. - * May return <code>null</code> if the provider has not been set or if the + * May return <code>null</code> if the provider has not been set or if the * registry has not been created. - * + * * @return existing extension registry or <code>null</code> */ public static IExtensionRegistry getRegistry() { @@ -73,23 +73,23 @@ public final class RegistryFactory { } /** - * Creates a registry strategy that can be used in an OSGi container. The strategy uses - * OSGi contributions and contributors for the registry processing and takes advantage of + * Creates a registry strategy that can be used in an OSGi container. The strategy uses + * OSGi contributions and contributors for the registry processing and takes advantage of * additional mechanisms available through the OSGi library. * <p> - * The OSGi registry strategy sequentially checks the array of storage directories to + * The OSGi registry 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 + * registry. Once found, the location is used to store registry cache. If this value * is <code>null</code> then caching of the registry content is disabled. * </p><p> - * 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 <code>true</code> then the location at the corresponding index - * in the storage directories array is read-only; if <code>false</code> then the cache location - * is read-write. The array can be <code>null</code> if the <code>storageDirs</code> parameter + * 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 <code>true</code> then the location at the corresponding index + * in the storage directories array is read-only; if <code>false</code> then the cache location + * is read-write. The array can be <code>null</code> if the <code>storageDirs</code> parameter * is <code>null</code>. * </p><p> - * The master token should be passed to the OSGi registry strategy to permit it to perform + * The master token should be passed to the OSGi registry strategy to permit it to perform * contributions to the registry. * </p> * @param storageDirs array of file system directories or <code>null</code> diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/ExtensionTracker.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/ExtensionTracker.java index 4f29b1901..8db0dc07e 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/ExtensionTracker.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/ExtensionTracker.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation * Sebastian Davids - fix for the bug 178028 (removals not propagated to handlers) @@ -23,7 +23,7 @@ import org.eclipse.core.runtime.*; * <p> * This class can be used without OSGi running. * </p> - * @see org.eclipse.core.runtime.dynamichelpers.IExtensionTracker + * @see org.eclipse.core.runtime.dynamichelpers.IExtensionTracker * @since 3.1 */ public class ExtensionTracker implements IExtensionTracker, IRegistryChangeListener { @@ -46,8 +46,8 @@ public class ExtensionTracker implements IExtensionTracker, IRegistryChangeListe /** * Construct a new instance of the extension tracker using the given registry * containing tracked extensions and extension points. - * - * @param theRegistry the extension registry to track + * + * @param theRegistry the extension registry to track * @since org.eclipse.equinox.registry 3.2 */ public ExtensionTracker(IExtensionRegistry theRegistry) { @@ -129,10 +129,10 @@ public class ExtensionTracker implements IExtensionTracker, IRegistryChangeListe /** * Notify all handlers whose filter matches that the given delta occurred. - * If the list of objects is not <code>null</code> then this is a removal and + * If the list of objects is not <code>null</code> then this is a removal and * the handlers will be given a chance to process the list. If it is <code>null</code> * then the notification is an addition. - * + * * @param delta the change to broadcast * @param objects the objects to pass to the handlers on removals */ @@ -251,8 +251,8 @@ public class ExtensionTracker implements IExtensionTracker, IRegistryChangeListe /** * Return an instance of filter matching all changes for the given extension point. - * - * @param xpt the extension point + * + * @param xpt the extension point * @return a filter */ public static IFilter createExtensionPointFilter(final IExtensionPoint xpt) { @@ -266,7 +266,7 @@ public class ExtensionTracker implements IExtensionTracker, IRegistryChangeListe /** * Return an instance of filter matching all changes for the given extension points. - * + * * @param xpts the extension points used to filter * @return a filter */ @@ -284,8 +284,8 @@ public class ExtensionTracker implements IExtensionTracker, IRegistryChangeListe /** * Return an instance of filter matching all changes from a given plugin. - * - * @param id the plugin id + * + * @param id the plugin id * @return a filter */ public static IFilter createNamespaceFilter(final String id) { diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/IExtensionChangeHandler.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/IExtensionChangeHandler.java index ded0f494f..13fc87ffd 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/IExtensionChangeHandler.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/IExtensionChangeHandler.java @@ -13,7 +13,7 @@ package org.eclipse.core.runtime.dynamichelpers; import org.eclipse.core.runtime.IExtension; /** - * Extension change handlers are notified of changes for a given extension + * Extension change handlers are notified of changes for a given extension * point in the context of an extension tracker. * <p> * This interface can be used without OSGi running. @@ -26,19 +26,19 @@ public interface IExtensionChangeHandler { /** * This method is called whenever an extension conforming to the extension point filter - * is being added to the registry. This method does not automatically register objects + * is being added to the registry. This method does not automatically register objects * to the tracker. - * + * * @param tracker a tracker to which the handler has been registered * @param extension the extension being added */ public void addExtension(IExtensionTracker tracker, IExtension extension); - /** + /** * This method is called after the removal of an extension. - * + * * @param extension the extension being removed - * @param objects the objects that were associated with the removed extension + * @param objects the objects that were associated with the removed extension */ public void removeExtension(IExtension extension, Object[] objects); } diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/IExtensionTracker.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/IExtensionTracker.java index 663a1af04..40ad64255 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/IExtensionTracker.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/IExtensionTracker.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -29,28 +29,28 @@ public interface IExtensionTracker { /** * Constant for strong (normal) reference holding. - * + * * Value <code>1</code>. */ public static final int REF_STRONG = ReferenceHashSet.HARD; /** * Constant for soft reference holding. - * + * * Value <code>2</code>. */ public static final int REF_SOFT = ReferenceHashSet.SOFT; /** * Constant for weak reference holding. - * + * * Value <code>3</code>. */ public static final int REF_WEAK = ReferenceHashSet.WEAK; /** * Register an extension change handler with this tracker using the given filter. - * + * * @param handler the handler to be registered * @param filter the filter to use to choose interesting changes */ @@ -58,8 +58,8 @@ public interface IExtensionTracker { /** * Unregister the given extension change handler previously registered with this tracker. - * - * @param handler the handler to be unregistered + * + * @param handler the handler to be unregistered */ public void unregisterHandler(IExtensionChangeHandler handler); @@ -67,8 +67,8 @@ public interface IExtensionTracker { * Create an association between the given extension and the given object. * The referenceType indicates how strongly the object is being kept in memory. * There is 3 possible values: {@link #REF_STRONG}, {@link #REF_SOFT}, {@link #REF_WEAK}. - * - * @param extension the extension + * + * @param extension the extension * @param object the object to associate with the extension * @param referenceType one of REF_STRONG, REF_SOFT, REF_WEAK * @see #REF_STRONG @@ -79,7 +79,7 @@ public interface IExtensionTracker { /** * Remove an association between the given extension and the given object. - * + * * @param extension the extension under which the object has been registered * @param object the object to unregister */ @@ -88,7 +88,7 @@ public interface IExtensionTracker { /** * Remove all the objects associated with the given extension. Return * the removed objects. - * + * * @param extension the extension for which the objects are removed * @return the objects that were associated with the extension */ @@ -97,10 +97,10 @@ public interface IExtensionTracker { /** * Return all the objects that have been associated with the given extension. * All objects registered strongly will be return unless they have been unregistered. - * The objects registered softly or weakly may not be returned if they have been garbage collected. + * The objects registered softly or weakly may not be returned if they have been garbage collected. * Return an empty array if no associations exist. - * - * @param extension the extension for which the object must be returned + * + * @param extension the extension for which the object must be returned * @return the array of associated objects */ public Object[] getObjects(IExtension extension); diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/IFilter.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/IFilter.java index 200f4abfa..3d2bc9c82 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/IFilter.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/dynamichelpers/IFilter.java @@ -13,10 +13,10 @@ package org.eclipse.core.runtime.dynamichelpers; import org.eclipse.core.runtime.IExtensionPoint; /** - * A filter compares the given object to some pattern and returns + * A filter compares the given object to some pattern and returns * <code>true</code> if the two match and <code>false</code> otherwise. * <p> - * This interface may be implemented by clients, however factory methods are + * This interface may be implemented by clients, however factory methods are * available on IExtensionTracker. * </p><p> * This interface can be used without OSGi running. @@ -25,11 +25,11 @@ import org.eclipse.core.runtime.IExtensionPoint; */ public interface IFilter { /** - * Return <code>true</code> if the given object matches the criteria + * Return <code>true</code> if the given object matches the criteria * for this filter. - * + * * @param target the object to match - * @return <code>true</code> if the target matches this filter + * @return <code>true</code> if the target matches this filter * and <code>false</code> otherwise */ public boolean matches(IExtensionPoint target); diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/IDynamicExtensionRegistry.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/IDynamicExtensionRegistry.java index 396a2a1c1..4f0c60129 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/IDynamicExtensionRegistry.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/IDynamicExtensionRegistry.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -16,13 +16,13 @@ import org.eclipse.core.runtime.IContributor; * This interface provides an extra degree of access to an extension registry that * might be useful to registry implementers. * <p> - * At this time functionality available through this interface is not intended to + * At this time functionality available through this interface is not intended to * be used with the default Eclipse extension registry. * </p><p> - * <b>Note:</b> This class/interface is part of an interim SPI that is still under - * development and expected to change significantly before reaching stability. - * It is being made available at this early stage to solicit feedback from pioneering - * adopters on the understanding that any code that uses this SPI will almost certainly + * <b>Note:</b> This class/interface is part of an interim SPI that is still under + * development and expected to change significantly before reaching stability. + * It is being made available at this early stage to solicit feedback from pioneering + * adopters on the understanding that any code that uses this SPI will almost certainly * be broken (repeatedly) as the SPI evolves. * </p><p> * This interface is not intended to be extended by clients. @@ -40,7 +40,7 @@ public interface IDynamicExtensionRegistry { /** * Removes all extensions and extension points provided by the contributor. * <p> - * This method is an access controlled method. Access tokens are specified when the registry + * This method is an access controlled method. Access tokens are specified when the registry * is constructed by the registry implementers. * </p> * @see org.eclipse.core.runtime.RegistryFactory#createRegistry(RegistryStrategy, Object, Object) @@ -50,7 +50,7 @@ public interface IDynamicExtensionRegistry { public void removeContributor(IContributor contributor, Object key); /** - * Finds out if registry has the contributor. + * Finds out if registry has the contributor. * @param contributor registry contributor * @return true if the registry has this contributor; false otherwise */ diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/IRegistryProvider.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/IRegistryProvider.java index 6c12838c5..fe9dfc5dc 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/IRegistryProvider.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/IRegistryProvider.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -26,10 +26,10 @@ import org.eclipse.core.runtime.IExtensionRegistry; public interface IRegistryProvider { /** - * Returns the extension registry contributed by this provider; must not + * Returns the extension registry contributed by this provider; must not * be <code>null</code>. - * - * @return an extension registry + * + * @return an extension registry */ public IExtensionRegistry getRegistry(); } diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/RegistryContributor.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/RegistryContributor.java index 31f3426ca..b335e6bd9 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/RegistryContributor.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/RegistryContributor.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -14,15 +14,15 @@ import org.eclipse.core.runtime.IContributor; /** * This class describes a registry contributor which is an entity that supplies information - * to the extension registry. Depending on the registry strategy, contributor might delegate + * to the extension registry. Depending on the registry strategy, contributor might delegate * some of its functionality to a "host" contributor. For instance, OSGi registry strategy - * uses "host" contributor to delegate some functionality from fragments to plug-ins. + * uses "host" contributor to delegate some functionality from fragments to plug-ins. * <p> * This class can be instantiated by the registry Service Providers. * </p><p> * This class can be used without OSGi running. * </p><p> - * This class can not be extended. + * This class can not be extended. * </p> * @since org.eclipse.equinox.registry 3.2 * @noextend This class is not intended to be subclassed by clients. @@ -40,15 +40,15 @@ public final class RegistryContributor implements IContributor { private String actualContributorName; /** - * ID associated with the entity "in charge" of the contributor (e.g., "1"). IDs are expected - * to be unique in the workspace. If contributor does not rely on a host, this value should be + * ID associated with the entity "in charge" of the contributor (e.g., "1"). IDs are expected + * to be unique in the workspace. If contributor does not rely on a host, this value should be * the same as the actual contributor ID. */ private String hostId; /** * Name of the entity "in charge" of the contributor (e.g. "org.eclipse.core.runtime"). - * If contributor does not rely on a host, this value should be the same as the actual + * If contributor does not rely on a host, this value should be the same as the actual * contributor name. */ private String hostName; @@ -56,23 +56,23 @@ public final class RegistryContributor implements IContributor { /** * Constructor for the registry contributor. * <p> - * The actual ID is a string identifier for the contributor (e.g., "12") and is expected - * to be unique within the workspace. The actual ID of the contributor must not + * The actual ID is a string identifier for the contributor (e.g., "12") and is expected + * to be unique within the workspace. The actual ID of the contributor must not * be <code>null</code>. * </p><p> - * The actual name is the name associated with the contributor - * (e.g., "org.eclipse.core.runtime.fragment"). The actual name of the contributor must - * not be <code>null</code>. + * The actual name is the name associated with the contributor + * (e.g., "org.eclipse.core.runtime.fragment"). The actual name of the contributor must + * not be <code>null</code>. * </p><p> * The host ID is the identifier associated with the entity "in charge" of the contributor - * (e.g., "1"). IDs are expected to be unique in the workspace. If contributor does not + * (e.g., "1"). IDs are expected to be unique in the workspace. If contributor does not * rely on a host, then <code>null</code> should be used as the host ID. * </p><p> - * The host name is the name of the entity "in charge" of the contributor + * The host name is the name of the entity "in charge" of the contributor * (e.g., "org.eclipse.core.runtime"). If contributor does not rely on a host, then * <code>null</code> should be used as the host name. * </p><p> - * There should be 1-to-1 mapping between the contributor and the contibutor ID. + * There should be 1-to-1 mapping between the contributor and the contibutor ID. * The IDs (either actual or host) can not be re-used in the same registry. * For example, if ID of 12 was used to identify contributorA, the ID of 12 can not * be used to identify contributorB or a host for the contributorC. @@ -95,10 +95,10 @@ public final class RegistryContributor implements IContributor { } /** - * Provides actual ID associated with the registry contributor (e.g., "12"). IDs are expected + * Provides actual ID associated with the registry contributor (e.g., "12"). IDs are expected * to be unique in the workspace. - * - * @return actual ID of the registry contributor + * + * @return actual ID of the registry contributor */ public String getActualId() { return actualContributorId; @@ -106,19 +106,19 @@ public final class RegistryContributor implements IContributor { /** * Provides actual name of the registry contributor (e.g., "org.eclipe.core.runtime.fragment"). - * - * @return actual name of the registry contributor + * + * @return actual name of the registry contributor */ public String getActualName() { return actualContributorName; } /** - * Provides ID associated with the entity "in charge" of the contributor (e.g., "1"). IDs are expected - * to be unique in the workspace. If contributor does not rely on a host, this value should be + * Provides ID associated with the entity "in charge" of the contributor (e.g., "1"). IDs are expected + * to be unique in the workspace. If contributor does not rely on a host, this value should be * the same as the actual contributor ID. - * - * @return id of the registry contributor + * + * @return id of the registry contributor */ public String getId() { return hostId; @@ -127,8 +127,8 @@ public final class RegistryContributor implements IContributor { /** * Provides name of the entity "in charge" of the contributor (e.g., "org.eclipse.core.runtime"). * If contributor does not rely on a host, this value should be the same as the actual contributor name. - * - * @return name of the registry contributor + * + * @return name of the registry contributor */ @Override public String getName() { diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/RegistryStrategy.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/RegistryStrategy.java index 1c5bd0fa4..0f55de6f8 100644 --- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/RegistryStrategy.java +++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/RegistryStrategy.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -19,7 +19,7 @@ import org.eclipse.osgi.util.NLS; /** * This is the basic registry strategy. It describes how the registry does logging, - * message translation, extra start/stop processing, event scheduling, caching, + * message translation, extra start/stop processing, event scheduling, caching, * and debugging. * <p> * In this strategy: @@ -31,7 +31,7 @@ import org.eclipse.osgi.util.NLS; * </ul></p><p> * This class can be used without OSGi running. * </p><p> - * This class can be overridden and/or instantiated by clients. + * This class can be overridden and/or instantiated by clients. * </p> * @since org.eclipse.equinox.registry 3.2 */ @@ -50,18 +50,18 @@ public class RegistryStrategy { private final boolean[] cacheReadOnly; /** - * Constructor for this default registry strategy. + * Constructor for this default registry strategy. * <p> - * The strategy sequentially checks the array of storage directories to + * 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 + * registry. Once found, the location is used to store registry cache. If this value * is <code>null</code> then caching of the registry content is disabled. * </p><p> - * 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 <code>true</code> then the location at the corresponding index - * in the storage directories array is read-only; if <code>false</code> then the cache location - * is read-write. The array can be <code>null</code> if the <code>storageDirs</code> parameter + * 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 <code>true</code> then the location at the corresponding index + * in the storage directories array is read-only; if <code>false</code> then the cache location + * is read-write. The array can be <code>null</code> if the <code>storageDirs</code> parameter * is <code>null</code>. * </p> * @@ -100,7 +100,7 @@ public class RegistryStrategy { * Returns the read-only status of the registry cache location. * * @param index the index of the possible registry location - * @return <code>true</code> if the location is read only and + * @return <code>true</code> if the location is read only and * <code>false</code> if the location is read/write */ public final boolean isCacheReadOnly(int index) { @@ -111,9 +111,9 @@ public class RegistryStrategy { /** * Override this method to provide customized logging functionality - * to the registry. The method adds a log entry based on the supplied status. + * to the registry. The method adds a log entry based on the supplied status. * <p> - * This method writes a message to <code>System.out</code> + * This method writes a message to <code>System.out</code> * in the following format: * <pre> * [Error|Warning|Log]: Main error message @@ -121,7 +121,7 @@ public class RegistryStrategy { * ... * [Error|Warning|Log]: Child error message N * </pre></p> - * + * * @param status the status to log */ public void log(IStatus status) { @@ -129,11 +129,11 @@ public class RegistryStrategy { } /** - * Translates key using the supplied resource bundle. The resource bundle is + * Translates key using the supplied resource bundle. The resource bundle is * optional and might be <code>null</code>. * <p> - * The default translation routine assumes that keys are prefixed with '%'. If - * no resource bundle is present, the key itself (without leading '%') is returned. + * 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 '%%'. * </p> * @@ -146,31 +146,31 @@ public class RegistryStrategy { } /** - * Override this method to provide additional processing performed + * Override this method to provide additional processing performed * when the registry is created and started. Overrides should call * <code>super.onStart()</code> at the beginning of the processing. * <p> - * <strong>NOTE</strong>: Avoid placing duplicate functionality in - * this method and {@link #onStart(IExtensionRegistry, boolean)} as + * <strong>NOTE</strong>: Avoid placing duplicate functionality in + * this method and {@link #onStart(IExtensionRegistry, boolean)} as * both methods will be called on the registry startup. * </p> * @param registry the extension registry being started - * - * @deprecated use {@link #onStart(IExtensionRegistry, boolean)}. + * + * @deprecated use {@link #onStart(IExtensionRegistry, boolean)}. */ public void onStart(IExtensionRegistry registry) { // The default implementation } /** - * Override this method to provide additional processing performed + * Override this method to provide additional processing performed * when the registry is created and started. Overrides should call - * <code>super.onStart()</code> at the beginning of the processing. - * + * <code>super.onStart()</code> at the beginning of the processing. + * * @param registry the extension registry being started - * @param loadedFromCache true is registry contents was loaded from - * cache when the registry was created - * + * @param loadedFromCache true is registry contents was loaded from + * cache when the registry was created + * * @since 3.4 */ public void onStart(IExtensionRegistry registry, boolean loadedFromCache) { @@ -179,8 +179,8 @@ public class RegistryStrategy { /** * Override this method to provide additional processing to be performed - * just before the registry is stopped. Overrides should call - * <code>super.onStop()</code> at the end of the processing. + * just before the registry is stopped. Overrides should call + * <code>super.onStop()</code> at the end of the processing. * @param registry the extension registry being stopped */ public void onStop(IExtensionRegistry registry) { @@ -188,12 +188,12 @@ public class RegistryStrategy { } /** - * Creates an executable extension. Override this method to supply an alternative processing - * for the creation of executable extensions. + * Creates an executable extension. Override this method to supply an alternative processing + * for the creation of executable extensions. * <p> * 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 <code>null</code>. + * contributor name might be <code>null</code>. * </p><p> * In this implementation registry attempts to instantiate the class specified via * the class name (must not be <code>null</code>) using standard Java reflection mechanism. @@ -228,12 +228,12 @@ public class RegistryStrategy { } /** - * Override this method to customize scheduling of an extension registry event. Note that this method + * Override this method to customize scheduling of an extension registry event. Note that this method * <strong>must</strong> make the following call to actually process the event: * <p><pre><code> * RegistryStrategy.processChangeEvent(listeners, deltas, registry); * </code></pre></p><p> - * In the default implementation, the method registry events are executed in a queue + * In the default implementation, the method registry events are executed in a queue * on a separate thread (i.e. asynchronously, sequentially). * </p> * @@ -246,10 +246,10 @@ public class RegistryStrategy { } /** - * This method performs actual processing of the registry change event. It should + * This method performs actual processing of the registry change event. It should * only be used by overrides of the RegistryStrategy.scheduleChangeEvent. It will * return <code>null</code> if an unexpected registry type was encountered. - * + * * @param listeners the list of active listeners; may not be <code>null</code> * @param deltas the extension registry deltas; may not be <code>null</code> * @param registry the extension registry; may not be <code>null</code> @@ -262,8 +262,8 @@ public class RegistryStrategy { } /** - * Override this method to specify debug requirements to the registry. In the default - * implementation this method returns <code>false</code> indicating that debug functionality + * Override this method to specify debug requirements to the registry. In the default + * implementation this method returns <code>false</code> indicating that debug functionality * is turned off. * <p> * Note that in a general case the extension registry plug-in doesn't depend on OSGI and @@ -278,7 +278,7 @@ public class RegistryStrategy { } /** - * Override this method to specify debug requirements for the registry event processing. + * Override this method to specify debug requirements for the registry event processing. * In the default implementation this method returns <code>false</code> indicating that * debug of the registry events is turned off. * <p> @@ -294,7 +294,7 @@ public class RegistryStrategy { } /** - * Specifies if the extension registry should use cache to store registry data between + * Specifies if the extension registry should use cache to store registry data between * invocations. * <p> * The default implementation enables caching returning <code>true</code>. @@ -307,7 +307,7 @@ public class RegistryStrategy { } /** - * Specifies if lazy cache loading is used. + * Specifies if lazy cache loading is used. * <p> * The default implementation specifies that lazy cache loading is going to be used * and therefore returns <code>true</code>. @@ -321,21 +321,21 @@ public class RegistryStrategy { /** * This method is called as a part of the registry cache validation. The cache is valid - * on the registry startup if the pair {container time stamp, contributors time stamp} + * on the registry startup if the pair {container time stamp, contributors time stamp} * supplied by the registry strategy is the same as the {container time stamp, contributors time stamp} * stored in the registry cache. The goal of the validation is to be able to catch modifications - * made to the original data contributed into the registry and not reflected in the registry cache. + * made to the original data contributed into the registry and not reflected in the registry cache. * <p> - * The method produces a number that corresponds to the current state of the data stored + * 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. + * 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. * </p><p> - * 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 + * 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. * </p><p> * Return 0 to indicate that state verification is not required. @@ -348,23 +348,23 @@ public class RegistryStrategy { } /** - * This method is called as a part of the registry cache validation. The method calculates - * a number describing the time when the originating contributions (i.e., plugin.xml files - * in case of the Eclipse registry) were last modified. + * This method is called as a part of the registry cache validation. The method calculates + * a number describing the time when the originating contributions (i.e., plugin.xml files + * in case of the Eclipse registry) were last modified. * <p> - * The value returned by the method is compared with the timestamp tracked by the registry. + * 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 {@link #getContributionsTimestamp()} - * will change and no longer will be the same as the value tracked by the registry. In this case + * 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. * </p><p> * (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.) + * to be a hash value aggregating a number of actual timestamps from the contributions.) * </p><p> - * This method may return 0 to indicate that no time stamp verification is required. + * This method may return 0 to indicate that no time stamp verification is required. * </p> * @return a value corresponding to the last modification time of contributions contained - * in the registry + * in the registry */ public long getContributionsTimestamp() { return 0; @@ -373,8 +373,8 @@ public class RegistryStrategy { /** * Returns the parser used by the registry to parse descriptions of extension points and extensions. * This method must not return <code>null</code>. - * - * @return this strategy's parser + * + * @return this strategy's parser * @see org.eclipse.core.runtime.IExtensionRegistry#addContribution(java.io.InputStream, IContributor, boolean, String, ResourceBundle, Object) */ public SAXParserFactory getXMLParser() { @@ -386,10 +386,10 @@ public class RegistryStrategy { /** * Translates array of keys supplied by the contributor to the requested locale. * <p> - * This method is intended to be overridden by specialized registry strategies - * that know translation conventions for the contributors, for instance, + * 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. + * The base implementation simply returns the array of non-translated keys. * </p><p> * This method is only used if multi-language support is enabled. * </p> @@ -405,17 +405,17 @@ public class RegistryStrategy { } /** - * Returns the current locale for the extension registry with enabled + * Returns the current locale for the extension registry with enabled * multi-language support. * <p> - * The default implementation assumes that there is a single system wide + * The default implementation assumes that there is a single system wide * locale, equivalent to {@link Locale#getDefault()}. * </p><p> - * The result of this method should not be retained or passed to other threads. + * 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. * </p><p> - * This method can be overridden by subclasses that wish to provide a way - * to change the default locale. + * This method can be overridden by subclasses that wish to provide a way + * to change the default locale. * </p><p> * This method is only used if multi-language support is enabled. * </p> |