diff options
author | Thomas Watson | 2020-02-07 21:24:31 +0000 |
---|---|---|
committer | Thomas Watson | 2020-02-07 21:56:04 +0000 |
commit | 5beb53f68349d191433725fc28426cc83af1cff0 (patch) | |
tree | cf241ec98b12af446169c119a5d6a83f10ddb8fb /bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service | |
parent | cc47623ee22bc697e67dd7697e21a27087b57983 (diff) | |
download | rt.equinox.framework-5beb53f68349d191433725fc28426cc83af1cff0.tar.gz rt.equinox.framework-5beb53f68349d191433725fc28426cc83af1cff0.tar.xz rt.equinox.framework-5beb53f68349d191433725fc28426cc83af1cff0.zip |
Bug 558963 - Run Whitespace removal cleanup batch operation on EquinoxI20200212-1810I20200212-1800I20200212-1420I20200212-0910I20200211-1800I20200210-1800I20200209-1800I20200208-1800I20200207-1800
bundles
Change-Id: I349e141aac1259d952661b543e01449e6eb7dd47
Signed-off-by: Thomas Watson <tjwatson@us.ibm.com>
Diffstat (limited to 'bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service')
26 files changed, 376 insertions, 376 deletions
diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/pluginconversion/PluginConversionException.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/pluginconversion/PluginConversionException.java index 474242bd9..178da0925 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/pluginconversion/PluginConversionException.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/pluginconversion/PluginConversionException.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -15,7 +15,7 @@ package org.eclipse.osgi.service.pluginconversion; /** * Custom exception for errors that can happen during plugin conversion. - * + * * @since 3.0 */ public class PluginConversionException extends Exception { @@ -35,7 +35,7 @@ public class PluginConversionException extends Exception { /** * Create a new exception with the given message. - * + * * @param message the message for the exception */ public PluginConversionException(String message) { @@ -44,7 +44,7 @@ public class PluginConversionException extends Exception { /** * Create a new exception with the given message and nested exception. - * + * * @param message the message for the exception * @param cause the nested exception */ @@ -55,7 +55,7 @@ public class PluginConversionException extends Exception { /** * Create a new exception with the given nested exception. - * + * * @param cause the nested exception */ public PluginConversionException(Throwable cause) { @@ -65,7 +65,7 @@ public class PluginConversionException extends Exception { /** * Return the nested exception for this exception or <code>null</code> * if there is none. - * + * * @return the nested exception or <code>null</code> */ @Override diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/pluginconversion/PluginConverter.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/pluginconversion/PluginConverter.java index 216ede320..c86810835 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/pluginconversion/PluginConverter.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/pluginconversion/PluginConverter.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -22,60 +22,60 @@ import java.util.Dictionary; * <p> * This interface is not intended to be implemented by clients. * </p> - * + * * @since 3.0 */ public interface PluginConverter { /** - * Converts a plug-in/fragment manifest at the given source base location (a directory or jar file) and + * Converts a plug-in/fragment manifest at the given source base location (a directory or jar file) and * generates a corresponding bundle manifest at the given default target location (a file). - * + * * @param pluginBaseLocation the base location for the plug-in/fragment manifest to be converted * (a directory or jar file, e.g. the plug-in install location) * @param bundleManifestLocation the location for the bundle manifest to be generated - * (including the file name). - * @param compatibilityManifest a boolean indicating if the manifest should contain headers to run + * (including the file name). + * @param compatibilityManifest a boolean indicating if the manifest should contain headers to run * in backward compatibility - * @param target a string indicating the version of the runtime for which the manifest generated is targeted + * @param target a string indicating the version of the runtime for which the manifest generated is targeted * @param analyseJars a boolean indicating if the code jars of the given plugin must be analysed. When set to false the Export-Package header will not be set in the bundle manifest. - * @param devProperties a dictionary of development time classpath properties. The dictionary contains a mapping from plugin id to development + * @param devProperties a dictionary of development time classpath properties. The dictionary contains a mapping from plugin id to development * time classpath. A value of <code>null</code> indicates that the default development time classpath properties will be used. - * @return the generated manifest file location, if a bundle manifest was successfully + * @return the generated manifest file location, if a bundle manifest was successfully * generated (or already existed), <code>null</code> otherwise. * @throws PluginConversionException if an error occurs while converting the manifest */ public File convertManifest(File pluginBaseLocation, File bundleManifestLocation, boolean compatibilityManifest, String target, boolean analyseJars, Dictionary<String, String> devProperties) throws PluginConversionException; /** - * Converts a plug-in/fragment manifest at the given source base location (a directory or jar file) and + * Converts a plug-in/fragment manifest at the given source base location (a directory or jar file) and * generates a corresponding bundle manifest returned as a dictionary. - * + * * @param pluginBaseLocation the base location for the plug-in/fragment manifest to be converted * (a directory or jar file, e.g. the plug-in install location) - * @param compatibility a boolean indicating if the manifest should contain headers to run + * @param compatibility a boolean indicating if the manifest should contain headers to run * in backward compatibility * @param target a string indicating the version of the runtime for which the manifest generated is targeted * @param analyseJars a boolean indicating if the code jars of the given plugin must be analysed. When set to false the Export-Package header will not be set in the bundle manifest. - * @param devProperties a dictionary of development time classpath properties. The dictionary contains a mapping from plugin id to development + * @param devProperties a dictionary of development time classpath properties. The dictionary contains a mapping from plugin id to development * time classpath. A value of <code>null</code> indicates that the default development time classpath properties will be used. - * @return the generated manifest as a dictionary, if a bundle manifest was successfully + * @return the generated manifest as a dictionary, if a bundle manifest was successfully * generated, <code>null</code> otherwise * @throws PluginConversionException if an error occurs while converting the manifest */ public Dictionary<String, String> convertManifest(File pluginBaseLocation, boolean compatibility, String target, boolean analyseJars, Dictionary<String, String> devProperties) throws PluginConversionException; /** - * Construct a bundle manifest file from the given dictionary and write it out to the - * specified location in the file system. + * Construct a bundle manifest file from the given dictionary and write it out to the + * specified location in the file system. * <p> - * If the <code>compatibilityManifest</code> parameter is <code>true</code> then + * If the <code>compatibilityManifest</code> parameter is <code>true</code> then * the generated manifest will include the necessary headers to all the manifest to be - * run in backwards compatibility mode. + * run in backwards compatibility mode. * </p> - * + * * @param generationLocation the location for the bundle manifest to be written - * @param manifestToWrite the dictionary to write into generationLocation file - * @param compatibilityManifest a boolean indicating if the file should contain headers to allow + * @param manifestToWrite the dictionary to write into generationLocation file + * @param compatibilityManifest a boolean indicating if the file should contain headers to allow * running in backward compatibility mode * @throws PluginConversionException if an error occurs while writing the given manifest */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BaseDescription.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BaseDescription.java index 67b485cca..5112ca1ce 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BaseDescription.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BaseDescription.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -67,7 +67,7 @@ public interface BaseDescription { /** * Returns the capability represented by this description. - * Some descriptions types may not be able to represent + * Some descriptions types may not be able to represent * a capability. In such cases <code>null</code> is * returned. * @return the capability represented by this base description @@ -76,9 +76,9 @@ public interface BaseDescription { public BundleCapability getCapability(); /** - * Returns the user object associated to this description, or + * Returns the user object associated to this description, or * <code>null</code> if none exists. - * + * * @return the user object associated to this description, * or <code>null</code> * @since 3.8 @@ -87,11 +87,11 @@ public interface BaseDescription { /** * Associates a user-provided object to this description, or - * removes an existing association, if <code>null</code> is provided. The - * provided object is not interpreted in any ways by this + * removes an existing association, if <code>null</code> is provided. The + * provided object is not interpreted in any ways by this * description. - * - * @param userObject an arbitrary object provided by the user, or + * + * @param userObject an arbitrary object provided by the user, or * <code>null</code> * @since 3.8 */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BundleDelta.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BundleDelta.java index 72e8967be..8aa3dac9e 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BundleDelta.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BundleDelta.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -27,12 +27,12 @@ public interface BundleDelta extends Comparable<BundleDelta> { /** * Delta type constant (bit mask) indicating that the bundle has been added - * to the new state. + * to the new state. * @see BundleDelta#getType */ public static final int ADDED = 0x1; /** - * Delta type constant (bit mask) indicating that the bundle is no longer present in + * Delta type constant (bit mask) indicating that the bundle is no longer present in * the new state. * @see BundleDelta#getType */ @@ -40,19 +40,19 @@ public interface BundleDelta extends Comparable<BundleDelta> { /** * Delta type constant (bit mask) indicating that the bundle has been updated * between the old and new state. Note that an update delta may in fact represent - * a downgrading of the bundle to a previous version. + * a downgrading of the bundle to a previous version. * @see BundleDelta#getType */ public static final int UPDATED = 0x4; /** * Delta type constant (bit mask) indicating that the bundle has become resolved - * in the new state. + * in the new state. * @see BundleDelta#getType */ public static final int RESOLVED = 0x8; /** * Delta type constant (bit mask) indicating that the bundle has become unresolved - * in the new state. Note that newly added bundles are unresolved by default and + * in the new state. Note that newly added bundles are unresolved by default and * as such, do not transition to unresolved state so this flag is not set. * @see BundleDelta#getType */ @@ -77,7 +77,7 @@ public interface BundleDelta extends Comparable<BundleDelta> { * Delta type constant (bit mask) indicating that the this bundle is * pending a removal. Note that bundles with this flag set will also * have the {@link BundleDelta#REMOVED} flag set. A bundle will have - * this flag set if it has been removed from the state but has other + * this flag set if it has been removed from the state but has other * existing bundles in the state that depend on it. * @see BundleDelta#getType */ @@ -86,21 +86,21 @@ public interface BundleDelta extends Comparable<BundleDelta> { /** * Delta type constant (bit mask) indicating that the this bundle has * completed a pending removal. A bundle will complete a pending removal only - * after it has been re-resolved by the resolver. + * after it has been re-resolved by the resolver. */ public static final int REMOVAL_COMPLETE = 0x100; /** * Returns the BundleDescription that this bundle delta is for. - * @return the BundleDescription that this bundle delta is for. + * @return the BundleDescription that this bundle delta is for. */ public BundleDescription getBundle(); /** * Returns the type of change which occured. The return value is composed - * of by bit-wise masking the relevant flags from the set ADDED, REMOVED, - * UPDATED, RESOLVED, UNRESOLVED, LINKAGE_CHANGED, REMOVAL_PENDING, REMOVAL_COMPLETE. - * Note that bundle start and stop state changes are not captured in the + * of by bit-wise masking the relevant flags from the set ADDED, REMOVED, + * UPDATED, RESOLVED, UNRESOLVED, LINKAGE_CHANGED, REMOVAL_PENDING, REMOVAL_COMPLETE. + * Note that bundle start and stop state changes are not captured in the * delta as they do not represent structural changes but rather transient * runtime states. * @return the type of change which occured @@ -113,7 +113,7 @@ public interface BundleDelta extends Comparable<BundleDelta> { * <p> * The natural order of elements is determined by the bundle id of the * BundleDescription that this bundle delta is for. - * + * * @return int which should be <0 if the receiver should sort before the * argument, 0 if the receiver should sort in the same position as * the argument, and >0 if the receiver should sort after the diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BundleDescription.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BundleDescription.java index f96b546df..dc4bd5c74 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BundleDescription.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BundleDescription.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -53,7 +53,7 @@ public interface BundleDescription extends BaseDescription, BundleRevision { /** * Returns an array of bundle specifications defined by the Require-Bundle * clause in this bundle. - * + * * @return an array of bundle specifications */ public BundleSpecification[] getRequiredBundles(); @@ -115,7 +115,7 @@ public interface BundleDescription extends BaseDescription, BundleRevision { /** * Returns all the capabilities provided by ths bundle that have been selected by * the resolver. The returned list will include the capabilities - * returned by {@link #getGenericCapabilities()} that have been selected by the + * returned by {@link #getGenericCapabilities()} that have been selected by the * resolver and any capabilities provided by fragments attached to this bundle. * @return the selected capabilities that this bundle provides. If the bundle is * unresolved or has no capabilities then an empty array is returned. @@ -151,7 +151,7 @@ public interface BundleDescription extends BaseDescription, BundleRevision { /** * Returns true if this bundle is resolved in its host state. - * + * * @return true if this bundle is resolved in its host state. */ public boolean isResolved(); @@ -159,14 +159,14 @@ public interface BundleDescription extends BaseDescription, BundleRevision { /** * Returns the state object which hosts this bundle. null is returned if * this bundle is not currently in a state. - * + * * @return the state object which hosts this bundle. */ public State getContainingState(); /** * Returns the string representation of this bundle. - * + * * @return String representation of this bundle. */ @Override @@ -175,36 +175,36 @@ public interface BundleDescription extends BaseDescription, BundleRevision { /** * Returns the host for this bundle. null is returned if this bundle is not * a fragment. - * + * * @return the host for this bundle. */ public HostSpecification getHost(); /** * Returns the numeric id of this bundle. Typically a bundle description - * will only have a numeric id if it represents a bundle that is installed in a + * will only have a numeric id if it represents a bundle that is installed in a * framework as the framework assigns the ids. -1 is returned if the id is not known. - * + * * @return the numeric id of this bundle description */ public long getBundleId(); /** * Returns all fragments known to this bundle (regardless resolution status). - * + * * @return an array of BundleDescriptions containing all known fragments */ public BundleDescription[] getFragments(); /** - * Returns whether this bundle is a singleton. Singleton bundles require - * that at most one single version of the bundle can be resolved at a time. + * Returns whether this bundle is a singleton. Singleton bundles require + * that at most one single version of the bundle can be resolved at a time. * <p> * The existence of a single bundle marked as singleton causes all bundles - * with the same symbolic name to be treated as singletons as well. + * with the same symbolic name to be treated as singletons as well. * </p> - * - * @return <code>true</code>, if this bundle is a singleton, + * + * @return <code>true</code>, if this bundle is a singleton, * <code>false</code> otherwise */ public boolean isSingleton(); @@ -220,7 +220,7 @@ public interface BundleDescription extends BaseDescription, BundleRevision { /** * Returns all bundles which depend on this bundle. A bundle depends on - * another bundle if it requires the bundle, imports a package which is + * another bundle if it requires the bundle, imports a package which is * exported by the bundle, is a fragment to the bundle or is the host * of the bundle. * @return all bundles which depend on this bundle. @@ -247,8 +247,8 @@ public interface BundleDescription extends BaseDescription, BundleRevision { public boolean dynamicFragments(); /** - * Returns the list of execution environments that are required by - * this bundle. Any one of the listed execution environments will + * Returns the list of execution environments that are required by + * this bundle. Any one of the listed execution environments will * allow this bundle to be resolved. * @since 3.2 * @return the list of execution environments that are required. diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BundleSpecification.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BundleSpecification.java index b15eb8bc2..18c6151f7 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BundleSpecification.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/BundleSpecification.java @@ -7,14 +7,14 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.osgi.service.resolver; /** - * A representation of one bundle import constraint as seen in a + * A representation of one bundle import constraint as seen in a * bundle manifest and managed by a state and resolver. * <p> * This interface is not intended to be implemented by clients. The @@ -26,16 +26,16 @@ package org.eclipse.osgi.service.resolver; public interface BundleSpecification extends VersionConstraint { /** - * Returns whether or not this bundle specificiation is exported from the + * Returns whether or not this bundle specificiation is exported from the * declaring bundle. - * + * * @return whether this specification is exported */ public boolean isExported(); /** * Returns whether or not this bundle specificiation is optional. - * + * * @return whether this specification is optional */ public boolean isOptional(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/DisabledInfo.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/DisabledInfo.java index 7fcb76641..d79a6b339 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/DisabledInfo.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/DisabledInfo.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -19,8 +19,8 @@ package org.eclipse.osgi.service.resolver; * method and enabled by removing disabled info with the {@link State#removeDisabledInfo(DisabledInfo)} method. * A bundle is not considered to be enabled unless there are no disabled info objects for the bundle. * <p> - * While resolving the bundle if the {@link Resolver} encounters a {@link BundleDescription} which - * has disabled info returned by {@link State#getDisabledInfos(BundleDescription)} then the bundle + * While resolving the bundle if the {@link Resolver} encounters a {@link BundleDescription} which + * has disabled info returned by {@link State#getDisabledInfos(BundleDescription)} then the bundle * must not be allowed to resolve and a ResolverError of type {@link ResolverError#DISABLED_BUNDLE} * must be added to the state. * </p> diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ExportPackageDescription.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ExportPackageDescription.java index 1755bf5af..09fa8eb71 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ExportPackageDescription.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ExportPackageDescription.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -56,7 +56,7 @@ public interface ExportPackageDescription extends BaseDescription { public Object getDirective(String key); /** - * Returns the exporter of this package. + * Returns the exporter of this package. * @return the exporter of this package. */ public BundleDescription getExporter(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/GenericDescription.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/GenericDescription.java index c18431ab5..236f3eeaf 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/GenericDescription.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/GenericDescription.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -40,14 +40,14 @@ public interface GenericDescription extends BaseDescription { public String getType(); /** - * This method is deprecated. Capabilities do not always have a + * This method is deprecated. Capabilities do not always have a * name associated with them. All matching attributes associated - * with a capability are available in the attributes of a - * capability. This method will return the value of the + * with a capability are available in the attributes of a + * capability. This method will return the value of the * attribute with the same key as this capabilities type. * If this attribute's value is not a String then null is * returned. - * @deprecated matching should only be done against a capability's + * @deprecated matching should only be done against a capability's * attributes. */ @Override @@ -57,7 +57,7 @@ public interface GenericDescription extends BaseDescription { * This method is deprecated. Capabilities do not always have a * version associated with them. All matching attributes associated * with a capability are available in the attributes of a - * capability. This method will return the value of the + * capability. This method will return the value of the * attribute with the key <code>"version"</code>. * If this attribute's value is not a {@link Version} then null is * returned. diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/GenericSpecification.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/GenericSpecification.java index 330df572b..a02d1f4f8 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/GenericSpecification.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/GenericSpecification.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -46,7 +46,7 @@ public interface GenericSpecification extends VersionConstraint { * Returns the resolution type of the required capability. The returned * value is a bit mask that may have the optional bit {@link #RESOLUTION_OPTIONAL} * and/or the multiple bit {@link #RESOLUTION_MULTIPLE} set. - * + * * @return the resolution type of the required capability */ public int getResolution(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/HostSpecification.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/HostSpecification.java index 276f961a0..f79733439 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/HostSpecification.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/HostSpecification.java @@ -7,14 +7,14 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.osgi.service.resolver; /** - * A representation of one host bundle constraint as seen in a + * A representation of one host bundle constraint as seen in a * bundle manifest and managed by a state and resolver. * <p> * This interface is not intended to be implemented by clients. The diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ImportPackageSpecification.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ImportPackageSpecification.java index ad97749e8..a2636fc42 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ImportPackageSpecification.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ImportPackageSpecification.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -16,7 +16,7 @@ package org.eclipse.osgi.service.resolver; import java.util.Map; /** - * A representation of one package import constraint as seen in a + * A representation of one package import constraint as seen in a * bundle manifest and managed by a state and resolver. * <p> * This interface is not intended to be implemented by clients. The @@ -47,7 +47,7 @@ public interface ImportPackageSpecification extends VersionConstraint { public String getBundleSymbolicName(); /** - * Returns the version range which this import package may be resolved to. + * Returns the version range which this import package may be resolved to. * @return the version range which this import package may be resolved to. */ public VersionRange getBundleVersionRange(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/NativeCodeDescription.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/NativeCodeDescription.java index 43f5a2674..8cfdf8fa9 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/NativeCodeDescription.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/NativeCodeDescription.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -33,7 +33,7 @@ public interface NativeCodeDescription extends BaseDescription, Comparable<Nativ /** * Returns the processors supported by the native code. - * @return the processors supported by the native code. An + * @return the processors supported by the native code. An * empty array is returned if no processors are supported. */ public String[] getProcessors(); @@ -54,7 +54,7 @@ public interface NativeCodeDescription extends BaseDescription, Comparable<Nativ /** * Returns the languages supported by the native code. - * @return the languages supported by the native code. An empty array is + * @return the languages supported by the native code. An empty array is * returned if all languages are supported. */ public String[] getLanguages(); @@ -81,7 +81,7 @@ public interface NativeCodeDescription extends BaseDescription, Comparable<Nativ /** * Indicates if this native code description has invalid native code paths. Native - * code paths are invalid if they can not be found in the bundle content. + * code paths are invalid if they can not be found in the bundle content. * @return true if the native code paths are invalid; otherwise false is returned. */ public boolean hasInvalidNativePaths(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/NativeCodeSpecification.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/NativeCodeSpecification.java index b3b9aef56..057cfb64b 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/NativeCodeSpecification.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/NativeCodeSpecification.java @@ -7,19 +7,19 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.osgi.service.resolver; /** - * This class represents a native code specification. A - * native code specification is different from other + * This class represents a native code specification. A + * native code specification is different from other * specification constraints which typically are resolved against - * suppliers provided by other bundles. A native code + * suppliers provided by other bundles. A native code * specification supplies it own suppliers which are matched - * against the platform properties at resolve time and the + * against the platform properties at resolve time and the * supplier with the best match is selected. * <p> * This interface is not intended to be implemented by clients. The @@ -30,7 +30,7 @@ package org.eclipse.osgi.service.resolver; */ public interface NativeCodeSpecification extends VersionConstraint { /** - * Returns the list of possible suppliers to this native code specification. When + * Returns the list of possible suppliers to this native code specification. When * this native code specification is resolved one of the possible suppliers * will be selected and returned by {@link VersionConstraint#getSupplier()}. * @return the list of possible suppliers. @@ -39,7 +39,7 @@ public interface NativeCodeSpecification extends VersionConstraint { /** * Returns whether or not this native code specification is optional. - * + * * @return whether this specification is optional */ public boolean isOptional(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/PlatformAdmin.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/PlatformAdmin.java index 0d7525325..6612cebd4 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/PlatformAdmin.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/PlatformAdmin.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation * Rob Harrop - SpringSource Inc. (bug 247522) @@ -32,40 +32,40 @@ import org.osgi.framework.BundleException; */ public interface PlatformAdmin { - /** + /** * Returns a mutable state representing the current system. * <p> - * This is a convenience method, fully equivalent to + * This is a convenience method, fully equivalent to * <code>getState(true)</code>. - * </p> + * </p> * @return a state representing the current framework. */ public State getState(); - /** + /** * Returns a state representing the current system. If there is need to make - * changes to the returned state, a mutable state must be requested. - * Otherwise, an immutable state should be requested. In this case, invoking - * any of the operations that could cause the state to be changed will throw + * changes to the returned state, a mutable state must be requested. + * Otherwise, an immutable state should be requested. In this case, invoking + * any of the operations that could cause the state to be changed will throw * an <code>java.lang.UnsupportedOperationException</code>. * <p> - * If a mutable state is requested, the resulting state will <strong>not</strong> - * be resolved and the user objects from the system state bundle descriptions will + * If a mutable state is requested, the resulting state will <strong>not</strong> + * be resolved and the user objects from the system state bundle descriptions will * not be copied. - * </p> + * </p> * @param mutable whether the returned state should mutable * @return a state representing the current framework. */ public State getState(boolean mutable); /** - * Returns a state helper object. State helpers provide convenience methods - * for manipulating states. + * Returns a state helper object. State helpers provide convenience methods + * for manipulating states. * <p> * A possible implementation for this * method would provide the same single StateHelper instance to all clients. * </p> - * + * * @return a state helper * @see StateHelper */ @@ -73,9 +73,9 @@ public interface PlatformAdmin { /** * Commit the differences between the current state and the given state. - * The given state must return true from State.isResolved() or an exception - * is thrown. The resolved state is committed verbatim, as-is. - * + * The given state must return true from State.isResolved() or an exception + * is thrown. The resolved state is committed verbatim, as-is. + * * @param state the future state of the framework * @throws BundleException if the id of the given state does not match that of the * current state or if the given state is not resolved. @@ -83,7 +83,7 @@ public interface PlatformAdmin { public void commit(State state) throws BundleException; /** - * Returns a resolver supplied by the system. The returned resolver + * Returns a resolver supplied by the system. The returned resolver * will not be associated with any state. * @return a system resolver * @deprecated in favour of {@link #createResolver()}. @@ -98,15 +98,15 @@ public interface PlatformAdmin { public Resolver createResolver(); /** - * Returns a factory that knows how to create state objects, such as bundle + * Returns a factory that knows how to create state objects, such as bundle * descriptions and the different types of version constraints. * @return a state object factory */ public StateObjectFactory getFactory(); /** - * Adds the disabled info to the state managed by this platform admin. - * If a disable info already exists for the specified policy and the specified bundle + * Adds the disabled info to the state managed by this platform admin. + * If a disable info already exists for the specified policy and the specified bundle * then it is replaced with the given disabled info. * @param disabledInfo the disabled info to add. * @throws IllegalArgumentException if the <code>BundleDescription</code> for diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/Resolver.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/Resolver.java index e9c3f196b..720591992 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/Resolver.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/Resolver.java @@ -42,7 +42,7 @@ public interface Resolver { * Note the given state is destructively modified to reflect the results of * resolution. * </p> - * @param discard the list of bundles to discard the resolve status and + * @param discard the list of bundles to discard the resolve status and * reresolve. A <code>null</code> value indicates that all currently unresolved * bundles in the state should be resolved. * @param platformProperties the platform properties used to match platform filters @@ -62,7 +62,7 @@ public interface Resolver { * Returns the state associated with this resolver. A state can work with * at most one resolver at any given time. Similarly, a resolver can work * with at most one state at a time. - * + * * @return the state for this resolver. null is returned if the resolver * does not have a state */ @@ -77,7 +77,7 @@ public interface Resolver { * the following expression must be included in this method if the given * state (value) is not identical to the result of this.getState(). * </p> - * + * * <pre> * if (this.getState() != value) value.setResolver(this); * </pre> @@ -110,30 +110,30 @@ public interface Resolver { /** * Attempts to find an ExportPackageDescription that will satisfy a dynamic import * for the specified requestedPackage for the specified importingBundle. If no - * ExportPackageDescription is available that satisfies a dynamic import for the + * ExportPackageDescription is available that satisfies a dynamic import for the * importingBundle then <code>null</code> is returned. * @param importingBundle the BundleDescription that is requesting a dynamic package * @param requestedPackage the name of the package that is being requested - * @return the ExportPackageDescription that satisfies the dynamic import request; + * @return the ExportPackageDescription that satisfies the dynamic import request; * a value of <code>null</code> is returned if none is available. */ public ExportPackageDescription resolveDynamicImport(BundleDescription importingBundle, String requestedPackage); /** - * Sets the selection policy for this resolver. A selection policy is used to sort + * Sets the selection policy for this resolver. A selection policy is used to sort * possible suppliers of a version constraint in descending order. That is an order - * which is from most desired to least desired. The objects passed to the - * selection policy {@link Comparator#compare(Object, Object)} method - * will be of type {@link BaseDescription}. The selection policy should return a - * negative number, zero, or a positive number depending on if the first object is + * which is from most desired to least desired. The objects passed to the + * selection policy {@link Comparator#compare(Object, Object)} method + * will be of type {@link BaseDescription}. The selection policy should return a + * negative number, zero, or a positive number depending on if the first object is * more desired, equal amount of desire, or less desired than the second object respectively. * <p> * If no selection policy is set then a default policy will be used which sorts according - * to the following rules: + * to the following rules: * <ol> * <li> The resolution status of the bundle which supplies the base description. Resolved bundles take priority over unresolved ones. * <li> The version of the base description. Higher versions take priority over lower versions. - * <li> The bundle ID which supplies the base description. Lower IDs take priority over higher IDs. + * <li> The bundle ID which supplies the base description. Lower IDs take priority over higher IDs. * </ol> * @param selectionPolicy the selection policy for this resolver * @since 3.2 @@ -141,9 +141,9 @@ public interface Resolver { public void setSelectionPolicy(Comparator<BaseDescription> selectionPolicy); /** - * Returns the selection policy for this resolver or null if it is not set + * Returns the selection policy for this resolver or null if it is not set * @return the selection policy for this resolver or null if it is not set - * @since 3.2 + * @since 3.2 */ public Comparator<BaseDescription> getSelectionPolicy(); } diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ResolverError.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ResolverError.java index 5e20665be..1455899a7 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ResolverError.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ResolverError.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -24,7 +24,7 @@ package org.eclipse.osgi.service.resolver; */ public interface ResolverError { /** - * Error type constant (bit mask) indicating that an Import-Package could + * Error type constant (bit mask) indicating that an Import-Package could * not be resolved. * @see ResolverError#getType() */ @@ -55,7 +55,7 @@ public interface ResolverError { public static final int FRAGMENT_CONFLICT = 0x0010; /** * Error type constant (bit mask) indicating that an Import-Package could - * not be resolved because of a uses directive conflict. + * not be resolved because of a uses directive conflict. * @see ResolverError#getType() */ public static final int IMPORT_PACKAGE_USES_CONFLICT = 0x0020; @@ -88,14 +88,14 @@ public interface ResolverError { public static final int REQUIRE_BUNDLE_PERMISSION = 0x0200; /** * Error type constant (bit mask) indicating that a Require-Bundle could - * not be resolved because no bundle with the required symbolic name has + * not be resolved because no bundle with the required symbolic name has * the correct permissions to provide the required symbolic name. * @see ResolverError#getType() */ public static final int PROVIDE_BUNDLE_PERMISSION = 0x0400; /** * Error type constant (bit mask) indicating that a Fragment-Host could - * not be resolved because no bundle with the required symbolic name has + * not be resolved because no bundle with the required symbolic name has * the correct permissions to host a fragment. * @see ResolverError#getType() */ @@ -123,7 +123,7 @@ public interface ResolverError { public static final int MISSING_EXECUTION_ENVIRONMENT = 0x4000; /** - * Error type constant (bit mask) indicating that a bundle could not be + * Error type constant (bit mask) indicating that a bundle could not be * resolved because the required generic capability could not be resolved. */ public static final int MISSING_GENERIC_CAPABILITY = 0x8000; @@ -160,7 +160,7 @@ public interface ResolverError { /** * Error type constant (bit mask) indicating that a Require-Bundle could - * not be resolved because no bundle with the required symbolic name has + * not be resolved because no bundle with the required symbolic name has * the correct permissions to provide the required symbolic name. * @see ResolverError#getType() * @since 3.7 @@ -188,8 +188,8 @@ public interface ResolverError { public String getData(); /** - * Returns the unsatisfied constraint if this ResolverError occurred - * because of an unsatisfied constraint; otherwise <code>null</code> + * Returns the unsatisfied constraint if this ResolverError occurred + * because of an unsatisfied constraint; otherwise <code>null</code> * is returned. * @return the unsatisfied constraint or <code>null</code>. */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ResolverHookException.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ResolverHookException.java index 1020dec64..50dd0c2bc 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ResolverHookException.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/ResolverHookException.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/State.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/State.java index dc62889d8..f5c9ab972 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/State.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/State.java @@ -38,12 +38,12 @@ public interface State { * <p> * If the bundle already exists in another state then an <code>IllegalStateException</code> * will be thrown. Note that even if you remove a <code>BundleDescription</code> from - * one <code>State</code> object using {@link State#removeBundle(BundleDescription)} it + * one <code>State</code> object using {@link State#removeBundle(BundleDescription)} it * may still be considered as removing pending if other bundles in that state depend on the - * bundle you removed. To complete a pending removal a call must be done to + * bundle you removed. To complete a pending removal a call must be done to * {@link State#resolve(BundleDescription[])} with the removed bundle. * </p> - * + * * @param description the description to add * @return a boolean indicating whether the bundle was successfully added * @throws IllegalStateException if the bundle already exists in another state @@ -55,17 +55,17 @@ public interface State { * given state. The given state is taken as the base so the absence of a bundle * in this state is reported as a deletion, etc. *<p>Note that the generated StateDelta will contain BundleDeltas with one - *of the following types: BundleDelta.ADDED, BundleDelta.REMOVED and + *of the following types: BundleDelta.ADDED, BundleDelta.REMOVED and *BundleDelta.UPDATED</p> - * + * * @param baseState the base state - * @return a delta describing differences between this and the base state state + * @return a delta describing differences between this and the base state state */ public StateDelta compare(State baseState) throws BundleException; /** * Removes a bundle description with the given bundle id. - * + * * @param bundleId the id of the bundle description to be removed * @return the removed bundle description, or <code>null</code>, if a bundle * with the given id does not exist in this state @@ -74,42 +74,42 @@ public interface State { /** * Removes the given bundle description. - * + * * @param bundle the bundle description to be removed - * @return <code>true</code>, if if the bundle description was removed, - * <code>false</code> otherwise + * @return <code>true</code>, if if the bundle description was removed, + * <code>false</code> otherwise */ public boolean removeBundle(BundleDescription bundle); /** - * Updates an existing bundle description with the given description. - * + * Updates an existing bundle description with the given description. + * * @param newDescription the bundle description to replace an existing one - * @return <code>true</code>, if if the bundle description was updated, - * <code>false</code> otherwise + * @return <code>true</code>, if if the bundle description was updated, + * <code>false</code> otherwise */ public boolean updateBundle(BundleDescription newDescription); /** * Returns the delta representing the changes from the time this state was * first captured until now. - * + * * @return the state delta */ public StateDelta getChanges(); /** * Returns descriptions for all bundles known to this state. - * + * * @return the descriptions for all bundles known to this state. */ public BundleDescription[] getBundles(); /** - * Returns the bundle descriptor for the bundle with the given id. - * <code>null</code> is returned if no such bundle is found in - * this state. - * + * Returns the bundle descriptor for the bundle with the given id. + * <code>null</code> is returned if no such bundle is found in + * this state. + * * @return the descriptor for the identified bundle * @see BundleDescription#getBundleId() */ @@ -122,7 +122,7 @@ public interface State { * If multiple bundles with the same resolution state are available, the bundle * with the highest version number is returned if the <code>version</code> is * null. - * + * * @param symbolicName symbolic name of the bundle to query * @param version version of the bundle to query. null matches any bundle * @return the descriptor for the identified bundle @@ -131,8 +131,8 @@ public interface State { /** * Returns the bundle descriptor for the bundle with the given location - * identifier. null is returned if no such bundle is found in this state. - * + * identifier. null is returned if no such bundle is found in this state. + * * @param location location identifier of the bundle to query * @return the descriptor for the identified bundle */ @@ -144,7 +144,7 @@ public interface State { * the system state timestamp is 4 but then some bundles are installed, * the system state timestamp is updated. By comparing 4 to the current system * state timestamp it is possible to detect if the states are out of sync. - * + * * @return the timestamp of this state */ public long getTimeStamp(); @@ -158,7 +158,7 @@ public interface State { /** * Returns true if there have been no modifications to this state since the * last time resolve() was called. - * + * * @return whether or not this state has changed since last resolved. */ public boolean isResolved(); @@ -166,15 +166,15 @@ public interface State { /** * Resolves the given version constraint with the given supplier. The given * constraint object is destructively modified to reflect its new resolved - * state. Note that a constraint can be unresolved by passing null for + * state. Note that a constraint can be unresolved by passing null for * the supplier. * <p> * This method is intended to be used by resolvers in the process of * determining which constraints are satisfied by which components. * </p> - * + * * @param constraint the version constraint to update - * @param supplier the supplier which satisfies the constraint. May be null if + * @param supplier the supplier which satisfies the constraint. May be null if * the constraint is to be unresolved. * @throws IllegalStateException if this is not done during a call to * <code>resolve</code> @@ -187,7 +187,7 @@ public interface State { * This method is intended to be used by resolvers in the process of * determining which constraints are satisfied by which components. * </p> - * + * * @param bundle the bundle to update * @param status whether or not the given bundle is resolved, if false the other parameters are ignored * @param hosts the host for the resolve fragment, can be <code>null</code> @@ -205,7 +205,7 @@ public interface State { * This method is intended to be used by resolvers in the process of * determining which constraints are satisfied by which components. * </p> - * + * * @param bundle the bundle to update * @param status whether or not the given bundle is resolved, if false the other parameters are ignored * @param hosts the host for the resolve fragment, can be <code>null</code> @@ -225,7 +225,7 @@ public interface State { * This method is intended to be used by resolvers in the process of * determining which constraints are satisfied by which components. * </p> - * + * * @param bundle the bundle to update * @param status whether or not the given bundle is resolved, if false the other parameters are ignored * @param hosts the host for the resolve fragment, can be <code>null</code> @@ -244,7 +244,7 @@ public interface State { /** * Sets the given removal pending bundle to removal complete for this state. * <p> - * This method is intended to be used by resolvers in the process of + * This method is intended to be used by resolvers in the process of * resolving bundles. * </p> * @param bundle the bundle to set a removal complete. @@ -259,7 +259,7 @@ public interface State { * This method is intended to be used by resolvers in the process of * resolving. * </p> - * + * * @param bundle the bundle to add a new <code>ResolverError</code> for * @param type the type of <code>ResolverError</code> to add * @param data the data for the <code>ResolverError</code> @@ -276,7 +276,7 @@ public interface State { * This method is intended to be used by resolvers in the process of * resolving. * </p> - * + * * @param bundle the bundle to remove all <code>ResolverError</code>s for * @throws IllegalStateException if this is not done during a call to <code>resolve</code> * @since 3.2 @@ -295,7 +295,7 @@ public interface State { * Returns the resolver associated with this state. A state can work with * at most one resolver at any given time. Similarly, a resolver can work * with at most one state at a time. - * + * * @return the resolver for this state. null is returned if the state does * not have a resolver */ @@ -310,11 +310,11 @@ public interface State { * the following expression must be included in this method if the given * resolver (value) is not identical to the result of this.getResolver(). * </p> - * + * * <pre> * if (this.getResolver() != value) value.setState(this); * </pre> - * + * */ // TODO what happens if you set the Resolver after some bundles have // been added to the state but it is not resolved? Should setting @@ -327,11 +327,11 @@ public interface State { * changes in resolved states and dependencies in the state. * <p> * Note that this method is typically implemented using - * + * * <pre> * this.getResolver().resolve(); * </pre> - * + * * and is the preferred path for invoking resolution. In particular, states * should refuse to perform updates (@see #select() and * #resolveConstraint()) if they are not currently involved in a resolution @@ -340,9 +340,9 @@ public interface State { * Note the given state is destructively modified to reflect the results of * resolution. * </p> - * + * * @param incremental a flag controlling whether resolution should be incremental - * @return a delta describing the changes in resolved state and + * @return a delta describing the changes in resolved state and * interconnections */ public StateDelta resolve(boolean incremental); @@ -354,14 +354,14 @@ public interface State { /** * Resolves the constraints contained in this state using the resolver - * currently associated with the state in an incremental, "least-perturbing" - * mode, and returns a delta describing the changes in resolved states and + * currently associated with the state in an incremental, "least-perturbing" + * mode, and returns a delta describing the changes in resolved states and * dependencies in the state. - * - * @param discard an array containing descriptions for bundles whose + * + * @param discard an array containing descriptions for bundles whose * current resolution state should be forgotten. If <code>null</code> * then all the current removal pending BundleDescriptions are refreshed. - * @return a delta describing the changes in resolved state and + * @return a delta describing the changes in resolved state and * interconnections */ public StateDelta resolve(BundleDescription[] discard); @@ -370,13 +370,13 @@ public interface State { * Resolves the constraints contained in this state using the resolver * currently associated with the state in an incremental, "least-perturbing" * mode, and returns a delta describing the changes in resolved states and - * dependencies in the state. If discard is set to true the - * the descriptions contained in the resolve array will have their + * dependencies in the state. If discard is set to true the + * the descriptions contained in the resolve array will have their * current resolution state discarded and will be re-resolved. * This method will attempt to resolve the supplied descriptions * and may attempt to resolve any other unresolved descriptions contained * in this state. - * + * * @param resolve an array containing descriptions for bundles to resolve. * @param discard a value of true indicates the resolve descriptions * should have their current resolution state discarded and re-resolved. @@ -391,7 +391,7 @@ public interface State { * of this state. Version overrides allow external forces to * refine/override the version constraints setup by the components in the * state. - * + * * @param value Format undefined. * @deprecated The exact form of this has never been defined. There is * no alternative method available. @@ -400,7 +400,7 @@ public interface State { /** * Returns descriptions for all bundles currently resolved in this state. - * + * * @return the descriptions for all bundles currently resolved in this * state. */ @@ -415,7 +415,7 @@ public interface State { /** * Returns the dependency closure for the specified bundles. - * + * * <p> * A graph of bundles is computed starting with the specified bundles. The * graph is expanded by adding any bundle that is either wired to a package @@ -423,7 +423,7 @@ public interface State { * in the graph. The graph is fully constructed when there is no bundle * outside the graph that is wired to a bundle in the graph. The graph may * contain removal pending bundles. - * + * * @param bundles The initial bundles for which to generate the dependency * closure. * @return A collection containing a snapshot of the dependency closure of @@ -435,13 +435,13 @@ public interface State { /** * Returns whether this state is empty. - * @return <code>true</code> if this state is empty, <code>false</code> + * @return <code>true</code> if this state is empty, <code>false</code> * otherwise */ public boolean isEmpty(); /** - * Returns all exported packages in this state, according to the OSGi rules for resolution. + * Returns all exported packages in this state, according to the OSGi rules for resolution. * @see org.osgi.service.packageadmin.PackageAdmin#getExportedPackages(org.osgi.framework.Bundle) */ public ExportPackageDescription[] getExportedPackages(); @@ -456,25 +456,25 @@ public interface State { /** * Returns the factory that created this state. - * @return the state object factory that created this state + * @return the state object factory that created this state */ public StateObjectFactory getFactory(); /** * Attempts to find an ExportPackageDescription that will satisfy a dynamic import * for the specified requestedPackage for the specified importingBundle. If no - * ExportPackageDescription is available that satisfies a dynamic import for the + * ExportPackageDescription is available that satisfies a dynamic import for the * importingBundle then <code>null</code> is returned. * @param importingBundle the BundleDescription that is requesting a dynamic package * @param requestedPackage the name of the package that is being requested - * @return the ExportPackageDescription that satisfies the dynamic import request; + * @return the ExportPackageDescription that satisfies the dynamic import request; * a value of <code>null</code> is returned if none is available. */ public ExportPackageDescription linkDynamicImport(BundleDescription importingBundle, String requestedPackage); /** - * Adds the specified dynamic imports to the specified importingBundle. The added - * dynamic imports are only valid for the instance of this state and will be + * Adds the specified dynamic imports to the specified importingBundle. The added + * dynamic imports are only valid for the instance of this state and will be * forgotten if this state is read from a persistent cache. * @param importingBundle the bundle to add the imports to. * @param dynamicImports the dynamic imports to add. @@ -499,34 +499,34 @@ public interface State { * <li>osgi.ws - the platform windowing system.</li> * <li>osgi.resolverMode - the resolver mode. A value of "strict" will set the resolver mode to strict.</li> * <li>org.osgi.framework.system.packages - the packages exported by the system bundle.</li> - * <li>org.osgi.framework.executionenvironment - the comma separated list of supported execution environments. + * <li>org.osgi.framework.executionenvironment - the comma separated list of supported execution environments. * This property is then used to resolve the required execution environment the bundles in a state.</li> - * <li>org.osgi.framework.os.name - the name of the operating system. This property is used to resolve the osname attribute of + * <li>org.osgi.framework.os.name - the name of the operating system. This property is used to resolve the osname attribute of * bundle native code (i.e. Bundle-NativeCode).</li> - * <li>org.osgi.framework.os.version - the version of the operating system. This property is used to resolve the osversion attribute + * <li>org.osgi.framework.os.version - the version of the operating system. This property is used to resolve the osversion attribute * of bundle native code (i.e. Bundle-NativeCode).</li> - * <li>org.osgi.framework.processor - the processor name. This property is used to resolve the processor attribute + * <li>org.osgi.framework.processor - the processor name. This property is used to resolve the processor attribute * of bundle native code (i.e. Bundle-NativeCode).</li> - * <li>org.osgi.framework.language - the language being used. This property is used to resolve the language attribute + * <li>org.osgi.framework.language - the language being used. This property is used to resolve the language attribute * of bundle native code (i.e. Bundle-NativeCode).</li> * </ul> * The values used for the supported properties can be <code>String</code> type * to specify a single value for the property or they can by <code>String[]</code> - * to specify a list of values for the property. + * to specify a list of values for the property. * @param platformProperties the platform properties of the state * @return false if the platformProperties specified do not change any of the - * supported properties already set. If any of the supported property values + * supported properties already set. If any of the supported property values * are changed as a result of calling this method then true is returned. */ public boolean setPlatformProperties(Dictionary<?, ?> platformProperties); /** - * Sets the platform properties of the state to a list of platform properties. + * Sets the platform properties of the state to a list of platform properties. * @see #setPlatformProperties(Dictionary) - * + * * @param platformProperties a set of platform properties for the state * @return false if the platformProperties specified do not change any of the - * supported properties already set. If any of the supported property values + * supported properties already set. If any of the supported property values * are changed as a result of calling this method then true is returned. */ public boolean setPlatformProperties(Dictionary<?, ?>[] platformProperties); @@ -539,7 +539,7 @@ public interface State { public Dictionary[] getPlatformProperties(); /** - * Returns the list of system packages which are exported by the system bundle. + * Returns the list of system packages which are exported by the system bundle. * The list of system packages is set by the org.osgi.framework.system.packages * value in the platform properties for this state. * @see #setPlatformProperties(Dictionary) @@ -548,13 +548,13 @@ public interface State { public ExportPackageDescription[] getSystemPackages(); /** - * Returns a state helper object. State helpers provide convenience methods - * for manipulating states. + * Returns a state helper object. State helpers provide convenience methods + * for manipulating states. * <p> * A possible implementation for this * method would provide the same single StateHelper instance to all clients. * </p> - * + * * @return a state helper * @see StateHelper * @since 3.2 @@ -562,10 +562,10 @@ public interface State { public StateHelper getStateHelper(); /** - * Returns the highest bundle ID. The value -1 is returned if no + * Returns the highest bundle ID. The value -1 is returned if no * bundles exist in this state. * <p> - * Note that this method returns the highest bundle ID the ever existed in this + * Note that this method returns the highest bundle ID the ever existed in this * this state object. This bundle may have been removed from the state. * @return the highest bundle ID. * @since 3.3 @@ -597,7 +597,7 @@ public interface State { /** * Adds the disabled info to this state. If a disable info already exists - * for the specified policy and the specified bundle then it is replaced with + * for the specified policy and the specified bundle then it is replaced with * the given disabled info. * @param disabledInfo the disabled info to add. * @throws IllegalArgumentException if the <code>BundleDescription</code> for @@ -632,7 +632,7 @@ public interface State { public DisabledInfo getDisabledInfo(BundleDescription bundle, String policyName); /** - * Sets the resolver hook factory for this state. The resolver hook factory is + * Sets the resolver hook factory for this state. The resolver hook factory is * used during resolve operations according to the OSGi specification for the * resolver hook factory. * @param hookFactory the resolver hook factory diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateDelta.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateDelta.java index 87785e670..7c82e295a 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateDelta.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateDelta.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -30,11 +30,11 @@ public interface StateDelta { /** * Returns an array of all the members - * of this delta which match the given flags. If an exact match is requested + * of this delta which match the given flags. If an exact match is requested * then only delta members whose type exactly matches the given mask are * included. Otherwise, all bundle deltas whose type's bit-wise and with the - * mask is non-zero are included. - * + * mask is non-zero are included. + * * @param mask match mask * @param exact whether exact match or bit-wise matching should be performed * @return an array of bundle deltas matching the given match criteria. diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateHelper.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateHelper.java index 3b5793913..9a91efa56 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateHelper.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateHelper.java @@ -14,7 +14,7 @@ package org.eclipse.osgi.service.resolver; /** - * A helper class that provides convenience methods for manipulating + * A helper class that provides convenience methods for manipulating * state objects. <code>PlatformAdmin</code> provides an access point * for a state helper. * <p> @@ -35,9 +35,9 @@ public interface StateHelper { public static int ACCESS_DISCOURAGED = 0x02; /** - * An option to include packages available from the execution environment when - * getting the visible packages of a bundle. For example, when running on a - * J2SE 1.4 VM the system bundle will export the javax.xml.parsers package as part of the + * An option to include packages available from the execution environment when + * getting the visible packages of a bundle. For example, when running on a + * J2SE 1.4 VM the system bundle will export the javax.xml.parsers package as part of the * execution environment. When this option is used then any packages from the execution * environment which the bundle is wired to will be included. * @see StateHelper#getVisiblePackages(BundleDescription, int) @@ -45,9 +45,9 @@ public interface StateHelper { public static int VISIBLE_INCLUDE_EE_PACKAGES = 0x01; /** - * An option to get all visible packages that a host bundle is currently wired to. This - * includes packages wired to as a result of a dynamic import and packages wired to as a - * result of additional constraints specified by a fragment bundle. Using this option + * An option to get all visible packages that a host bundle is currently wired to. This + * includes packages wired to as a result of a dynamic import and packages wired to as a + * result of additional constraints specified by a fragment bundle. Using this option * with a fragment will cause an empty array to be returned. * @see StateHelper#getVisiblePackages(BundleDescription, int) * @since 3.6 @@ -57,7 +57,7 @@ public interface StateHelper { /** * Returns all bundles in the state depending on the given bundles. The given bundles * appear in the returned array. - * + * * @param bundles the initial set of bundles * @return an array containing bundle descriptions for the given roots and all * bundles in the state that depend on them @@ -75,26 +75,26 @@ public interface StateHelper { public BundleDescription[] getPrerequisites(BundleDescription[] bundles); /** - * Returns all unsatisfied constraints in the given bundle. Returns an + * Returns all unsatisfied constraints in the given bundle. Returns an * empty array if no unsatisfied constraints can be found. * <p> - * Note that a bundle may have no unsatisfied constraints and still not be + * Note that a bundle may have no unsatisfied constraints and still not be * resolved. - * </p> - * + * </p> + * * @param bundle the bundle to examine * @return an array containing all unsatisfied constraints for the given bundle */ public VersionConstraint[] getUnsatisfiedConstraints(BundleDescription bundle); /** - * Returns all unsatisfied constraints in the given bundles that have no possible supplier. + * Returns all unsatisfied constraints in the given bundles that have no possible supplier. * Returns an empty array if no unsatisfied leaf constraints can be found. * <p> - * The returned constraints include only the unsatisfied constraints in the given - * state that have no possible supplier (leaf constraints). There may - * be additional unsatisfied constraints in the given bundles but these will have at - * least one possible supplier. In this case the possible supplier of the constraint + * The returned constraints include only the unsatisfied constraints in the given + * state that have no possible supplier (leaf constraints). There may + * be additional unsatisfied constraints in the given bundles but these will have at + * least one possible supplier. In this case the possible supplier of the constraint * is not resolved for some reason. For example, a given state only has Bundles X and Y * installed and Bundles X and Y have the following constraints: * </p> @@ -102,16 +102,16 @@ public interface StateHelper { * Bundle X requires Bundle Y * Bundle Y requires Bundle Z</pre> * <p> - * In this case Bundle Y has an unsatisfied constraint leaf on Bundle Z. This will - * cause Bundle X's constraint on Bundle Y to be unsatisfied as well because the - * bundles are involved in a dependency chain. Bundle X's constraint on Bundle Y is + * In this case Bundle Y has an unsatisfied constraint leaf on Bundle Z. This will + * cause Bundle X's constraint on Bundle Y to be unsatisfied as well because the + * bundles are involved in a dependency chain. Bundle X's constraint on Bundle Y is * not considered a leaf because there is a possible supplier Y in the given state. * </p> * <p> - * Note that a bundle may have no unsatisfied constraints and still not be + * Note that a bundle may have no unsatisfied constraints and still not be * resolved. - * </p> - * + * </p> + * * @param bundles the bundles to examine * @return an array containing all unsatisfied leaf constraints for the given bundles * @since 3.2 @@ -119,56 +119,56 @@ public interface StateHelper { public VersionConstraint[] getUnsatisfiedLeaves(BundleDescription[] bundles); /** - * Returns whether the given package specification constraint is resolvable. - * A package specification constraint may be + * Returns whether the given package specification constraint is resolvable. + * A package specification constraint may be * resolvable but not resolved, which means that the bundle that provides - * it has not been resolved for some other reason (e.g. another constraint + * it has not been resolved for some other reason (e.g. another constraint * could not be resolved, another version has been picked, etc). - * + * * @param specification the package specification constraint to be examined - * @return <code>true</code> if the constraint can be resolved, + * @return <code>true</code> if the constraint can be resolved, * <code>false</code> otherwise */ public boolean isResolvable(ImportPackageSpecification specification); /** - * Returns whether the given bundle specification constraint is resolvable. - * A bundle specification constraint may be + * Returns whether the given bundle specification constraint is resolvable. + * A bundle specification constraint may be * resolvable but not resolved, which means that the bundle that provides - * it has not been resolved for some other reason (e.g. another constraint + * it has not been resolved for some other reason (e.g. another constraint * could not be resolved, another version has been picked, etc). - * + * * @param specification the bundle specification constraint to be examined - * @return <code>true</code> if the constraint can be resolved, + * @return <code>true</code> if the constraint can be resolved, * <code>false</code> otherwise */ public boolean isResolvable(BundleSpecification specification); /** - * Returns whether the given host specification constraint is resolvable. - * A host specification constraint may be + * Returns whether the given host specification constraint is resolvable. + * A host specification constraint may be * resolvable but not resolved, which means that the bundle that provides - * it has not been resolved for some other reason (e.g. another constraint + * it has not been resolved for some other reason (e.g. another constraint * could not be resolved, another version has been picked, etc). - * + * * @param specification the host specification constraint to be examined - * @return <code>true</code> if the constraint can be resolved, + * @return <code>true</code> if the constraint can be resolved, * <code>false</code> otherwise */ public boolean isResolvable(HostSpecification specification); /** - * Sorts the given array of <strong>resolved</strong> bundles in pre-requisite order. If A - * requires B, A appears after B. - * Fragments will appear after all of their hosts. Constraints contributed by fragments will + * Sorts the given array of <strong>resolved</strong> bundles in pre-requisite order. If A + * requires B, A appears after B. + * Fragments will appear after all of their hosts. Constraints contributed by fragments will * be treated as if contributed by theirs hosts, affecting their position. This is true even if * the fragment does not appear in the given bundle array. * <p> * Unresolved bundles are ignored. * </p> - * + * * @param toSort an array of bundles to be sorted - * @return any cycles found + * @return any cycles found */ public Object[][] sortBundles(BundleDescription[] toSort); @@ -187,11 +187,11 @@ public interface StateHelper { /** * Returns a list of all packages that the specified bundle has access to which are * exported by other bundles. This takes into account all constraint specifications - * (Import-Package, Require-Bundle etc). A deep dependency search is done for all - * packages which are available through the required bundles and any bundles which + * (Import-Package, Require-Bundle etc). A deep dependency search is done for all + * packages which are available through the required bundles and any bundles which * are reexported. This method also takes into account all directives * which may be specified on the constraint specifications (e.g. uses, x-friends etc.) - * + * * @param bundle a bundle to get the list of packages for. * @param options the options for selecting the visible packages * @return a list of all packages that the specified bundle has access to which are @@ -203,7 +203,7 @@ public interface StateHelper { public ExportPackageDescription[] getVisiblePackages(BundleDescription bundle, int options); /** - * Returns the access code that the specified <code>BundleDescription</code> has to the + * Returns the access code that the specified <code>BundleDescription</code> has to the * specified <code>ExportPackageDescription</code>. * @param bundle the bundle to find the access code for * @param export the export to find the access code for diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateObjectFactory.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateObjectFactory.java index 7b685e1fe..54dd40383 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateObjectFactory.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateObjectFactory.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -27,7 +27,7 @@ import org.osgi.framework.InvalidSyntaxException; import org.osgi.framework.Version; /** - * A factory for states and their component objects. + * A factory for states and their component objects. * <p> * This interface is not intended to be implemented by clients. * </p> @@ -44,9 +44,9 @@ public interface StateObjectFactory { public static final StateObjectFactory defaultFactory = new StateObjectFactoryProxy(); /** - * Creates an empty state. The returned state does not have an + * Creates an empty state. The returned state does not have an * attached resolver. - * + * * @return the created state * @deprecated use {@link #createState(boolean) } */ @@ -54,7 +54,7 @@ public interface StateObjectFactory { /** * Creates an empty state with or without a resolver. - * + * * @param resolver true if the created state should be initialized with a resolver. * @return the created state * @since 3.2 @@ -62,12 +62,12 @@ public interface StateObjectFactory { public State createState(boolean resolver); /** - * Creates a new state that is a copy of the given state. The returned state + * Creates a new state that is a copy of the given state. The returned state * will contain copies of all bundle descriptions in the given state. * The user objects from the original bundle descriptions is not copied and - * no data pertaining to resolution is copied. The returned state will have a + * no data pertaining to resolution is copied. The returned state will have a * new resolver attached to it. - * + * * @param state a state to be copied * @return the created state */ @@ -75,21 +75,21 @@ public interface StateObjectFactory { /** * Creates a bundle description from the given parameters. - * - * @param id id for the bundle - * @param symbolicName symbolic name for the bundle (may be - * <code>null</code>) + * + * @param id id for the bundle + * @param symbolicName symbolic name for the bundle (may be + * <code>null</code>) * @param version version for the bundle (may be <code>null</code>) * @param location location for the bundle (may be <code>null</code>) - * @param required version constraints for all required bundles (may be + * @param required version constraints for all required bundles (may be * <code>null</code>) - * @param host version constraint specifying the host for the bundle to be + * @param host version constraint specifying the host for the bundle to be * created. Should be <code>null</code> if the bundle is not a fragment - * @param imports version constraints for all packages imported + * @param imports version constraints for all packages imported * (may be <code>null</code>) * @param exports package descriptions of all the exported packages * (may be <code>null</code>) - * @param providedPackages the list of provided packages (may be <code>null</code>) + * @param providedPackages the list of provided packages (may be <code>null</code>) * @param singleton whether the bundle created should be a singleton * @return the created bundle description * @deprecated use {@link #createBundleDescription(long, String, Version, String, BundleSpecification[], HostSpecification, ImportPackageSpecification[], ExportPackageDescription[], boolean, boolean, boolean, String, String[], GenericSpecification[], GenericDescription[])} @@ -98,21 +98,21 @@ public interface StateObjectFactory { /** * Creates a bundle description from the given parameters. - * - * @param id id for the bundle - * @param symbolicName symbolic name for the bundle (may be - * <code>null</code>) + * + * @param id id for the bundle + * @param symbolicName symbolic name for the bundle (may be + * <code>null</code>) * @param version version for the bundle (may be <code>null</code>) * @param location location for the bundle (may be <code>null</code>) - * @param required version constraints for all required bundles (may be + * @param required version constraints for all required bundles (may be * <code>null</code>) - * @param host version constraint specifying the host for the bundle to be + * @param host version constraint specifying the host for the bundle to be * created. Should be <code>null</code> if the bundle is not a fragment - * @param imports version constraints for all packages imported + * @param imports version constraints for all packages imported * (may be <code>null</code>) * @param exports package descriptions of all the exported packages * (may be <code>null</code>) - * @param providedPackages the list of provided packages (may be <code>null</code>) + * @param providedPackages the list of provided packages (may be <code>null</code>) * @param singleton whether the bundle created should be a singleton * @param attachFragments whether the bundle allows fragments to attach * @param dynamicFragments whether the bundle allows fragments to dynamically attach @@ -127,9 +127,9 @@ public interface StateObjectFactory { /** * Creates a bundle description from the given parameters. - * - * @param id id for the bundle - * @param symbolicName symbolic name for the bundle (may be <code>null</code>) + * + * @param id id for the bundle + * @param symbolicName symbolic name for the bundle (may be <code>null</code>) * @param version version for the bundle (may be <code>null</code>) * @param location location for the bundle (may be <code>null</code>) * @param required version constraints for all required bundles (may be <code>null</code>) @@ -149,9 +149,9 @@ public interface StateObjectFactory { /** * Creates a bundle description from the given parameters. - * - * @param id id for the bundle - * @param symbolicName symbolic name for the bundle (may be <code>null</code>) + * + * @param id id for the bundle + * @param symbolicName symbolic name for the bundle (may be <code>null</code>) * @param version version for the bundle (may be <code>null</code>) * @param location location for the bundle (may be <code>null</code>) * @param required version constraints for all required bundles (may be <code>null</code>) @@ -174,7 +174,7 @@ public interface StateObjectFactory { /** * Creates a bundle description from the given parameters. * - * @param id id for the bundle + * @param id id for the bundle * @param symbolicName the symbolic name of the bundle. This may include directives and/or attributes encoded using the Bundle-SymbolicName header. * @param version version for the bundle (may be <code>null</code>) * @param location location for the bundle (may be <code>null</code>) @@ -194,28 +194,28 @@ public interface StateObjectFactory { /** * Returns a bundle description based on the information in the supplied manifest dictionary. - * The manifest should contain String keys and String values which correspond to + * The manifest should contain String keys and String values which correspond to * proper OSGi manifest headers and values. - * + * * @param state the state for which the description is being created * @param manifest a collection of OSGi manifest headers and values * @param location the URL location of the bundle (may be <code>null</code>) * @param id the id of the bundle * @return a bundle description derived from the given information - * @throws BundleException if an error occurs while reading the manifest + * @throws BundleException if an error occurs while reading the manifest */ public BundleDescription createBundleDescription(State state, Dictionary<String, String> manifest, String location, long id) throws BundleException; /** * Returns a bundle description based on the information in the supplied manifest dictionary. - * The manifest should contain String keys and String values which correspond to + * The manifest should contain String keys and String values which correspond to * proper OSGi manifest headers and values. - * + * * @param manifest a collection of OSGi manifest headers and values * @param location the URL location of the bundle (may be <code>null</code>) * @param id the id of the bundle * @return a bundle description derived from the given information - * @throws BundleException if an error occurs while reading the manifest + * @throws BundleException if an error occurs while reading the manifest * @deprecated use {@link #createBundleDescription(State, Dictionary, String, long)} */ public BundleDescription createBundleDescription(Dictionary<String, String> manifest, String location, long id) throws BundleException; @@ -223,7 +223,7 @@ public interface StateObjectFactory { /** * Creates a bundle description that is a copy of the given description. * The user object of the original bundle description is not copied. - * + * * @param original the bundle description to be copied * @return the created bundle description */ @@ -231,10 +231,10 @@ public interface StateObjectFactory { /** * Creates a bundle specification from the given parameters. - * + * * @param requiredSymbolicName the symbolic name for the required bundle * @param requiredVersionRange the required version range (may be <code>null</code>) - * @param export whether the required bundle should be re-exported + * @param export whether the required bundle should be re-exported * @param optional whether the constraint should be optional * @return the created bundle specification * @see VersionConstraint for information on the available match rules @@ -243,7 +243,7 @@ public interface StateObjectFactory { /** * Creates a bundle specification that is a copy of the given constraint. - * + * * @param original the constraint to be copied * @return the created bundle specification */ @@ -260,11 +260,11 @@ public interface StateObjectFactory { /** * Creates a host specification from the given parameters. - * + * * @param hostSymbolicName the symbolic name for the host bundle * @param hostVersionRange the version range for the host bundle (may be <code>null</code>) * @return the created host specification - * @see VersionConstraint for information on the available match rules + * @see VersionConstraint for information on the available match rules */ public HostSpecification createHostSpecification(String hostSymbolicName, VersionRange hostVersionRange); @@ -279,7 +279,7 @@ public interface StateObjectFactory { /** * Creates a host specification that is a copy of the given constraint. - * + * * @param original the constraint to be copied * @return the created host specification */ @@ -287,7 +287,7 @@ public interface StateObjectFactory { /** * Creates an import package specification from the given parameters. - * + * * @param packageName the package name * @param versionRange the package versionRange (may be <code>null</code>). * @param bundleSymbolicName the Bundle-SymbolicName of the bundle that must export the package (may be <code>null</code>) @@ -302,7 +302,7 @@ public interface StateObjectFactory { /** * Creates an import package specification that is a copy of the given import package * @param original the import package to be copied - * @return the created package specification + * @return the created package specification */ public ImportPackageSpecification createImportPackageSpecification(ImportPackageSpecification original); @@ -319,7 +319,7 @@ public interface StateObjectFactory { * Used by the Resolver to dynamically create ExportPackageDescription objects during the resolution process. * The Resolver needs to create ExportPackageDescriptions dynamically for a host when a fragment. * exports a package<p> - * + * * @param packageName the package name * @param version the version of the package (may be <code>null</code>) * @param directives the directives for the package (may be <code>null</code>) @@ -423,12 +423,12 @@ public interface StateObjectFactory { /** * Persists the given state in the given output stream. Closes the stream. - * + * * @param state the state to be written * @param stream the stream where to write the state to - * @throws IOException if an IOException happens while writing the state to + * @throws IOException if an IOException happens while writing the state to * the stream - * @throws IllegalArgumentException if the state provided was not created by + * @throws IllegalArgumentException if the state provided was not created by * this factory * @deprecated use {@link #writeState(State, File)} instead * @since 3.1 @@ -437,12 +437,12 @@ public interface StateObjectFactory { /** * Persists the given state in the given output stream. Closes the stream. - * + * * @param state the state to be written * @param stream the stream where to write the state to - * @throws IOException if an IOException happens while writing the state to + * @throws IOException if an IOException happens while writing the state to * the stream - * @throws IllegalArgumentException if the state provided was not created by + * @throws IllegalArgumentException if the state provided was not created by * this factory * @deprecated use {@link #writeState(State, File)} instead * @see #writeState(State, OutputStream) @@ -451,22 +451,22 @@ public interface StateObjectFactory { /** * Persists the given state in the given directory. - * + * * @param state the state to be written * @param stateDirectory the directory where to write the state to - * @throws IOException if an IOException happens while writing the state to + * @throws IOException if an IOException happens while writing the state to * the stream - * @throws IllegalArgumentException if the state provided was not created by + * @throws IllegalArgumentException if the state provided was not created by * this factory */ public void writeState(State state, File stateDirectory) throws IOException; /** * Reads a persisted state from the given stream. Closes the stream. - * + * * @param stream the stream where to read the state from * @return the state read - * @throws IOException if an IOException happens while reading the state from + * @throws IOException if an IOException happens while reading the state from * the stream * @deprecated use {@link #readState(File)} instead * @since 3.1 @@ -475,10 +475,10 @@ public interface StateObjectFactory { /** * Reads a persisted state from the given stream. Closes the stream. - * + * * @param stream the stream where to read the state from * @return the state read - * @throws IOException if an IOException happens while reading the state from + * @throws IOException if an IOException happens while reading the state from * the stream * @deprecated use {@link #readState(File)} instead * @see #readState(InputStream) @@ -487,10 +487,10 @@ public interface StateObjectFactory { /** * Reads a persisted state from the given directory. - * + * * @param stateDirectory the directory where to read the state from * @return the state read - * @throws IOException if an IOException happens while reading the state from + * @throws IOException if an IOException happens while reading the state from * the stream */ public State readState(File stateDirectory) throws IOException; diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateWire.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateWire.java index 181ca59d2..8a2057af0 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateWire.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/StateWire.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -18,7 +18,7 @@ package org.eclipse.osgi.service.resolver; * There are 4 parts to a state wire. * <ul> * <li>The requirement which may have been specified by a host bundle or one of its attached fragments.</li> - * <li>The host bundle which is associated with the requirement. There are cases where the host + * <li>The host bundle which is associated with the requirement. There are cases where the host * bundle may not be the same as the bundle which declared the requirement. For example, if a fragment * specifies additional requirements.</li> * <li>The capability which may have been specified by a host bundle or one of its attached fragments.</li> diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/VersionConstraint.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/VersionConstraint.java index a84fbe13b..799a506cc 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/VersionConstraint.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/VersionConstraint.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -16,7 +16,7 @@ package org.eclipse.osgi.service.resolver; import org.osgi.framework.wiring.BundleRequirement; /** - * VersionConstraints represent the relationship between two bundles (in the + * VersionConstraints represent the relationship between two bundles (in the * case of bundle requires) or a bundle and a package (in the case of import/export). * <p> * This interface is not intended to be implemented by clients. The @@ -29,7 +29,7 @@ public interface VersionConstraint extends Cloneable { /** * Returns this constraint's name. - * + * * @return this constraint's name */ public String getName(); @@ -42,16 +42,16 @@ public interface VersionConstraint extends Cloneable { /** * Returns the bundle that declares this constraint. - * + * * @return a bundle description */ public BundleDescription getBundle(); /** - * Returns whether this constraint is resolved. A resolved constraint - * is guaranteed to have its supplier defined. - * - * @return <code>true</code> if this bundle is resolved, <code>false</code> + * Returns whether this constraint is resolved. A resolved constraint + * is guaranteed to have its supplier defined. + * + * @return <code>true</code> if this bundle is resolved, <code>false</code> * otherwise */ public boolean isResolved(); @@ -60,25 +60,25 @@ public interface VersionConstraint extends Cloneable { * Returns whether this constraint could be satisfied by the given supplier. * This will depend on the suppliers different attributes including its name, * versions and other arbitrary attributes - * - * @param supplier a supplier to be tested against this constraint (may be + * + * @param supplier a supplier to be tested against this constraint (may be * <code>null</code>) - * @return <code>true</code> if this constraint could be resolved using the supplier, - * <code>false</code> otherwise + * @return <code>true</code> if this constraint could be resolved using the supplier, + * <code>false</code> otherwise */ public boolean isSatisfiedBy(BaseDescription supplier); /** * Returns the supplier that satisfies this constraint, if it is resolved. - * - * @return a supplier, or <code>null</code> + * + * @return a supplier, or <code>null</code> * @see #isResolved() */ public BaseDescription getSupplier(); /** * Returns the requirement represented by this constraint. - * Some constraint types may not be able to represent + * Some constraint types may not be able to represent * a requirement. In such cases <code>null</code> is * returned. * @return the requirement represented by this constraint @@ -87,9 +87,9 @@ public interface VersionConstraint extends Cloneable { public BundleRequirement getRequirement(); /** - * Returns the user object associated to this constraint, or + * Returns the user object associated to this constraint, or * <code>null</code> if none exists. - * + * * @return the user object associated to this constraint, * or <code>null</code> * @since 3.8 @@ -98,11 +98,11 @@ public interface VersionConstraint extends Cloneable { /** * Associates a user-provided object to this constraint, or - * removes an existing association, if <code>null</code> is provided. The - * provided object is not interpreted in any ways by this + * removes an existing association, if <code>null</code> is provided. The + * provided object is not interpreted in any ways by this * constrain. - * - * @param userObject an arbitrary object provided by the user, or + * + * @param userObject an arbitrary object provided by the user, or * <code>null</code> * @since 3.8 */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/VersionRange.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/VersionRange.java index ec61c4088..d2dfe0b3c 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/VersionRange.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/VersionRange.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -39,7 +39,7 @@ public class VersionRange extends org.osgi.framework.VersionRange { * then {@link Version#emptyVersion} is used. * @param maxVersion the maximum version of the range. If <code>null</code> * then new Version(Integer.MAX_VALUE, Integer.MAX_VALUE, Integer.MAX_VALUE) - * is used. + * is used. */ public VersionRange(Version minVersion, boolean includeMin, Version maxVersion, boolean includeMax) { super(includeMin ? INCLUDE_MIN : EXCLUDE_MIN, minVersion == null ? Version.emptyVersion : minVersion, versionMax.equals(maxVersion) ? null : maxVersion, includeMax ? INCLUDE_MAX : EXCLUDE_MAX); @@ -47,7 +47,7 @@ public class VersionRange extends org.osgi.framework.VersionRange { /** * Creates a version range from the specified string. - * + * * <p> * Here is the grammar for version range strings. * </p> @@ -62,7 +62,7 @@ public class VersionRange extends org.osgi.framework.VersionRange { * include-max ::= ']' * exclude-max ::= ')' * </pre> - * + * * @param versionRange string representation of the version range or <code>null</code> * for the empty range "0.0.0" * @see Version#Version(String) definition of <code>version</code> @@ -92,7 +92,7 @@ public class VersionRange extends org.osgi.framework.VersionRange { * Returns the maximum Version of this VersionRange. * <p> * This method is deprecated. For ranges that have no maximum this method - * incorrectly returns a version equal to + * incorrectly returns a version equal to * <code>Version(Integer.MAX_VALUE, Integer.MAX_VALUE, Integer.MAX_VALUE)</code>. * Use {@link org.osgi.framework.VersionRange#getRight()} instead. * @return the maximum Version of this VersionRange @@ -116,11 +116,11 @@ public class VersionRange extends org.osgi.framework.VersionRange { * Returns whether the given version is included in this VersionRange. * This will depend on the minimum and maximum versions of this VersionRange * and the given version. - * - * @param version a version to be tested for inclusion in this VersionRange. + * + * @param version a version to be tested for inclusion in this VersionRange. * If <code>null</code> then {@link Version#emptyVersion} is used. - * @return <code>true</code> if the version is included, - * <code>false</code> otherwise + * @return <code>true</code> if the version is included, + * <code>false</code> otherwise */ public boolean isIncluded(Version version) { if (version == null) diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/security/TrustEngine.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/security/TrustEngine.java index fd9453949..b905b8f51 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/security/TrustEngine.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/security/TrustEngine.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -19,7 +19,7 @@ import java.security.cert.Certificate; import org.eclipse.osgi.internal.signedcontent.TrustEngineListener; /** - * A <code>TrustEngine</code> is used to establish the authenticity of a + * A <code>TrustEngine</code> is used to establish the authenticity of a * {@link Certificate} chain. * <p> * Clients may implement this interface. @@ -29,7 +29,7 @@ import org.eclipse.osgi.internal.signedcontent.TrustEngineListener; public abstract class TrustEngine { /** * Returns the certificate trust anchor contained in the specified chain which - * was used to establish the authenticity of the chain. If no + * was used to establish the authenticity of the chain. If no * trust anchor is found in the chain then <code>null</code> is returned. * @param chain - a complete or incomplete certificate chain, implementations *MAY* complete chains * @return - the certificate trust anchor used to establish authenticity @@ -38,7 +38,7 @@ public abstract class TrustEngine { public abstract Certificate findTrustAnchor(Certificate[] chain) throws IOException; /** - * Add a trust anchor point to this trust engine. A trust anchor implies that a certificate, + * Add a trust anchor point to this trust engine. A trust anchor implies that a certificate, * and any of its children, is to be considered trusted. If <code>null</code> is used * as the alias then an alias will be generated based on the trust anchor certificate. * @param anchor - the certificate to add as an anchor point @@ -58,7 +58,7 @@ public abstract class TrustEngine { } /** - * Add a trust anchor point to this trust engine. A trust anchor implies that a certificate, + * Add a trust anchor point to this trust engine. A trust anchor implies that a certificate, * and any of its children, is to be considered trusted. If <code>null</code> is used * as the alias then an alias will be generated based on the trust anchor certificate. * @param anchor - the certificate to add as an anchor point @@ -118,7 +118,7 @@ public abstract class TrustEngine { /** * Return the certificate associated with the unique "friendly name" in the engine. - * @param alias - the friendly name + * @param alias - the friendly name * @return the associated trust anchor * @throws IOException if there is a problem connecting to the backing store * @throws GeneralSecurityException if there is a certificate problem @@ -135,14 +135,14 @@ public abstract class TrustEngine { /** * Return a value indicate whether this trust engine is read-only. - * + * * @return true if this trust engine is read-only false otherwise. */ public abstract boolean isReadOnly(); /** * Return a representation string of this trust engine - * + * * @return a string */ public abstract String getName(); |