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 | |
| 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')
201 files changed, 1278 insertions, 1278 deletions
diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/adaptor/EclipseStarter.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/adaptor/EclipseStarter.java index d3d81e0ca..7b41681b4 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/adaptor/EclipseStarter.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/adaptor/EclipseStarter.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 * Alex Blewitt (bug 172969) @@ -53,16 +53,16 @@ import org.osgi.resource.Resource; import org.osgi.util.tracker.ServiceTracker; /** - * Special startup class for the Eclipse Platform. This class cannot be - * instantiated; all functionality is provided by static methods. + * Special startup class for the Eclipse Platform. This class cannot be + * instantiated; all functionality is provided by static methods. * <p> - * The Eclipse Platform makes heavy use of Java class loaders for loading + * The Eclipse Platform makes heavy use of Java class loaders for loading * plug-ins. Even the Eclipse Runtime itself and the OSGi framework need - * to be loaded by special class loaders. The upshot is that a - * client program (such as a Java main program, a servlet) cannot - * reference any part of Eclipse directly. Instead, a client must use this - * loader class to start the platform, invoking functionality defined - * in plug-ins, and shutting down the platform when done. + * to be loaded by special class loaders. The upshot is that a + * client program (such as a Java main program, a servlet) cannot + * reference any part of Eclipse directly. Instead, a client must use this + * loader class to start the platform, invoking functionality defined + * in plug-ins, and shutting down the platform when done. * </p> * <p>Note that the fields on this class are not API. </p> * @since 3.0 @@ -89,12 +89,12 @@ public class EclipseStarter { private static final String ARCH = "-arch"; //$NON-NLS-1$ private static final String NL = "-nl"; //$NON-NLS-1$ private static final String NL_EXTENSIONS = "-nlExtensions"; //$NON-NLS-1$ - private static final String CONFIGURATION = "-configuration"; //$NON-NLS-1$ + private static final String CONFIGURATION = "-configuration"; //$NON-NLS-1$ private static final String USER = "-user"; //$NON-NLS-1$ private static final String NOEXIT = "-noExit"; //$NON-NLS-1$ private static final String LAUNCHER = "-launcher"; //$NON-NLS-1$ - // this is more of an Eclipse argument but this OSGi implementation stores its + // this is more of an Eclipse argument but this OSGi implementation stores its // metadata alongside Eclipse's. private static final String DATA = "-data"; //$NON-NLS-1$ @@ -232,13 +232,13 @@ public class EclipseStarter { /** * Launches the platform and runs a single application. The application is either identified - * in the given arguments (e.g., -application <app id>) or in the <code>eclipse.application</code> - * System property. This convenience method starts - * up the platform, runs the indicated application, and then shuts down the - * platform. The platform must not be running already. - * + * in the given arguments (e.g., -application <app id>) or in the <code>eclipse.application</code> + * System property. This convenience method starts + * up the platform, runs the indicated application, and then shuts down the + * platform. The platform must not be running already. + * * @param args the command line-style arguments used to configure the platform - * @param endSplashHandler the block of code to run to tear down the splash + * @param endSplashHandler the block of code to run to tear down the splash * screen or <code>null</code> if no tear down is required * @return the result of running the application * @throws Exception if anything goes wrong @@ -300,7 +300,7 @@ public class EclipseStarter { /** * Starts the platform and sets it up to run a single application. The application is either identified * in the given arguments (e.g., -application <app id>) or in the <code>eclipse.application</code> - * System property. The platform must not be running already. + * System property. The platform must not be running already. * <p> * The given runnable (if not <code>null</code>) is used to tear down the splash screen if required. * </p> @@ -371,8 +371,8 @@ public class EclipseStarter { } /** - * Runs the application for which the platform was started. The platform - * must be running. + * Runs the application for which the platform was started. The platform + * must be running. * <p> * The given argument is passed to the application being run. If it is <code>null</code> * then the command line arguments used in starting the platform, and not consumed @@ -395,8 +395,8 @@ public class EclipseStarter { // create the ApplicationLauncher and register it as a service appLauncher = new EclipseAppLauncher(context, Boolean.parseBoolean(getProperty(PROP_ALLOW_APPRELAUNCH)), launchDefault, log, equinoxConfig); appLauncherRegistration = context.registerService(ApplicationLauncher.class.getName(), appLauncher, null); - // must start the launcher AFTER service restration because this method - // blocks and runs the application on the current thread. This method + // must start the launcher AFTER service restration because this method + // blocks and runs the application on the current thread. This method // will return only after the application has stopped. return appLauncher.start(argument); } @@ -415,19 +415,19 @@ public class EclipseStarter { } /** - * Shuts down the Platform. The state of the Platform is not automatically - * saved before shutting down. + * Shuts down the Platform. The state of the Platform is not automatically + * saved before shutting down. * <p> - * On return, the Platform will no longer be running (but could be re-launched + * On return, the Platform will no longer be running (but could be re-launched * with another call to startup). If relaunching, care must be taken to reinitialize * any System properties which the platform uses (e.g., osgi.instance.area) as - * some policies in the platform do not allow resetting of such properties on + * some policies in the platform do not allow resetting of such properties on * subsequent runs. * </p><p> - * Any objects handed out by running Platform, - * including Platform runnables obtained via getRunnable, will be - * permanently invalid. The effects of attempting to invoke methods - * on invalid objects is undefined. + * Any objects handed out by running Platform, + * including Platform runnables obtained via getRunnable, will be + * permanently invalid. The effects of attempting to invoke methods + * on invalid objects is undefined. * </p> * @throws Exception if anything goes wrong */ @@ -516,8 +516,8 @@ public class EclipseStarter { url = createURL(new File(parent).toURL(), name); } catch (MalformedURLException e) { // TODO this is legacy support for non-URL names. It should be removed eventually. - // if name was not a URL then construct one. - // Assume it should be a reference and that it is relative. This support need not + // if name was not a URL then construct one. + // Assume it should be a reference and that it is relative. This support need not // be robust as it is temporary.. File child = new File(name); fileLocation = child.isAbsolute() ? child : new File(parent, name); @@ -543,7 +543,7 @@ public class EclipseStarter { if (!fileLocation.isAbsolute()) fileLocation = new File(parent, fileLocation.toString()); } - // If the result is a reference then search for the real result and + // If the result is a reference then search for the real result and // reconstruct the answer. if (reference) { String result = searchFor(fileLocation.getName(), new File(fileLocation.getParent()).getAbsolutePath()); @@ -553,7 +553,7 @@ public class EclipseStarter { return null; } - // finally we have something worth trying + // finally we have something worth trying try { URLConnection result = LocationHelper.getConnection(url); result.connect(); @@ -567,7 +567,7 @@ public class EclipseStarter { /* * Ensure all basic bundles are installed, resolved and scheduled to start. Returns an array containing - * all basic bundles that are marked to start. + * all basic bundles that are marked to start. * Returns null if the framework has been shutdown as a result of refreshPackages */ private static Bundle[] loadBasicBundles() throws InterruptedException { @@ -586,7 +586,7 @@ public class EclipseStarter { // list of bundles to be refreshed List<Bundle> toRefresh = new ArrayList<>(curInitBundles.length); - // uninstall any of the currently installed bundles that do not exist in the + // uninstall any of the currently installed bundles that do not exist in the // initial bundle list from installEntries. uninstallBundles(curInitBundles, initialBundles, toRefresh); @@ -705,7 +705,7 @@ public class EclipseStarter { // check for args without parameters (i.e., a flag arg) // check if debug should be enabled for the entire platform - // If this is the last arg or there is a following arg (i.e., arg+1 has a leading -), + // If this is the last arg or there is a following arg (i.e., arg+1 has a leading -), // simply enable debug. Otherwise, assume that that the following arg is // actually the filename of an options file. This will be processed below. if (args[i].equalsIgnoreCase(DEBUG) && ((i + 1 == args.length) || ((i + 1 < args.length) && (args[i + 1].startsWith("-"))))) { //$NON-NLS-1$ @@ -715,7 +715,7 @@ public class EclipseStarter { } // check if development mode should be enabled for the entire platform - // If this is the last arg or there is a following arg (i.e., arg+1 has a leading -), + // If this is the last arg or there is a following arg (i.e., arg+1 has a leading -), // simply enable development mode. Otherwise, assume that that the following arg is // actually some additional development time class path entries. This will be processed below. if (args[i].equalsIgnoreCase(DEV) && ((i + 1 == args.length) || ((i + 1 < args.length) && (args[i + 1].startsWith("-"))))) { //$NON-NLS-1$ @@ -741,7 +741,7 @@ public class EclipseStarter { found = true; } - // look for the console with no port. + // look for the console with no port. if (args[i].equalsIgnoreCase(CONSOLE) && ((i + 1 == args.length) || ((i + 1 < args.length) && (args[i + 1].startsWith("-"))))) { //$NON-NLS-1$ setProperty(PROP_CONSOLE, ""); //$NON-NLS-1$ found = true; @@ -763,25 +763,25 @@ public class EclipseStarter { } String arg = args[++i]; - // look for the console and port. + // look for the console and port. if (args[i - 1].equalsIgnoreCase(CONSOLE)) { setProperty(PROP_CONSOLE, arg); found = true; } - // look for the configuration location . + // look for the configuration location . if (args[i - 1].equalsIgnoreCase(CONFIGURATION)) { setProperty(EquinoxLocations.PROP_CONFIG_AREA, arg); found = true; } - // look for the data location for this instance. + // look for the data location for this instance. if (args[i - 1].equalsIgnoreCase(DATA)) { setProperty(EquinoxLocations.PROP_INSTANCE_AREA, arg); found = true; } - // look for the user location for this instance. + // look for the user location for this instance. if (args[i - 1].equalsIgnoreCase(USER)) { setProperty(EquinoxLocations.PROP_USER_AREA, arg); found = true; @@ -792,20 +792,20 @@ public class EclipseStarter { setProperty(EquinoxLocations.PROP_LAUNCHER, arg); found = true; } - // look for the development mode and class path entries. + // look for the development mode and class path entries. if (args[i - 1].equalsIgnoreCase(DEV)) { setProperty(PROP_DEV, arg); found = true; } - // look for the debug mode and option file location. + // look for the debug mode and option file location. if (args[i - 1].equalsIgnoreCase(DEBUG)) { setProperty(PROP_DEBUG, arg); debug = true; found = true; } - // look for the window system. + // look for the window system. if (args[i - 1].equalsIgnoreCase(WS)) { setProperty(PROP_WS, arg); found = true; @@ -835,7 +835,7 @@ public class EclipseStarter { found = true; } - // done checking for args. Remember where an arg was found + // done checking for args. Remember where an arg was found if (found) { configArgs[configArgIndex++] = i - 1; configArgs[configArgIndex++] = i; @@ -865,7 +865,7 @@ public class EclipseStarter { /** * Returns the result of converting a list of comma-separated tokens into an array - * + * * @return the array of string tokens * @param prop the initial comma-separated string */ @@ -1076,7 +1076,7 @@ public class EclipseStarter { /** * Returns a URL which is equivalent to the given URL relative to the * specified base URL. Works only for file: URLs - * @throws MalformedURLException + * @throws MalformedURLException */ private static URL makeRelative(URL base, URL location) throws MalformedURLException { if (base == null) @@ -1090,7 +1090,7 @@ public class EclipseStarter { if (!base.getProtocol().equals(nonReferenceLocation.getProtocol())) return location; File locationPath = new File(nonReferenceLocation.getPath()); - // if location is not absolute, return original location + // if location is not absolute, return original location if (!locationPath.isAbsolute()) return location; File relativePath = makeRelative(new File(base.getPath()), locationPath); @@ -1098,9 +1098,9 @@ public class EclipseStarter { if (File.separatorChar != '/') urlPath = urlPath.replace(File.separatorChar, '/'); if (nonReferenceLocation.getPath().endsWith("/")) //$NON-NLS-1$ - // restore original trailing slash + // restore original trailing slash urlPath += '/'; - // couldn't use File to create URL here because it prepends the path with user.dir + // couldn't use File to create URL here because it prepends the path with user.dir URL relativeURL = createURL(base.getProtocol(), base.getHost(), base.getPort(), urlPath); // now make it back to a reference URL relativeURL = createURL(REFERENCE_SCHEME + relativeURL.toExternalForm()); @@ -1205,9 +1205,9 @@ public class EclipseStarter { /** * Searches for the given target directory immediately under - * the given start location. If one is found then this location is returned; + * the given start location. If one is found then this location is returned; * otherwise an exception is thrown. - * + * * @return the location where target directory was found * @param start the location to begin searching */ @@ -1239,7 +1239,7 @@ public class EclipseStarter { continue; } // Note: directory with version suffix is always > than directory without version suffix - String version = candidateName.length() > target.length() + 1 && (versionSep == '_' || versionSep == '-') ? candidateName.substring(target.length() + 1) : ""; //$NON-NLS-1$ + String version = candidateName.length() > target.length() + 1 && (versionSep == '_' || versionSep == '-') ? candidateName.substring(target.length() + 1) : ""; //$NON-NLS-1$ Object[] currentVersion = getVersionElements(version); if (currentVersion != null && compareVersion(maxVersion, currentVersion) < 0) { File candidate = new File(start, candidateName); @@ -1263,7 +1263,7 @@ public class EclipseStarter { * with suitable defaults. * @return an array of size 4; first three elements are of type Integer (representing * major, minor and service) and the fourth element is of type String (representing - * qualifier). A value of null is returned if there are no valid Integers. Note, that + * qualifier). A value of null is returned if there are no valid Integers. Note, that * returning anything else will cause exceptions in the caller. */ private static Object[] getVersionElements(String version) { @@ -1291,7 +1291,7 @@ public class EclipseStarter { } /** - * Compares version strings. + * Compares version strings. * @return result of comparison, as integer; * <code><0</code> if left < right; * <code>0</code> if left == right; @@ -1330,12 +1330,12 @@ public class EclipseStarter { } /** - * Sets the initial properties for the platform. - * This method must be called before calling the {@link #run(String[], Runnable)} or - * {@link #startup(String[], Runnable)} methods for the properties to be used in - * a launched instance of the platform. + * Sets the initial properties for the platform. + * This method must be called before calling the {@link #run(String[], Runnable)} or + * {@link #startup(String[], Runnable)} methods for the properties to be used in + * a launched instance of the platform. * <p> - * If the specified properties contains a null value then the key for that value + * If the specified properties contains a null value then the key for that value * will be cleared from the properties of the platform. * </p> * @param initialProperties the initial properties to set for the platform. @@ -1353,7 +1353,7 @@ public class EclipseStarter { } /** - * Returns the context of the system bundle. A value of + * Returns the context of the system bundle. A value of * <code>null</code> is returned if the platform is not running. * @return the context of the system bundle * @throws java.lang.SecurityException If the caller does not have the @@ -1373,15 +1373,15 @@ public class EclipseStarter { /* * NOTE: This is an internal/experimental method used by launchers that need to react when the framework * is shutdown internally. - * + * * Adds a framework shutdown handler. <p> * A handler implements the {@link Runnable} interface. When the framework is shutdown - * the {@link Runnable#run()} method is called for each registered handler. Handlers should - * make no assumptions on the thread it is being called from. If a handler object is + * the {@link Runnable#run()} method is called for each registered handler. Handlers should + * make no assumptions on the thread it is being called from. If a handler object is * registered multiple times it will be called once for each registration. * <p> - * At the time a handler is called the framework is shutdown. Handlers must not depend on - * a running framework to execute or attempt to load additional classes from bundles + * At the time a handler is called the framework is shutdown. Handlers must not depend on + * a running framework to execute or attempt to load additional classes from bundles * installed in the framework. * @param handler the framework shutdown handler * @throws IllegalStateException if the platform is already running @@ -1399,7 +1399,7 @@ public class EclipseStarter { /* * NOTE: This is an internal/experimental method used by launchers that need to react when the framework * is shutdown internally. - * + * * Removes a framework shutdown handler. <p> * @param handler the framework shutdown handler * @throws IllegalStateException if the platform is already running diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/internal/adaptor/ConsoleManager.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/internal/adaptor/ConsoleManager.java index e7055df27..ef4a32087 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/internal/adaptor/ConsoleManager.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/internal/adaptor/ConsoleManager.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/core/runtime/internal/adaptor/DefaultStartupMonitor.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/internal/adaptor/DefaultStartupMonitor.java index 583ddd593..bad1d89e4 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/internal/adaptor/DefaultStartupMonitor.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/internal/adaptor/DefaultStartupMonitor.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * Andrew Niefer - IBM Corporation - initial API and implementation *******************************************************************************/ @@ -28,7 +28,7 @@ public class DefaultStartupMonitor implements StartupMonitor { /** * Create a new startup monitor using the given splash handler. The splash handle must * have an updateSplash method. - * + * * @param splashHandler * @throws IllegalStateException */ @@ -42,7 +42,7 @@ public class DefaultStartupMonitor implements StartupMonitor { //TODO maybe we could do something else in the update method in this case, like print something to the console? throw new IllegalStateException(e.getMessage(), e); } - + } /* (non-Javadoc) @@ -64,7 +64,7 @@ public class DefaultStartupMonitor implements StartupMonitor { @Override public void applicationRunning() { if (EclipseStarter.debug) { - String timeString = equinoxConfig.getConfiguration("eclipse.startTime"); //$NON-NLS-1$ + String timeString = equinoxConfig.getConfiguration("eclipse.startTime"); //$NON-NLS-1$ long time = timeString == null ? 0L : Long.parseLong(timeString); Debug.println("Application started in : " + (System.currentTimeMillis() - time) + "ms"); //$NON-NLS-1$ //$NON-NLS-2$ } diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/internal/adaptor/EclipseAppLauncher.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/internal/adaptor/EclipseAppLauncher.java index ffc771cc1..fef62dfc6 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/internal/adaptor/EclipseAppLauncher.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/internal/adaptor/EclipseAppLauncher.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 *******************************************************************************/ @@ -71,7 +71,7 @@ public class EclipseAppLauncher implements ApplicationLauncher { /* * Starts this application launcher on the current thread. This method - * should be called by the main thread to ensure that applications are + * should be called by the main thread to ensure that applications are * launched in the main thread. */ public Object start(Object defaultContext) throws Exception { @@ -128,9 +128,9 @@ public class EclipseAppLauncher implements ApplicationLauncher { // this must happen after we have acquired an application (by acquiring waitForAppLock above). runningLock.acquire(); if (EclipseStarter.debug) { - String timeString = equinoxConfig.getConfiguration("eclipse.startTime"); //$NON-NLS-1$ + String timeString = equinoxConfig.getConfiguration("eclipse.startTime"); //$NON-NLS-1$ long time = timeString == null ? 0L : Long.parseLong(timeString); - Debug.println("Starting application: " + (System.currentTimeMillis() - time)); //$NON-NLS-1$ + Debug.println("Starting application: " + (System.currentTimeMillis() - time)); //$NON-NLS-1$ } try { // run the actual application on the current thread (main). @@ -179,7 +179,7 @@ public class EclipseAppLauncher implements ApplicationLauncher { /* * Similar to the start method this method will restart the default method on current thread. - * This method assumes that the default application was launched at least once and that an ApplicationDescriptor + * This method assumes that the default application was launched at least once and that an ApplicationDescriptor * exists that can be used to relaunch the default application. */ public Object reStart(Object argument) throws Exception { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/Module.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/Module.java index 3e38958f4..8f9219471 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/Module.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/Module.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 *******************************************************************************/ @@ -44,7 +44,7 @@ public abstract class Module implements BundleReference, BundleStartLevel, Compa */ public static enum StartOptions { /** - * The module start operation is transient and the persistent + * The module start operation is transient and the persistent * autostart or activation policy setting of the module is not modified. */ TRANSIENT, @@ -87,7 +87,7 @@ public abstract class Module implements BundleReference, BundleStartLevel, Compa */ public static enum StopOptions { /** - * The module stop operation is transient and the persistent + * The module stop operation is transient and the persistent * autostart setting of the module is not modified. */ TRANSIENT; @@ -379,7 +379,7 @@ public abstract class Module implements BundleReference, BundleStartLevel, Compa } /** - * Returns the thread that currently owns the state change lock for this module, or + * Returns the thread that currently owns the state change lock for this module, or * <code>null</code> if not owned. * @return the owner, or <code>null</code> if not owned. */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleCapability.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleCapability.java index fb49562f9..0da9f66e5 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleCapability.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleCapability.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/container/ModuleCollisionHook.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleCollisionHook.java index ceccd8dd5..7f2193dcc 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleCollisionHook.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleCollisionHook.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 *******************************************************************************/ @@ -41,17 +41,17 @@ public interface ModuleCollisionHook { * <li> {@link #INSTALLING installing} - The target is the module associated * which is performing the install operation. The * collision candidate collection contains the existing modules installed - * which have a current revision with the same symbolic name and version as the + * which have a current revision with the same symbolic name and version as the * module being installed. - * <li> {@link #UPDATING updating} - The target is the module being updated. + * <li> {@link #UPDATING updating} - The target is the module being updated. * The collision candidate collection contains the existing modules installed which have - * a current revision with the same symbolic name and version as the content the target + * a current revision with the same symbolic name and version as the content the target * module is being updated to. * </ul> * This method can filter the collection of collision candidates by removing * potential collisions. For the specified operation to succeed, the * collection of collision candidates must be empty when this method returns. - * + * * @param operationType The operation type. Must be the value of * {@link #INSTALLING installing} or {@link #UPDATING updating}. * @param target The target module used to determine what collision diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleContainer.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleContainer.java index c248ff4e2..a45fafd7c 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleContainer.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleContainer.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 *******************************************************************************/ @@ -117,7 +117,7 @@ public final class ModuleContainer implements DebugOptionsListener { final ModuleContainerAdaptor adaptor; /** - * The module resolver which implements the ResolverContext and handles calling the + * The module resolver which implements the ResolverContext and handles calling the * resolver service. */ private final ModuleResolver moduleResolver; @@ -191,7 +191,7 @@ public final class ModuleContainer implements DebugOptionsListener { } /** - * Returns the module installed with the specified id, or null if no + * Returns the module installed with the specified id, or null if no * such module is installed. * @param id the id of the module * @return the module with the specified id, or null of no such module is installed. @@ -201,7 +201,7 @@ public final class ModuleContainer implements DebugOptionsListener { } /** - * Returns the module installed with the specified location, or null if no + * Returns the module installed with the specified location, or null if no * such module is installed. * @param location the location of the module * @return the module with the specified location, or null of no such module is installed. @@ -224,17 +224,17 @@ public final class ModuleContainer implements DebugOptionsListener { /** * Installs a new module using the specified location. The specified - * builder is used to create a new {@link ModuleRevision revision} + * builder is used to create a new {@link ModuleRevision revision} * which will become the {@link Module#getCurrentRevision() current} * revision of the new module. * <p> - * If a module already exists with the specified location then the + * If a module already exists with the specified location then the * existing module is returned and the builder is not used. * @param origin the module performing the install, may be {@code null}. - * @param location The location identifier of the module to install. + * @param location The location identifier of the module to install. * @param builder the builder used to create the revision to install. * @param revisionInfo the revision info for the new revision, may be {@code null}. - * @return a new module or a existing module if one exists at the + * @return a new module or a existing module if one exists at the * specified location. * @throws BundleException if some error occurs installing the module */ @@ -325,7 +325,7 @@ public final class ModuleContainer implements DebugOptionsListener { /** * Updates the specified module with a new revision. The specified - * builder is used to create a new {@link ModuleRevision revision} + * builder is used to create a new {@link ModuleRevision revision} * which will become the {@link Module#getCurrentRevision() current} * revision of the new module. * @param module the module to update @@ -481,7 +481,7 @@ public final class ModuleContainer implements DebugOptionsListener { * Attempts to resolve the current revisions of the specified modules. * @param triggers the modules to resolve or {@code null} to resolve all unresolved * current revisions. - * @param triggersMandatory true if the triggers must be resolved. This will result in + * @param triggersMandatory true if the triggers must be resolved. This will result in * a {@link ResolutionException} if set to true and one of the triggers could not be resolved. * @see FrameworkWiring#resolveBundles(Collection) * @return A resolution report for the resolve operation @@ -562,7 +562,7 @@ public final class ModuleContainer implements DebugOptionsListener { * Attempts to resolve the specified dynamic package name request for the specified revision. * @param dynamicPkgName the package name to attempt a dynamic resolution for * @param revision the module revision the dynamic resolution request is for - * @return the new resolution wire establishing a dynamic package resolution or null if + * @return the new resolution wire establishing a dynamic package resolution or null if * a dynamic wire could not be established. */ public ModuleWire resolveDynamic(String dynamicPkgName, ModuleRevision revision) { @@ -1141,8 +1141,8 @@ public final class ModuleContainer implements DebugOptionsListener { /** * Returns the dependency closure of for the specified modules. * @param initial The initial modules for which to generate the dependency closure - * @return A collection containing a snapshot of the dependency closure of the specified - * modules, or an empty collection if there were no specified modules. + * @return A collection containing a snapshot of the dependency closure of the specified + * modules, or an empty collection if there were no specified modules. */ public Collection<Module> getDependencyClosure(Collection<Module> initial) { moduleDatabase.readLock(); @@ -1164,11 +1164,11 @@ public final class ModuleContainer implements DebugOptionsListener { /** * Return the active start level value of this container. - * + * * If the container is in the process of changing the start level this * method must return the active start level if this differs from the * requested start level. - * + * * @return The active start level value of the Framework. */ public int getStartLevel() { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleContainerAdaptor.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleContainerAdaptor.java index df8838e76..5e067a82c 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleContainerAdaptor.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleContainerAdaptor.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 *******************************************************************************/ @@ -242,7 +242,7 @@ public abstract class ModuleContainerAdaptor { } /** - * This is called when a wiring is made invalid and allows the adaptor to react + * This is called when a wiring is made invalid and allows the adaptor to react * to this. This method is called while holding state change lock for the * module as well as for the module database. Care must be taken not to introduce * deadlock. @@ -256,7 +256,7 @@ public abstract class ModuleContainerAdaptor { /** * This is called if a request to refresh modules causes the system module * to be refreshed. This causes the system module to be stopped in a back - * ground thread. This method is called before the background thread is + * ground thread. This method is called before the background thread is * started to stop the system module. */ public void refreshedSystemModule() { @@ -303,7 +303,7 @@ public abstract class ModuleContainerAdaptor { } /** - * Returns the executor used to by the + * Returns the executor used to by the * {@link ModuleContainer#getFrameworkStartLevel() FrameworkStartLevel} implementation to * start bundles that have the same start level. This allows bundles to be * started in parallel. @@ -319,11 +319,11 @@ public abstract class ModuleContainerAdaptor { * call when a new module is {@link ModuleContainer#install(Module, String, ModuleRevisionBuilder, Object) installed} * into the container or when an existing module is {@link ModuleContainer#update(Module, ModuleRevisionBuilder, Object) updated} * with a new revision. The container does not call any methods on the builder before calling this method. - * @param operation The lifecycle operation event that is in progress using the supplied builder. + * @param operation The lifecycle operation event that is in progress using the supplied builder. * This will be either {@link ModuleEvent#INSTALLED installed} or {@link ModuleEvent#UPDATED updated}. * @param origin The module which originated the lifecycle operation. The origin may be {@code null} for * {@link ModuleEvent#INSTALLED installed} operations. This is the module - * passed to the {@link ModuleContainer#install(Module, String, ModuleRevisionBuilder, Object) install} or + * passed to the {@link ModuleContainer#install(Module, String, ModuleRevisionBuilder, Object) install} or * {@link ModuleContainer#update(Module, ModuleRevisionBuilder, Object) update} method. * @param builder the builder that will be used to create a new {@link ModuleRevision}. * @param revisionInfo the revision info that will be used for the new revision, may be {@code null}. diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleDatabase.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleDatabase.java index 1b27d8de2..e1af37150 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleDatabase.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleDatabase.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 *******************************************************************************/ @@ -59,7 +59,7 @@ import org.osgi.service.resolver.Resolver; * the wiring states. * <p> * <strong>Concurrent Semantics</strong><br /> - * + * * Implementations must be thread safe. The database allows for concurrent * read operations and all read operations are protected by the * {@link #readLock() read} lock. All write operations are @@ -72,7 +72,7 @@ import org.osgi.service.resolver.Resolver; * to upgrade from a read to a write lock. * <p> * A database is associated with a {@link ModuleContainer container}. The container - * associated with a database provides public API for manipulating the modules + * associated with a database provides public API for manipulating the modules * and their wiring states. For example, installing, updating, uninstalling, * resolving and unresolving modules. Except for the {@link #load(DataInputStream)}, * all other methods that perform write operations are intended to be used by @@ -481,13 +481,13 @@ public class ModuleDatabase { /** * Returns a cloned snapshot of the wirings of all revisions. This - * performs a clone of each {@link ModuleWiring}. The + * performs a clone of each {@link ModuleWiring}. The * {@link ModuleWiring#getRevision() revision}, * {@link ModuleWiring#getModuleCapabilities(String) capabilities}, * {@link ModuleWiring#getModuleRequirements(String) requirements}, * {@link ModuleWiring#getProvidedModuleWires(String) provided wires}, * {@link ModuleWiring#getRequiredModuleWires(String) required wires}, and - * {@link ModuleWiring#getSubstitutedNames()} of + * {@link ModuleWiring#getSubstitutedNames()} of * each wiring are copied into a cloned copy of the wiring. * <p> * The returned map of wirings may be safely read from while not holding @@ -813,7 +813,7 @@ public class ModuleDatabase { /** * Adds the {@link ModuleRevision#getModuleCapabilities(String) capabilities} - * provided by the specified revision to this database. These capabilities must + * provided by the specified revision to this database. These capabilities must * become available for lookup with the {@link ModuleDatabase#findCapabilities(Requirement)} * method. * <p> @@ -832,7 +832,7 @@ public class ModuleDatabase { /** * Removes the {@link ModuleRevision#getModuleCapabilities(String) capabilities} * provided by the specified revision from this database. These capabilities - * must no longer be available for lookup with the + * must no longer be available for lookup with the * {@link ModuleDatabase#findCapabilities(Requirement)} method. * <p> * This method must be called while holding the {@link #writeLock() write} lock. @@ -844,7 +844,7 @@ public class ModuleDatabase { } /** - * Returns a mutable snapshot of capabilities that are candidates for + * Returns a mutable snapshot of capabilities that are candidates for * satisfying the specified requirement. * <p> * A read operation protected by the {@link #readLock() read} lock. @@ -866,14 +866,14 @@ public class ModuleDatabase { * Writes this database in a format suitable for using the {@link #load(DataInputStream)} * method. All modules are stored which have a current {@link ModuleRevision revision}. * Only the current revision of each module is stored (no removal pending revisions - * are stored). Optionally the {@link ModuleWiring wiring} of each current revision + * are stored). Optionally the {@link ModuleWiring wiring} of each current revision * may be stored. Wiring can only be stored if there are no {@link #getRemovalPending() * removal pending} revisions. * <p> * This method acquires the {@link #readLock() read} lock while writing this * database. * <p> - * After this database have been written, the output stream is flushed. + * After this database have been written, the output stream is flushed. * The output stream remains open after this method returns. * @param out the data output steam. * @param persistWirings true if wirings should be persisted. This option will be ignored diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleLoader.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleLoader.java index 237747163..9e2c390c2 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleLoader.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleLoader.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 *******************************************************************************/ @@ -37,7 +37,7 @@ public abstract class ModuleLoader { protected abstract List<URL> findEntries(String path, String filePattern, int options); /** - * + * * @param path * @param filePattern * @param options diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRequirement.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRequirement.java index 4cacf4e60..42f69c1c9 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRequirement.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRequirement.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 @@ import org.osgi.framework.wiring.BundleRequirement; import org.osgi.resource.Namespace; /** - * An implementation of {@link BundleRequirement}. This requirement implements + * An implementation of {@link BundleRequirement}. This requirement implements * the matches method according to the OSGi specification which includes * implementing the mandatory directive for the osgi.wiring.* namespaces. * @since 3.10 diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleResolver.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleResolver.java index 7766a670b..cf8318a79 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleResolver.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleResolver.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 *******************************************************************************/ @@ -150,11 +150,11 @@ final class ModuleResolver { /** * Attempts to resolve all unresolved modules installed in the specified module database. - * returns a delta containing the new wirings or modified wirings that should be + * returns a delta containing the new wirings or modified wirings that should be * merged into the specified moduleDatabase. * <p> * This method only does read operations on the database no wirings are modified - * directly by this method. The returned wirings need to be merged into + * directly by this method. The returned wirings need to be merged into * the database. * @param triggers the triggers that caused the resolver operation to occur * @param triggersMandatory true if the triggers must be resolved by the resolve process @@ -563,12 +563,12 @@ final class ModuleResolver { private final Collection<ModuleRevision> unresolved; /* * Contains unresolved revisions that should not be resolved as part of - * this process. The reasons they should not be resolved will vary. For + * this process. The reasons they should not be resolved will vary. For * example, some might have been filtered out by the resolver hook while * others represent singleton collisions. It is assumed that all * unresolved revisions are disabled at the start of the resolve * process (see initialization in constructors). Any not filtered out - * by ResolverHook.filterResolvable are then removed but may be added + * by ResolverHook.filterResolvable are then removed but may be added * back later for other reasons. */ private final Collection<ModuleRevision> disabled; @@ -589,7 +589,7 @@ final class ModuleResolver { private AtomicReference<ScheduledFuture<?>> timoutFuture = new AtomicReference<>(); /* * Used to generate the UNRESOLVED_PROVIDER resolution report entries. - * + * * The inner map associates a requirement to the set of all matching * capabilities that were found. The outer map associates the requiring * resource to the inner map so that its contents may easily be looked @@ -973,7 +973,7 @@ final class ModuleResolver { Map<Resource, List<Wire>> dynamicAttachWirings = resolveNonPayLoadFragments(); applyInterimResultToWiringCopy(dynamicAttachWirings); if (!dynamicAttachWirings.isEmpty()) { - // be sure to remove the revisions from the optional and triggers + // be sure to remove the revisions from the optional and triggers // so they no longer attempt to be resolved Set<Resource> fragmentResources = dynamicAttachWirings.keySet(); triggers.removeAll(fragmentResources); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRevision.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRevision.java index 223990823..b7261b480 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRevision.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRevision.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 *******************************************************************************/ @@ -119,8 +119,8 @@ public final class ModuleRevision implements BundleRevision { /** * Returns the capabilities declared by this revision - * @param namespace The namespace of the declared capabilities to return or - * {@code null} to return the declared capabilities from all namespaces. + * @param namespace The namespace of the declared capabilities to return or + * {@code null} to return the declared capabilities from all namespaces. * @return An unmodifiable list containing the declared capabilities. */ public List<ModuleCapability> getModuleCapabilities(String namespace) { @@ -137,8 +137,8 @@ public final class ModuleRevision implements BundleRevision { /** * Returns the requirements declared by this revision - * @param namespace The namespace of the declared requirements to return or - * {@code null} to return the declared requirements from all namespaces. + * @param namespace The namespace of the declared requirements to return or + * {@code null} to return the declared requirements from all namespaces. * @return An unmodifiable list containing the declared requirements. */ public List<ModuleRequirement> getModuleRequirements(String namespace) { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRevisionBuilder.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRevisionBuilder.java index a3b5e4b75..ca895ae2b 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRevisionBuilder.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRevisionBuilder.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 *******************************************************************************/ @@ -32,9 +32,9 @@ import org.osgi.framework.wiring.BundleRevision; import org.osgi.resource.Namespace; /** - * A builder for creating module {@link ModuleRevision} objects. A builder can only be used by - * the module {@link ModuleContainer container} to build revisions when - * {@link ModuleContainer#install(Module, String, ModuleRevisionBuilder, Object) + * A builder for creating module {@link ModuleRevision} objects. A builder can only be used by + * the module {@link ModuleContainer container} to build revisions when + * {@link ModuleContainer#install(Module, String, ModuleRevisionBuilder, Object) * installing} or {@link ModuleContainer#update(Module, ModuleRevisionBuilder, Object) updating} a module. * <p> * The builder provides the instructions to the container for creating a {@link ModuleRevision}. diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRevisions.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRevisions.java index 00af04e86..2570138a3 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRevisions.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleRevisions.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 *******************************************************************************/ @@ -20,10 +20,10 @@ import org.osgi.framework.wiring.BundleRevision; import org.osgi.framework.wiring.BundleRevisions; /** - * An implementation of {@link BundleRevisions} which represent a + * An implementation of {@link BundleRevisions} which represent a * {@link Module} installed in a {@link ModuleContainer container}. - * The ModuleRevisions provides a bridge between the revisions, the - * module and the container they are associated with. The + * The ModuleRevisions provides a bridge between the revisions, the + * module and the container they are associated with. The * ModuleRevisions holds the information about the installation of * a module in a container such as the module id and location. * @since 3.10 @@ -77,7 +77,7 @@ public final class ModuleRevisions implements BundleRevisions { /** * Returns the current {@link ModuleRevision revision} associated with this revisions. - * + * * @return the current {@link ModuleRevision revision} associated with this revisions * or {@code null} if the current revision does not exist. */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleWire.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleWire.java index 1de66ab12..8fa836b53 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleWire.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleWire.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/container/ModuleWiring.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleWiring.java index 5d72c4f27..7f21644f4 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleWiring.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/ModuleWiring.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 *******************************************************************************/ @@ -261,7 +261,7 @@ public final class ModuleWiring implements BundleWiring { } /** - * Returns the module loader for this wiring. If the module + * Returns the module loader for this wiring. If the module * loader does not exist yet then one will be created * @return the module loader for this wiring. */ @@ -384,7 +384,7 @@ public final class ModuleWiring implements BundleWiring { } /** - * Returns an unmodifiable collection of package names for + * Returns an unmodifiable collection of package names for * package capabilities that have been substituted. * @return the substituted package names */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/SystemModule.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/SystemModule.java index e7e8426e0..31f9e80a9 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/SystemModule.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/SystemModule.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 *******************************************************************************/ @@ -179,7 +179,7 @@ public abstract class SystemModule extends Module { } /** - * @throws BundleException + * @throws BundleException */ protected void initWorker() throws BundleException { // Do nothing @@ -197,7 +197,7 @@ public abstract class SystemModule extends Module { @Override public void stop(StopOptions... options) throws BundleException { ContainerEvent containerEvent = ContainerEvent.STOPPED_TIMEOUT; - // Need to lock the state change lock with no state to prevent + // Need to lock the state change lock with no state to prevent // other threads from starting the framework while we are shutting down try { if (stateChangeLock.tryLock(10, TimeUnit.SECONDS)) { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/builders/OSGiManifestBuilderFactory.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/builders/OSGiManifestBuilderFactory.java index adcce44b6..674850459 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/builders/OSGiManifestBuilderFactory.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/builders/OSGiManifestBuilderFactory.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/container/namespaces/EclipsePlatformNamespace.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/namespaces/EclipsePlatformNamespace.java index 3be51579a..9376db001 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/namespaces/EclipsePlatformNamespace.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/namespaces/EclipsePlatformNamespace.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 *******************************************************************************/ @@ -17,14 +17,14 @@ import org.osgi.resource.Namespace; /** * Eclipse Platform and Requirement Namespace. - * + * * <p> * This class defines the names for the attributes and directives for this * namespace. All unspecified capability attributes are of type {@code String} * and are used as arbitrary matching attributes for the capability. The values * associated with the specified directive and attribute keys are of type * {@code String}, unless otherwise indicated. - * + * * @Immutable * @noinstantiate This class is not intended to be instantiated by clients. * @since 3.10 diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/namespaces/EquinoxFragmentNamespace.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/namespaces/EquinoxFragmentNamespace.java index 96aeba1a3..ef050fc7c 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/namespaces/EquinoxFragmentNamespace.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/namespaces/EquinoxFragmentNamespace.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 *******************************************************************************/ @@ -17,14 +17,14 @@ import org.osgi.resource.Namespace; /** * Equinox Namespace for fragment capabilities. - * + * * <p> * This class defines the names for the attributes and directives for this * namespace. All unspecified capability attributes are of type {@code String} * and are used as arbitrary matching attributes for the capability. The values * associated with the specified directive and attribute keys are of type * {@code String}, unless otherwise indicated. - * + * * @Immutable * @noinstantiate This class is not intended to be instantiated by clients. * @since 3.10 @@ -34,7 +34,7 @@ public class EquinoxFragmentNamespace extends Namespace { /** /** * Namespace name for fragment capabilities and requirements. - * + * * <p> * Also, the capability attribute used to specify the symbolic name of the host the * resource is providing a fragment for. diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/namespaces/EquinoxModuleDataNamespace.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/namespaces/EquinoxModuleDataNamespace.java index 35f6c2aef..bd51bc874 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/namespaces/EquinoxModuleDataNamespace.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/container/namespaces/EquinoxModuleDataNamespace.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 *******************************************************************************/ @@ -28,14 +28,14 @@ import org.osgi.resource.Namespace; * header.</li> * <li>The bundle class loading policy. * </ul> - * - * This capability is provided for informational purposes and + * + * This capability is provided for informational purposes and * should not be considered as effective by the resolver. * <p> * This class defines the names for the attributes and directives for this * namespace. Capabilities in this namespace are not intended to be used to * match requirements and should not be considered as effective by a resolver. - * + * * @Immutable * @noinstantiate This class is not intended to be instantiated by clients. * @since 3.10 @@ -59,8 +59,8 @@ public class EquinoxModuleDataNamespace extends Namespace { /** An Eclipse-LazyStart header attribute used to specify exception classes for auto start */ public static final String LAZYSTART_EXCEPTIONS_ATTRIBUTE = "exceptions"; //$NON-NLS-1$ - /** - * The Equinox specific header for specifying the lazy start policy + /** + * The Equinox specific header for specifying the lazy start policy * @deprecated use {@link #LAZYSTART_HEADER} */ public static final String AUTOSTART_HEADER = "Eclipse-AutoStart"; //$NON-NLS-1$ @@ -75,7 +75,7 @@ public class EquinoxModuleDataNamespace extends Namespace { * The directive value identifying a {@link #CAPABILITY_EFFECTIVE_DIRECTIVE * capability} that is effective for information purposes. Capabilities * in this namespace must have an effective directive value of information. - * + * * @see #CAPABILITY_EFFECTIVE_DIRECTIVE */ public final static String EFFECTIVE_INFORMATION = "information"; //$NON-NLS-1$ @@ -95,19 +95,19 @@ public class EquinoxModuleDataNamespace extends Namespace { public final static String CAPABILITY_ACTIVATION_POLICY_LAZY = "lazy"; //$NON-NLS-1$ /** - * When the {@link #CAPABILITY_ACTIVATION_POLICY_LAZY lazy} policy is used this + * When the {@link #CAPABILITY_ACTIVATION_POLICY_LAZY lazy} policy is used this * attribute contains the package names that must * trigger the activation when a class is loaded of these packages. - * If the attribute is not defined then the default is all package names. + * If the attribute is not defined then the default is all package names. * The value of this attribute must be of type {@code List<String>}. */ public final static String CAPABILITY_LAZY_INCLUDE_ATTRIBUTE = "lazy.include"; //$NON-NLS-1$ /** - * When the {@link #CAPABILITY_ACTIVATION_POLICY_LAZY lazy} policy is used this + * When the {@link #CAPABILITY_ACTIVATION_POLICY_LAZY lazy} policy is used this * attribute contains the package names that must not * trigger the activation when a class is loaded of these packages. - * If the attribute is not defined then the default is no package names. + * If the attribute is not defined then the default is no package names. * The value of this attribute must be of type {@code List<String>}. */ public final static String CAPABILITY_LAZY_EXCLUDE_ATTRIBUTE = "lazy.exclude"; //$NON-NLS-1$ @@ -129,7 +129,7 @@ public class EquinoxModuleDataNamespace extends Namespace { /** * The capability attribute contains the list buddy loading policies - * for the providing module revision as specified in the Eclipse-BuddyPolicy header. + * for the providing module revision as specified in the Eclipse-BuddyPolicy header. * The value of this attribute must be of type * {@code List<String>}. */ @@ -137,7 +137,7 @@ public class EquinoxModuleDataNamespace extends Namespace { /** * The capability attribute contains the list of symbolic names the - * providing module revision is a registered buddy of as specified by + * providing module revision is a registered buddy of as specified by * the Eclipse-BuddyPolicy header. The value of this attribute must be of type * {@code List<String>}. */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/CaseInsensitiveDictionaryMap.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/CaseInsensitiveDictionaryMap.java index 6edaf1c67..a067b6993 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/CaseInsensitiveDictionaryMap.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/CaseInsensitiveDictionaryMap.java @@ -293,7 +293,7 @@ public class CaseInsensitiveDictionaryMap<K, V> extends Dictionary<K, V> impleme } /** - * Returns the specified key or, if the key is a String, returns + * Returns the specified key or, if the key is a String, returns * a case-insensitive wrapping of the key. * * @param key diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/FilePath.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/FilePath.java index e1d5cfc59..e3b5793d3 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/FilePath.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/FilePath.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,13 +15,13 @@ package org.eclipse.osgi.framework.util; import java.io.File; -/** +/** * A utility class for manipulating file system paths. * <p> * This class is not intended to be subclassed by clients but * may be instantiated. * </p> - * + * * @since 3.1 */ public class FilePath { @@ -44,7 +44,7 @@ public class FilePath { /** * Constructs a new file path from the given File object. - * + * * @param location */ public FilePath(File location) { @@ -57,7 +57,7 @@ public class FilePath { /** * Constructs a new file path from the given string path. - * + * * @param original */ public FilePath(String original) { @@ -85,7 +85,7 @@ public class FilePath { } /* - * Splits the given path string into an array of segments. + * Splits the given path string into an array of segments. */ private String[] computeSegments(String path) { int maxSegmentCount = computeSegmentCount(path); @@ -96,7 +96,7 @@ public class FilePath { // allways absolute int firstPosition = isAbsolute() ? 1 : 0; int lastPosition = hasTrailingSlash() ? len - 2 : len - 1; - // for non-empty paths, the number of segments is + // for non-empty paths, the number of segments is // the number of slashes plus 1, ignoring any leading // and trailing slashes int next = firstPosition; @@ -125,10 +125,10 @@ public class FilePath { } /** - * Returns the device for this file system path, or <code>null</code> if + * Returns the device for this file system path, or <code>null</code> if * none exists. The device string ends with a colon. - * - * @return the device string or null + * + * @return the device string or null */ public String getDevice() { return device; @@ -136,8 +136,8 @@ public class FilePath { /** * Returns the segments in this path. If this path has no segments, returns an empty array. - * - * @return an array containing all segments for this path + * + * @return an array containing all segments for this path */ public String[] getSegments() { return segments.clone(); @@ -145,7 +145,7 @@ public class FilePath { /** * Returns whether this path ends with a slash. - * + * * @return <code>true</code> if the path ends with a slash, false otherwise */ public boolean hasTrailingSlash() { @@ -158,7 +158,7 @@ public class FilePath { // only deal with devices/UNC paths on Windows int deviceSeparatorPos = original.indexOf(DEVICE_SEPARATOR); if (deviceSeparatorPos >= 0) { - //extract device if any + //extract device if any //remove leading slash from device part to handle output of URL.getFile() int start = original.charAt(0) == SEPARATOR ? 1 : 0; device = original.substring(start, deviceSeparatorPos + 1); @@ -186,7 +186,7 @@ public class FilePath { /** * Returns whether this path is absolute (begins with a slash). - * + * * @return <code>true</code> if this path is absolute, <code>false</code> otherwise */ public boolean isAbsolute() { @@ -197,11 +197,11 @@ public class FilePath { * Returns a string representing this path as a relative to the given base path. * <p> * If this path and the given path do not use the same device letter, this path's - * string representation is returned as is. + * string representation is returned as is. * </p> - * + * * @param base the path this path should be made relative to - * @return a string representation for this path as relative to the given base path + * @return a string representation for this path as relative to the given base path */ public String makeRelative(FilePath base) { if (base.device != null && !base.device.equalsIgnoreCase(this.device)) @@ -210,7 +210,7 @@ public class FilePath { int count = this.matchingFirstSegments(base); if (baseCount == count && count == base.segments.length) return base.hasTrailingSlash() ? ("." + SEPARATOR) : "."; //$NON-NLS-1$ //$NON-NLS-2$ - StringBuilder relative = new StringBuilder(); // + StringBuilder relative = new StringBuilder(); // for (int j = 0; j < baseCount - count; j++) relative.append(PARENT_DIR + SEPARATOR); for (int i = 0; i < base.segments.length - count; i++) { @@ -222,7 +222,7 @@ public class FilePath { return relative.toString(); } - /* + /* * Returns the number of segments in this matching the first segments of the * given path. */ @@ -240,7 +240,7 @@ public class FilePath { /** * Returns a string representation of this path. - * + * * @return a string representation of this path */ @Override diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/Headers.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/Headers.java index 02ea3af36..bc6e00a50 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/Headers.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/Headers.java @@ -157,8 +157,8 @@ public class Headers<K, V> extends Dictionary<K, V> implements Map<K, V> { * @param key Key name. * @param value Value of the key or null to remove key. * @param replace A value of true will allow a previous - * value of the key to be replaced. A value of false - * will cause an IllegalArgumentException to be thrown + * value of the key to be replaced. A value of false + * will cause an IllegalArgumentException to be thrown * if a previous value of the key exists. * @return the previous value to which the key was mapped, * or null if the key did not have a previous mapping. diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/KeyedElement.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/KeyedElement.java index 33bb142dd..10bc792de 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/KeyedElement.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/KeyedElement.java @@ -20,7 +20,7 @@ package org.eclipse.osgi.framework.util; * A keyed element can easily be put into a standard Map implementation by using the keyed element * key for the mapping. * <p> - * An element of an <code>KeyedHashSet</code>. A KeyedElement privides the key which is used to hash + * An element of an <code>KeyedHashSet</code>. A KeyedElement privides the key which is used to hash * the elements in an <code>KeyedHashSet</code>. * @since 3.2 */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/ObjectPool.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/ObjectPool.java index 7d0ed38ad..44853f0eb 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/ObjectPool.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/ObjectPool.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/framework/util/SecureAction.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/SecureAction.java index 89684a902..1fc169312 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/SecureAction.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/SecureAction.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 *******************************************************************************/ @@ -41,9 +41,9 @@ public class SecureAction { }); /* - * Package privaet constructor a new SecureAction object. - * The constructed SecureAction object uses the caller's AccessControlContext - * to perform security checks + * Package privaet constructor a new SecureAction object. + * The constructed SecureAction object uses the caller's AccessControlContext + * to perform security checks */ SecureAction() { // save the control context to be used. diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/ThreadInfoReport.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/ThreadInfoReport.java index 89e8e5d59..405b96c3a 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/ThreadInfoReport.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/framework/util/ThreadInfoReport.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/cds/CDSBundleEntry.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/cds/CDSBundleEntry.java index 746af6cb1..1c60e0230 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/cds/CDSBundleEntry.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/cds/CDSBundleEntry.java @@ -61,7 +61,7 @@ public class CDSBundleEntry extends BundleEntry { * @see org.eclipse.osgi.baseadaptor.bundlefile.BundleEntry#getFileURL() * uses the wrapped bundle file to get the actual file url to the content of * the class on disk. - * + * * This should is likely never to be called. */ @Override @@ -85,7 +85,7 @@ public class CDSBundleEntry extends BundleEntry { /* * (non-Javadoc) * @see org.eclipse.osgi.baseadaptor.bundlefile.BundleEntry#getBytes() - * if classbytes is not null, it returns the magic cookie for the shared class. This is used to define + * if classbytes is not null, it returns the magic cookie for the shared class. This is used to define * the class during class loading. * if classbytes is null, it gets the contents from actual BundleEntry and caches it in classbytes. */ @@ -99,7 +99,7 @@ public class CDSBundleEntry extends BundleEntry { * @see org.eclipse.osgi.baseadaptor.bundlefile.BundleEntry#getLocalURL() * uses the wrapped bundle file to get the actual local url to the content of * the class on disk. - * + * * This should is likely never to be called. */ @Override diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/cds/CDSBundleFile.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/cds/CDSBundleFile.java index 29a8dd796..beb6373b9 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/cds/CDSBundleFile.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/cds/CDSBundleFile.java @@ -31,7 +31,7 @@ import org.eclipse.osgi.storage.bundlefile.BundleFileWrapper; /** * Wraps an actual BundleFile object for purposes of loading classes from the - * shared classes cache. + * shared classes cache. */ public class CDSBundleFile extends BundleFileWrapper { private final static String classFileExt = ".class"; //$NON-NLS-1$ @@ -63,10 +63,10 @@ public class CDSBundleFile extends BundleFileWrapper { /* * (non-Javadoc) * @see org.eclipse.osgi.storage.bundlefile.BundleFile#getEntry(java.lang.String) - * - * If path is not for a class then just use the wrapped bundle file to answer the call. + * + * If path is not for a class then just use the wrapped bundle file to answer the call. * If the path is for a class, it returns a CDSBundleEntry object. - * If the path is for a class, it will look for the magic cookie in the + * If the path is for a class, it will look for the magic cookie in the * shared classes cache. If found, the bytes representing the magic cookie are stored in CDSBundleEntry object. */ @Override @@ -88,7 +88,7 @@ public class CDSBundleFile extends BundleFileWrapper { } /** - * Returns the file url to the content of the actual bundle file + * Returns the file url to the content of the actual bundle file * @return the file url to the content of the actual bundle file */ URL getURL() { @@ -96,7 +96,7 @@ public class CDSBundleFile extends BundleFileWrapper { } /** - * Returns the url helper for this bundle file. This is set by the + * Returns the url helper for this bundle file. This is set by the * class loading hook * @return the url helper for this bundle file */ @@ -105,7 +105,7 @@ public class CDSBundleFile extends BundleFileWrapper { } /** - * Sets the url helper for this bundle file. This is called by the + * Sets the url helper for this bundle file. This is called by the * class loading hook. * @param urlHelper the url helper */ @@ -115,8 +115,8 @@ public class CDSBundleFile extends BundleFileWrapper { } /** - * Sets the primed flag for the bundle file. This is called by the - * class loading hook after the first class has been loaded from disk for + * Sets the primed flag for the bundle file. This is called by the + * class loading hook after the first class has been loaded from disk for * this bundle file. * @param primed the primed flag */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/cds/CDSHookImpls.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/cds/CDSHookImpls.java index 3f1507a1c..5eddeaffc 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/cds/CDSHookImpls.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/cds/CDSHookImpls.java @@ -82,7 +82,7 @@ public class CDSHookImpls extends ClassLoaderHook implements BundleFileWrapperFa modified = true; } if (modified) { - // Class bytes have been modified by weaving hooks. + // Class bytes have been modified by weaving hooks. // Such classes need to be stored as Orphans, so skip the call to storeSharedClass() return; } @@ -169,7 +169,7 @@ public class CDSHookImpls extends ClassLoaderHook implements BundleFileWrapperFa } } } catch (HelperAlreadyDefinedException e) { - // We should never get here. + // We should never get here. // If we do, we simply won't share for this ClassLoader } } diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/AtomicLazyInitializer.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/AtomicLazyInitializer.java index 71e45b3b6..071ab6181 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/AtomicLazyInitializer.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/AtomicLazyInitializer.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 *******************************************************************************/ @@ -17,8 +17,8 @@ import java.util.concurrent.Callable; import java.util.concurrent.atomic.AtomicReference; /** - * A helper class for doing lazy initialization - * + * A helper class for doing lazy initialization + * * @param <V> the type of object to lazy initialize */ public class AtomicLazyInitializer<V> { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/Capabilities.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/Capabilities.java index 25f1ac8d4..68318a67a 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/Capabilities.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/Capabilities.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 *******************************************************************************/ @@ -207,7 +207,7 @@ public class Capabilities { /** * Adds the {@link ModuleRevision#getModuleCapabilities(String) capabilities} - * provided by the specified revision to this database. These capabilities must + * provided by the specified revision to this database. These capabilities must * become available for lookup with the {@link #findCapabilities(Requirement)} * method. * @param revision the revision which has capabilities to add @@ -240,7 +240,7 @@ public class Capabilities { /** * Removes the {@link ModuleRevision#getModuleCapabilities(String) capabilities} * provided by the specified revision from this database. These capabilities - * must no longer be available for lookup with the + * must no longer be available for lookup with the * {@link #findCapabilities(Requirement)} method. * @param revision */ @@ -254,7 +254,7 @@ public class Capabilities { } /** - * Returns a mutable snapshot of capabilities that are candidates for + * Returns a mutable snapshot of capabilities that are candidates for * satisfying the specified requirement. * @param requirement the requirement * @return the candidates for the requirement diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/ComputeNodeOrder.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/ComputeNodeOrder.java index f54d5e11b..6c0c8cff7 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/ComputeNodeOrder.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/ComputeNodeOrder.java @@ -17,11 +17,11 @@ package org.eclipse.osgi.internal.container; import java.util.*; /** - * Borrowed from org.eclipse.core.internal.resources.ComputeProjectOrder + * Borrowed from org.eclipse.core.internal.resources.ComputeProjectOrder * to be used when computing the stop order. * Implementation of a sort algorithm for computing the node order. This * algorithm handles cycles in the node reference graph in a reasonable way. - * + * * @since 3.0 */ public class ComputeNodeOrder { @@ -93,14 +93,14 @@ public class ComputeNodeOrder { * Ordered list of adjacent vertexes. In other words, "this" is the * "from" vertex and the elements of this list are all "to" * vertexes. - * + * * Element type: <code>Vertex</code> */ public List<Vertex> adjacent = new ArrayList<>(3); /** * Creates a new vertex with the given id. - * + * * @param id the vertex id */ public Vertex(Object id) { @@ -110,14 +110,14 @@ public class ComputeNodeOrder { /** * Ordered list of all vertexes in this graph. - * + * * Element type: <code>Vertex</code> */ private List<Vertex> vertexList = new ArrayList<>(100); /** * Map from id to vertex. - * + * * Key type: <code>Object</code>; value type: <code>Vertex</code> */ private Map<Object, Vertex> vertexMap = new HashMap<>(100); @@ -170,7 +170,7 @@ public class ComputeNodeOrder { * Defines a new vertex with the given id. The depth-first search is * performed in the relative order in which vertexes were added to the * graph. - * + * * @param id the id of the vertex * @exception IllegalArgumentException if the vertex id is * already defined or if the graph is frozen @@ -194,7 +194,7 @@ public class ComputeNodeOrder { * <code>addVertex</code>. The depth-first search is performed in the * relative order in which adjacent "to" vertexes were added to a given * "from" index. - * + * * @param fromId the id of the "from" vertex * @param toId the id of the "to" vertex * @exception IllegalArgumentException if either vertex is undefined or @@ -215,7 +215,7 @@ public class ComputeNodeOrder { /** * Returns the ids of the vertexes in this graph ordered by depth-first * search finish time. The graph must be frozen. - * + * * @param increasing <code>true</code> if objects are to be arranged * into increasing order of depth-first search finish time, and * <code>false</code> if objects are to be arranged into decreasing @@ -244,7 +244,7 @@ public class ComputeNodeOrder { /** * Returns whether the graph contains cycles. The graph must be frozen. - * + * * @return <code>true</code> if this graph contains at least one cycle, * and <code>false</code> if this graph is cycle free * @exception IllegalArgumentException if the graph is not frozen @@ -260,9 +260,9 @@ public class ComputeNodeOrder { * Returns the non-trivial components of this graph. A non-trivial * component is a set of 2 or more vertexes that were traversed * together. The graph must be frozen. - * + * * @return the possibly empty list of non-trivial components, where - * each component is an array of ids (element type: + * each component is an array of ids (element type: * <code>Object[]</code>) * @exception IllegalArgumentException if the graph is not frozen */ @@ -311,7 +311,7 @@ public class ComputeNodeOrder { // * </p> // */ // private void recursiveDFS() { - // // initialize + // // initialize // // all vertex.color initially Vertex.WHITE; // // all vertex.predecessor initially null; // time = 0; @@ -325,7 +325,7 @@ public class ComputeNodeOrder { // // /** // * Helper method. Performs a depth first search of this graph. - // * + // * // * @param vertex the vertex to visit // */ // private void DFSVisit(Vertex vertex) { @@ -364,7 +364,7 @@ public class ComputeNodeOrder { // use precomputed objects to avoid garbage final Integer NEXT_VERTEX_OBJECT = Integer.valueOf(NEXT_VERTEX); final Integer AFTER_NEXTED_DFS_VISIT_OBJECT = Integer.valueOf(AFTER_NEXTED_DFS_VISIT); - // initialize + // initialize // all vertex.color initially Vertex.WHITE; // all vertex.predecessor initially null; time = 0; @@ -460,7 +460,7 @@ public class ComputeNodeOrder { * Algorithms</it>, McGraw-Hill, 1990. The strongly-connected-components * algorithm is in section 23.5. * </p> - * + * * @param objects a list of projects (element type: * <code>IProject</code>) * @param references a list of project references [A,B] meaning that A diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/InternalUtils.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/InternalUtils.java index f2f3e75d2..d563aa1e3 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/InternalUtils.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/InternalUtils.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/internal/container/LockSet.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/LockSet.java index 531fe026a..67dd60bd8 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/LockSet.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/container/LockSet.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 *******************************************************************************/ @@ -25,7 +25,7 @@ import java.util.concurrent.locks.ReentrantLock; * over and over then new ReentrantLocks are created each time. This set should be * used with care. If the same object is going to be locked/unlocked over and over then * consider using a different locking strategy. - * + * * Previous implementations of this class attempted to use a WeakHashMap to cache * the locks, but this proved to be a flawed approach because of the unpredictable * timing of garbage collection, particularly with autoboxed types (e.g. bundle diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/Debug.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/Debug.java index 645b99bb0..00bb8264c 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/Debug.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/Debug.java @@ -21,7 +21,7 @@ import org.eclipse.osgi.service.debug.DebugOptions; import org.eclipse.osgi.service.debug.DebugOptionsListener; /** - * This class has debug constants which can be used by the Framework implementation + * This class has debug constants which can be used by the Framework implementation * and Adaptor implementations * @since 3.1 */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/EclipseDebugTrace.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/EclipseDebugTrace.java index 846ced8fb..f94881513 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/EclipseDebugTrace.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/EclipseDebugTrace.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 *******************************************************************************/ @@ -110,8 +110,8 @@ class EclipseDebugTrace implements DebugTrace { /** * Construct a new EclipseDebugTrace for the specified bundle symbolic name and write messages to the specified - * trace file. - * + * trace file. + * * @param bundleSymbolicName The symbolic name of the bundle being traced * @param debugOptions Used to determine if the specified bundle symbolic name + option-path has tracing enabled * @param traceClass The class that the client is using to perform trace API calls @@ -126,7 +126,7 @@ class EclipseDebugTrace implements DebugTrace { /** * Is debugging enabled for the specified option-path - * + * * @param optionPath The <i>option-path</i> * @return Returns true if debugging is enabled for the specified option-path on this bundle; Otherwise false. */ @@ -288,7 +288,7 @@ class EclipseDebugTrace implements DebugTrace { /** * Set the trace message for the specified record to include class and method information * if verbose debugging is disabled. - * + * * @param record The {@link FrameworkDebugTraceEntry} containing the information to persist to the trace file. * @param originalMessage The original tracing message */ @@ -310,7 +310,7 @@ class EclipseDebugTrace implements DebugTrace { /** * Utility method to convert an array of StackTraceElement objects to form a String representation of a stack dump - * + * * @param elements * The array of StackTraceElement objects * @return A String of the stack dump produced by the list of elements @@ -336,7 +336,7 @@ class EclipseDebugTrace implements DebugTrace { /** * Write the specified FrameworkTraceEntry to trace file - * + * * @param entry The FrameworkTraceEntry to write to the log file. */ private void writeRecord(final FrameworkDebugTraceEntry entry) { @@ -357,7 +357,7 @@ class EclipseDebugTrace implements DebugTrace { // flush the writer traceWriter.flush(); } catch (Exception ex) { - // any exceptions during tracing should be caught + // any exceptions during tracing should be caught System.err.println("An exception occurred while writing to the platform trace file: ");//$NON-NLS-1$ ex.printStackTrace(System.err); } finally { @@ -394,8 +394,8 @@ class EclipseDebugTrace implements DebugTrace { } /** - * Checks the trace file size. If the file size reaches the limit then the trace file is rotated. - * + * Checks the trace file size. If the file size reaches the limit then the trace file is rotated. + * * @param traceFile The tracing file * @param timestamp the timestamp for the session; this is the same timestamp as the first entry * @return false if an error occurred trying to rotate the trace file @@ -419,7 +419,7 @@ class EclipseDebugTrace implements DebugTrace { final File backupFile = new File(backupFilename); if (backupFile.exists()) { if (!backupFile.delete()) { - System.err.println("Error when trying to delete old trace file: " + backupFile.getName());//$NON-NLS-1$ + System.err.println("Error when trying to delete old trace file: " + backupFile.getName());//$NON-NLS-1$ if (backupFile.renameTo(new File(backupFile.getAbsolutePath() + System.currentTimeMillis()))) { System.err.println("So we rename it to filename: " + backupFile.getName()); //$NON-NLS-1$ } else { @@ -436,8 +436,8 @@ class EclipseDebugTrace implements DebugTrace { isBackupOK = false; } /* - * Write a header to new log file stating that this new file is a continuation file. - * This method should already be called with the file lock set so we should be safe + * Write a header to new log file stating that this new file is a continuation file. + * This method should already be called with the file lock set so we should be safe * to update it here. */ Writer traceWriter = null; @@ -478,7 +478,7 @@ class EclipseDebugTrace implements DebugTrace { /** * Accessor to retrieve the time stamp in a formatted manner. - * + * * @return A formatted time stamp based on the {@link EclipseDebugTrace#TRACE_FILE_DATE_FORMATTER} formatter */ private final String getFormattedDate(long timestamp) { @@ -488,8 +488,8 @@ class EclipseDebugTrace implements DebugTrace { /** * Accessor to retrieve the text of a {@link Throwable} in a formatted manner so that it can be written to the - * trace file. - * + * trace file. + * * @param error The {@lnk Throwable} to format * @return The complete text of a {@link Throwable} as a {@link String} or null if the input error is null. */ @@ -514,17 +514,17 @@ class EclipseDebugTrace implements DebugTrace { /** * Writes header information to a new trace file - * + * * @param traceWriter the trace writer * @param timestamp the timestamp for the session; this is the same timestamp as the first entry - * @throws IOException If an error occurs while writing this session information + * @throws IOException If an error occurs while writing this session information */ private void writeSession(final Writer traceWriter, long timestamp) throws IOException { writeComment(traceWriter, EclipseDebugTrace.TRACE_NEW_SESSION + this.getFormattedDate(timestamp)); writeComment(traceWriter, EclipseDebugTrace.TRACE_FILE_VERSION_COMMENT + EclipseDebugTrace.TRACE_FILE_VERSION); writeComment(traceWriter, EclipseDebugTrace.TRACE_FILE_VERBOSE_COMMENT + debugOptions.isVerbose()); - writeComment(traceWriter, "The following option strings are specified for this debug session:"); //$NON-NLS-1$ + writeComment(traceWriter, "The following option strings are specified for this debug session:"); //$NON-NLS-1$ final String[] allOptions = debugOptions.getAllOptions(); for (String allOption : allOptions) { writeComment(traceWriter, "\t" + allOption); //$NON-NLS-1$ @@ -532,10 +532,10 @@ class EclipseDebugTrace implements DebugTrace { } /** - * Writes the specified trace entry object to the trace file using the + * Writes the specified trace entry object to the trace file using the * {@link EclipseDebugTrace#TRACE_ELEMENT_DELIMITER} as the delimiter between * each element of the entry. - * + * * @param traceWriter the trace writer * @param entry The trace entry object to write to the trace file * @throws IOException If an error occurs while writing this message @@ -598,11 +598,11 @@ class EclipseDebugTrace implements DebugTrace { * Encodes the specified string to replace any occurrence of the {@link EclipseDebugTrace#TRACE_ELEMENT_DELIMITER} * string with the {@link EclipseDebugTrace#TRACE_ELEMENT_DELIMITER_ENCODED} * string. This can be used to ensure that the delimiter character does not break parsing when - * the entry text contains the delimiter character. - * - * @param inputString The original string to be written to the trace file. + * the entry text contains the delimiter character. + * + * @param inputString The original string to be written to the trace file. * @return The original input string with all occurrences of - * {@link EclipseDebugTrace#TRACE_ELEMENT_DELIMITER} replaced with + * {@link EclipseDebugTrace#TRACE_ELEMENT_DELIMITER} replaced with * {@link EclipseDebugTrace#TRACE_ELEMENT_DELIMITER_ENCODED}. A <code>null</code> value will be * returned if the input string is <code>null</code>. */ @@ -630,9 +630,9 @@ class EclipseDebugTrace implements DebugTrace { /** * Creates the trace writer. * If the tracing file is null then the writer will use System.out to print any messages. - * + * * @param traceFile The tracing file - * @return Returns a new Writer object + * @return Returns a new Writer object */ private Writer openWriter(final File traceFile) { OutputStream out = null; @@ -647,7 +647,7 @@ class EclipseDebugTrace implements DebugTrace { if (out == null) { out = new FilterOutputStream(System.out) { /** - * @throws IOException + * @throws IOException */ @Override public void close() throws IOException { @@ -685,7 +685,7 @@ class EclipseDebugTrace implements DebugTrace { /** * Close the trace writer - * + * * @param traceWriter The trace writer */ private void closeWriter(Writer traceWriter) { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/FrameworkDebugOptions.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/FrameworkDebugOptions.java index 6f11c7b1e..cbea86156 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/FrameworkDebugOptions.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/FrameworkDebugOptions.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 @@ import org.osgi.util.tracker.ServiceTrackerCustomizer; * The DebugOptions implementation class that allows accessing the list of debug options specified * for the application as well as creating {@link DebugTrace} objects for the purpose of having * dynamic enablement of debug tracing. - * + * * @since 3.1 */ public class FrameworkDebugOptions implements DebugOptions, ServiceTrackerCustomizer<DebugOptionsListener, DebugOptionsListener> { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/FrameworkDebugTraceEntry.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/FrameworkDebugTraceEntry.java index f46675223..90c1f1390 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/FrameworkDebugTraceEntry.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/debug/FrameworkDebugTraceEntry.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 @@ public class FrameworkDebugTraceEntry { /** * The date and time when the trace occurred. - * + * */ private final long timestamp; @@ -68,7 +68,7 @@ public class FrameworkDebugTraceEntry { /** * Construct a new FrameworkTraceRecord object - * + * * @param bundleSymbolicName * The symbolic name of the bundle being traced * @param optionPath @@ -84,7 +84,7 @@ public class FrameworkDebugTraceEntry { /** * Construct a new FrameworkTraceRecord object - * + * * @param bundleSymbolicName * The symbolic name of the bundle being traced * @param optionPath @@ -94,7 +94,7 @@ public class FrameworkDebugTraceEntry { * @param error * An exception to be traced * @param traceClass - * The class that calls the trace API + * The class that calls the trace API */ public FrameworkDebugTraceEntry(String bundleSymbolicName, final String optionPath, final String message, final Throwable error, final String traceClass) { threadName = Thread.currentThread().getName(); @@ -123,7 +123,7 @@ public class FrameworkDebugTraceEntry { * is likely that class so we should find out who called it. If a * trace class has not been specified, or has been specified and this * stack element is not that class, then we assume this stack element - * is the caller of the trace API. + * is the caller of the trace API. */ if ((traceClass == null) || !fullClassName.equals(traceClass)) { determineClassName = stackElements[i].getClassName(); @@ -142,7 +142,7 @@ public class FrameworkDebugTraceEntry { /* * (non-Javadoc) - * + * * @see java.lang.Object#toString() */ @Override @@ -173,7 +173,7 @@ public class FrameworkDebugTraceEntry { /** * Accessor to the threads name - * + * * @return the name of the thread */ public final String getThreadName() { @@ -183,7 +183,7 @@ public class FrameworkDebugTraceEntry { /** * Accessor to the timestamp for this trace record - * + * * @return the date */ public final long getTimestamp() { @@ -193,7 +193,7 @@ public class FrameworkDebugTraceEntry { /** * Accessor for the symbolic name of the bundle being traced - * + * * @return The symbolic name of the bundle being traced */ public final String getBundleSymbolicName() { @@ -203,7 +203,7 @@ public class FrameworkDebugTraceEntry { /** * Accessor for the trace message - * + * * @return the trace message */ public final String getMessage() { @@ -213,7 +213,7 @@ public class FrameworkDebugTraceEntry { /** * Accessor for the trace exception. This may be null if there is no exception. - * + * * @return the trace exception or null if none was defined. */ public final Throwable getThrowable() { @@ -223,7 +223,7 @@ public class FrameworkDebugTraceEntry { /** * Accessor for the name of the class being traced. - * + * * @return The name of the class being traced. */ public final String getClassName() { @@ -233,7 +233,7 @@ public class FrameworkDebugTraceEntry { /** * Accessor for the method being traced. - * + * * @return The name of the method being traced. */ public final String getMethodName() { @@ -244,14 +244,14 @@ public class FrameworkDebugTraceEntry { /** * Accessor for the option-path being traced. The <i><option-path></i> part of the debug option string * required for the Eclipse debugging framework. - * + * * <pre> * Examples: * 1) If a trace string com.ibm.myplugin.core/debug=true is specified then 'debug' is the option-path value. * 2) If a trace string com.ibm.myplugin.core/debug/perf=true is specified then 'debug/perf' is the option-path value. * </pre> - * - * + * + * * @return The option-path being traced. */ public final String getOptionPath() { @@ -261,7 +261,7 @@ public class FrameworkDebugTraceEntry { /** * Return the line number in the class/method where the trace originator - * + * * @return The line number from the class and method where the trace request originated */ public final int getLineNumber() { @@ -270,7 +270,7 @@ public class FrameworkDebugTraceEntry { } /** - * + * * @param newMessage */ void setMessage(final String newMessage) { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/BundleContextImpl.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/BundleContextImpl.java index 5d900bf78..29b20c0bd 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/BundleContextImpl.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/BundleContextImpl.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 *******************************************************************************/ @@ -264,7 +264,7 @@ public class BundleContextImpl implements BundleContext, EventDispatcher<Object, void notifyFindHooksPriviledged(final BundleContextImpl context, final Collection<Bundle> allBundles) { if (debug.DEBUG_HOOKS) { - Debug.println("notifyBundleFindHooks(" + allBundles + ")"); //$NON-NLS-1$ //$NON-NLS-2$ + Debug.println("notifyBundleFindHooks(" + allBundles + ")"); //$NON-NLS-1$ //$NON-NLS-2$ } container.getServiceRegistry().notifyHooksPrivileged(new HookContext() { @Override @@ -281,7 +281,7 @@ public class BundleContextImpl implements BundleContext, EventDispatcher<Object, @Override public String getHookMethodName() { - return "find"; //$NON-NLS-1$ + return "find"; //$NON-NLS-1$ } @Override @@ -860,7 +860,7 @@ public class BundleContextImpl implements BundleContext, EventDispatcher<Object, String clazz = null; clazz = bundleActivator.getClass().getName(); - throw new BundleException(NLS.bind(Msg.BUNDLE_ACTIVATOR_EXCEPTION, new Object[] {clazz, "start", bundle.getSymbolicName() == null ? "" + bundle.getBundleId() : bundle.getSymbolicName()}), BundleException.ACTIVATOR_ERROR, t); //$NON-NLS-1$ //$NON-NLS-2$ + throw new BundleException(NLS.bind(Msg.BUNDLE_ACTIVATOR_EXCEPTION, new Object[] {clazz, "start", bundle.getSymbolicName() == null ? "" + bundle.getBundleId() : bundle.getSymbolicName()}), BundleException.ACTIVATOR_ERROR, t); //$NON-NLS-1$ //$NON-NLS-2$ } } @@ -916,16 +916,16 @@ public class BundleContextImpl implements BundleContext, EventDispatcher<Object, String clazz = (activator == null) ? "" : activator.getClass().getName(); //$NON-NLS-1$ - throw new BundleException(NLS.bind(Msg.BUNDLE_ACTIVATOR_EXCEPTION, new Object[] {clazz, "stop", bundle.getSymbolicName() == null ? "" + bundle.getBundleId() : bundle.getSymbolicName()}), BundleException.ACTIVATOR_ERROR, t); //$NON-NLS-1$ //$NON-NLS-2$ + throw new BundleException(NLS.bind(Msg.BUNDLE_ACTIVATOR_EXCEPTION, new Object[] {clazz, "stop", bundle.getSymbolicName() == null ? "" + bundle.getBundleId() : bundle.getSymbolicName()}), BundleException.ACTIVATOR_ERROR, t); //$NON-NLS-1$ //$NON-NLS-2$ } finally { activator = null; } } - /** + /** * Return the map of ServiceRegistrationImpl to ServiceUse for services being * used by this context. - * @return A map of ServiceRegistrationImpl to ServiceUse for services in use by + * @return A map of ServiceRegistrationImpl to ServiceUse for services in use by * this context. */ public Map<ServiceRegistrationImpl<?>, ServiceUse<?>> getServicesInUseMap() { @@ -1057,7 +1057,7 @@ public class BundleContextImpl implements BundleContext, EventDispatcher<Object, } /** - * This method checks that the context is still valid. + * This method checks that the context is still valid. * * @return true if the context is still valid; false otherwise */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/ContextFinder.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/ContextFinder.java index 0c3cf1ef5..2ea40c99c 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/ContextFinder.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/ContextFinder.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 *******************************************************************************/ @@ -60,7 +60,7 @@ public class ContextFinder extends ClassLoader implements PrivilegedAction<List< this.parentContextClassLoader = contextClassLoader != null ? contextClassLoader : bootLoader; } - // Return a list of all classloaders on the stack that are neither the + // Return a list of all classloaders on the stack that are neither the // ContextFinder classloader nor the boot classloader. The last classloader // in the list is either a bundle classloader or the framework's classloader // We assume that the bootclassloader never uses the context classloader to find classes in itself. @@ -85,7 +85,7 @@ public class ContextFinder extends ClassLoader implements PrivilegedAction<List< return result; } - // ensures that a classloader does not have the ContextFinder as part of the + // ensures that a classloader does not have the ContextFinder as part of the // parent hierachy. A classloader which has the ContextFinder as a parent must // not be used as a delegate, otherwise we endup in endless recursion. private boolean checkClassLoader(ClassLoader classloader) { @@ -109,7 +109,7 @@ public class ContextFinder extends ClassLoader implements PrivilegedAction<List< } //Return whether the request for loading "name" should proceed. - //False is returned when a cycle is being detected + //False is returned when a cycle is being detected private boolean startLoading(String name) { Set<String> classesAndResources = cycleDetector.get(); if (classesAndResources != null && classesAndResources.contains(name)) diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/DTOBuilder.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/DTOBuilder.java index a54e9bad6..96074297f 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/DTOBuilder.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/DTOBuilder.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/internal/framework/EquinoxBundle.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxBundle.java index aefaac69d..684d80509 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxBundle.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxBundle.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/internal/framework/EquinoxConfiguration.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxConfiguration.java index da2fb2dfa..2cb16eb89 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxConfiguration.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxConfiguration.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 *******************************************************************************/ @@ -160,7 +160,7 @@ public class EquinoxConfiguration implements EnvironmentInfo { public static final String ECLIPSE_FRAMEWORK_VENDOR = "Eclipse"; //$NON-NLS-1$ public static final String PROP_OSGI_JAVA_PROFILE = "osgi.java.profile"; //$NON-NLS-1$ - public static final String PROP_OSGI_JAVA_PROFILE_NAME = "osgi.java.profile.name"; //$NON-NLS-1$ + public static final String PROP_OSGI_JAVA_PROFILE_NAME = "osgi.java.profile.name"; //$NON-NLS-1$ // OSGi java profile bootdelegation; used to indicate how the org.osgi.framework.bootdelegation // property defined in the java profile should be processed, (ingnore, override, none). default is ignore public static final String PROP_OSGI_JAVA_PROFILE_BOOTDELEGATION = "osgi.java.profile.bootdelegation"; //$NON-NLS-1$ @@ -186,7 +186,7 @@ public class EquinoxConfiguration implements EnvironmentInfo { public static final String PROP_ROOT_LOCALE = "equinox.root.locale"; //$NON-NLS-1$ - public static final String PROP_PARENT_CLASSLOADER = "osgi.parentClassloader"; //$NON-NLS-1$ + public static final String PROP_PARENT_CLASSLOADER = "osgi.parentClassloader"; //$NON-NLS-1$ // A parent classloader type that specifies the framework classlaoder public static final String PARENT_CLASSLOADER_FWK = "fwk"; //$NON-NLS-1$ // System property used to set the context classloader parent classloader type (ccl is the default) @@ -415,7 +415,7 @@ public class EquinoxConfiguration implements EnvironmentInfo { Method getenv = System.class.getMethod("getenv", new Class[] {String.class}); //$NON-NLS-1$ prop = (String) getenv.invoke(null, new Object[] {var}); } catch (Throwable t) { - // do nothing; + // do nothing; // on 1.4 VMs this throws an error // on J2ME this method does not exist } @@ -1036,7 +1036,7 @@ public class EquinoxConfiguration implements EnvironmentInfo { /* * Initializes the execution context for this run of the platform. The context * includes information about the locale, operating system and window system. - * + * * NOTE: The OS, WS, and ARCH values should never be null. The executable should * be setting these values and therefore this code path is obsolete for Eclipse * when run from the executable. @@ -1053,7 +1053,7 @@ public class EquinoxConfiguration implements EnvironmentInfo { nlValue = Locale.getDefault().toString(); setConfiguration(PROP_OSGI_NL, nlValue); - // if the user didn't set the operating system with a command line + // if the user didn't set the operating system with a command line // argument then use the default. String osValue = getConfiguration(PROP_OSGI_OS); if (osValue == null) { @@ -1061,7 +1061,7 @@ public class EquinoxConfiguration implements EnvironmentInfo { setConfiguration(PROP_OSGI_OS, osValue); } - // if the user didn't set the window system with a command line + // if the user didn't set the window system with a command line // argument then use the default. String wsValue = getConfiguration(PROP_OSGI_WS); if (wsValue == null) { @@ -1069,7 +1069,7 @@ public class EquinoxConfiguration implements EnvironmentInfo { setConfiguration(PROP_OSGI_WS, wsValue); } - // if the user didn't set the system architecture with a command line + // if the user didn't set the system architecture with a command line // argument then use the default. String archValue = getConfiguration(PROP_OSGI_ARCH); if (archValue == null) { @@ -1138,22 +1138,22 @@ public class EquinoxConfiguration implements EnvironmentInfo { * <p> * Converts a String to a Locale. * </p> - * + * * <p> * This method takes the string format of a locale and creates the locale object from it. * </p> - * + * * <p> * This method validates the input strictly. The language code must be lowercase. The country * code must be uppercase. The separator must be an underscore. The length must be correct. * </p> - * + * * <p> * This method is inspired by <code>org.apache.commons.lang.LocaleUtils.toLocale(String)</code> * by fixing the parsing error for uncommon Locales like having a language and a variant code * but no country code, or a Locale that only consists of a country code. * </p> - * + * * @param str * the locale String to convert * @param defaultLocale diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxContainer.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxContainer.java index d728c9fa9..af1b7d0d6 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxContainer.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxContainer.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 *******************************************************************************/ @@ -208,7 +208,7 @@ public class EquinoxContainer implements ThreadFactory, Runnable { // do this outside of the lock to avoid deadlock currentSaver.close(); currentStorage.close(); - // Must be done last since it will result in termination of the + // Must be done last since it will result in termination of the // framework active thread. currentExecutor.shutdown(); } diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxContainerAdaptor.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxContainerAdaptor.java index ace518c87..e6e3a6e34 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxContainerAdaptor.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxContainerAdaptor.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/internal/framework/EquinoxEventPublisher.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxEventPublisher.java index 19daba488..8df1049fa 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxEventPublisher.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/EquinoxEventPublisher.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 *******************************************************************************/ @@ -120,7 +120,7 @@ public class EquinoxEventPublisher { /** * Deliver a BundleEvent to SynchronousBundleListeners (synchronous) and * BundleListeners (asynchronous). - * + * * @param type * BundleEvent type. * @param bundle @@ -250,7 +250,7 @@ public class EquinoxEventPublisher { private void notifyEventHooksPrivileged(final BundleEvent event, final Collection<BundleContext> result) { if (container.getConfiguration().getDebug().DEBUG_HOOKS) { - Debug.println("notifyBundleEventHooks(" + event.getType() + ":" + event.getBundle() + ", " + result + " )"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ + Debug.println("notifyBundleEventHooks(" + event.getType() + ":" + event.getBundle() + ", " + result + " )"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ } ServiceRegistry serviceRegistry = container.getServiceRegistry(); @@ -283,7 +283,7 @@ public class EquinoxEventPublisher { /** * Deliver a FrameworkEvent. - * + * * @param type * FrameworkEvent type. * @param bundle diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/FilterImpl.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/FilterImpl.java index c9f574709..d0ccb3637 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/FilterImpl.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/FilterImpl.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 *******************************************************************************/ @@ -58,7 +58,7 @@ import org.osgi.framework.Version; * <p> * The string representation of an LDAP search filter is defined by the * following grammar. It uses a prefix format. - * + * * <pre> * <filter> ::= '(' <filtercomp> ')' * <filtercomp> ::= <and> | <or> | <not> | <item> @@ -80,7 +80,7 @@ import org.osgi.framework.Version; * <starval> ::= NULL | <value> '*' <starval> * <final> ::= NULL | <value> * </pre> - * + * * {@code <attr>} is a string representing an attribute, or key, in the * properties objects of the registered services. Attribute names are not case * sensitive; that is cn and CN both refer to the same attribute. @@ -94,7 +94,7 @@ import org.osgi.framework.Version; * presence filter. * <p> * Examples of LDAP filters are: - * + * * <pre> * "(cn=Babs Jensen)" * "(!(cn=Tim Howes))" @@ -144,14 +144,14 @@ import org.osgi.framework.Version; * Note: arrays of primitives are also supported. </blockquote> A filter matches * a key that has multiple values if it matches at least one of those values. * For example, - * + * * <pre> * Dictionary d = new Hashtable(); * d.put("cn", new String[] { * "a", "b", "c" * }); * </pre> - * + * * d will match {@code (cn=a)} and also {@code (cn=b)} * <p> * A filter component that references a key having an unrecognizable data type @@ -167,7 +167,7 @@ public abstract class FilterImpl implements Filter { * <p> * If the filter cannot be parsed, an {@link InvalidSyntaxException} will be * thrown with a human readable message where the filter became unparsable. - * + * * @param filterString the filter string. * @throws InvalidSyntaxException If the filter parameter contains an * invalid filter string that cannot be parsed. @@ -190,7 +190,7 @@ public abstract class FilterImpl implements Filter { * This {@code Filter} is executed using the keys and values of the * referenced service's properties. The keys are looked up in a case * insensitive manner. - * + * * @param reference The reference to the service whose properties are used * in the match. * @return {@code true} if the service's properties match this @@ -205,7 +205,7 @@ public abstract class FilterImpl implements Filter { * Filter using a {@code Dictionary} with case insensitive key lookup. This * {@code Filter} is executed using the specified {@code Dictionary}'s keys * and values. The keys are looked up in a case insensitive manner. - * + * * @param dictionary The {@code Dictionary} whose key/value pairs are used * in the match. * @return {@code true} if the {@code Dictionary}'s values match this @@ -222,7 +222,7 @@ public abstract class FilterImpl implements Filter { * Filter using a {@code Dictionary}. This {@code Filter} is executed using * the specified {@code Dictionary}'s keys and values. The keys are looked * up in a normal manner respecting case. - * + * * @param dictionary The {@code Dictionary} whose key/value pairs are used * in the match. * @return {@code true} if the {@code Dictionary}'s values match this @@ -238,7 +238,7 @@ public abstract class FilterImpl implements Filter { * Filter using a {@code Map}. This {@code Filter} is executed using the * specified {@code Map}'s keys and values. The keys are looked up in a * normal manner respecting case. - * + * * @param map The {@code Map} whose key/value pairs are used in the match. * Maps with {@code null} key or values are not supported. A * {@code null} value is considered not present to the filter. @@ -258,7 +258,7 @@ public abstract class FilterImpl implements Filter { * <p> * The filter string is normalized by removing whitespace which does not * affect the meaning of the filter. - * + * * @return This {@code Filter}'s filter string. */ @Override @@ -275,7 +275,7 @@ public abstract class FilterImpl implements Filter { * <p> * The filter string is normalized by removing whitespace which does not * affect the meaning of the filter. - * + * * @return This {@code Filter}'s filter string. */ abstract StringBuilder normalize(StringBuilder sb); @@ -285,7 +285,7 @@ public abstract class FilterImpl implements Filter { * <p> * This implementation returns the result of calling * {@code this.toString().equals(obj.toString()}. - * + * * @param obj The object to compare against this {@code Filter}. * @return If the other object is a {@code Filter} object, then returns the * result of calling {@code this.toString().equals(obj.toString()}; @@ -309,7 +309,7 @@ public abstract class FilterImpl implements Filter { * <p> * This implementation returns the result of calling * {@code this.toString().hashCode()}. - * + * * @return The hashCode of this {@code Filter}. */ @Override @@ -714,7 +714,7 @@ public abstract class FilterImpl implements Filter { /** * Encode the value string such that '(', '*', ')' and '\' are escaped. - * + * * @param value unencoded value string. */ static StringBuilder encodeValue(StringBuilder sb, String value) { @@ -1258,7 +1258,7 @@ public abstract class FilterImpl implements Filter { * Map a string for an APPROX (~=) comparison. This implementation * removes white spaces. This is the minimum implementation allowed by * the OSGi spec. - * + * * @param input Input string. * @return String ready for APPROX comparison. */ @@ -1292,7 +1292,7 @@ public abstract class FilterImpl implements Filter { /** * Returns the leftmost required objectClass value for the filter to evaluate to true. - * + * * @return The leftmost required objectClass value or null if none could be determined. */ public String getRequiredObjectClass() { @@ -1682,7 +1682,7 @@ public abstract class FilterImpl implements Filter { /** * Create a case insensitive map from the specified dictionary. - * + * * @param dictionary * @throws IllegalArgumentException If {@code dictionary} contains case * variants of the same key name. diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/OSGiFrameworkHooks.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/OSGiFrameworkHooks.java index 8f38c2bc7..feed04ded 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/OSGiFrameworkHooks.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/OSGiFrameworkHooks.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 *******************************************************************************/ @@ -115,7 +115,7 @@ class OSGiFrameworkHooks { void notifyCollisionHooksPriviledged(final int operationType, final Bundle target, final Collection<Bundle> collisionCandidates) { if (debug.DEBUG_HOOKS) { - Debug.println("notifyCollisionHooks(" + operationType + ", " + target + ", " + collisionCandidates + ")"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ + Debug.println("notifyCollisionHooks(" + operationType + ", " + target + ", " + collisionCandidates + ")"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ } ServiceRegistry registry = container.getServiceRegistry(); if (registry != null) { @@ -134,7 +134,7 @@ class OSGiFrameworkHooks { @Override public String getHookMethodName() { - return "filterCollisions"; //$NON-NLS-1$ + return "filterCollisions"; //$NON-NLS-1$ } @Override @@ -150,7 +150,7 @@ class OSGiFrameworkHooks { * This class encapsulates the delegation to ResolverHooks that are registered with the service * registry. This way the resolver implementation only has to call out to a single hook * which does all the necessary service registry lookups. - * + * * This class is not thread safe and expects external synchronization. * */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/StorageSaver.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/StorageSaver.java index cd85841f5..13f239fbc 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/StorageSaver.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/StorageSaver.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/internal/framework/SystemBundleActivator.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/SystemBundleActivator.java index 4cb0b3ca1..b1917a102 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/SystemBundleActivator.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/SystemBundleActivator.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/internal/framework/XMLParsingServiceFactory.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/XMLParsingServiceFactory.java index fbeb96e62..84a6e37e3 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/XMLParsingServiceFactory.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/XMLParsingServiceFactory.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,10 +33,10 @@ class XMLParsingServiceFactory implements ServiceFactory<Object> { return createService(); /* * Set the TCCL while creating jaxp factory instances to the - * requesting bundles class loader. This is needed to - * work around bug 285505. There are issues if multiple + * requesting bundles class loader. This is needed to + * work around bug 285505. There are issues if multiple * xerces implementations are available on the bundles class path - * + * * The real issue is that the ContextFinder will only delegate * to the framework class loader in this case. This class * loader forces the requesting bundle to be delegated to for diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/legacy/PackageAdminImpl.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/legacy/PackageAdminImpl.java index 6044e1597..c6fe2c7e3 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/legacy/PackageAdminImpl.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/legacy/PackageAdminImpl.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 *******************************************************************************/ @@ -57,7 +57,7 @@ import org.osgi.service.packageadmin.RequiredBundle; public class PackageAdminImpl implements PackageAdmin { private final ModuleContainer container; - /* + /* * We need to make sure that the GetBundleAction class loads early to prevent a ClassCircularityError when checking permissions. * See bug 161561 */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/legacy/StartLevelImpl.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/legacy/StartLevelImpl.java index 2d3f7cf9a..45e272d10 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/legacy/StartLevelImpl.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/framework/legacy/StartLevelImpl.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/internal/hookregistry/BundleFileWrapperFactoryHook.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/BundleFileWrapperFactoryHook.java index 22efbdadb..6d38949f3 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/BundleFileWrapperFactoryHook.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/BundleFileWrapperFactoryHook.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 *******************************************************************************/ @@ -23,8 +23,8 @@ import org.eclipse.osgi.storage.bundlefile.BundleFileWrapper; */ public interface BundleFileWrapperFactoryHook { /** - * Wraps a bundle file for the given content and base data. If the - * specified bundle file should not be wrapped then null is returned + * Wraps a bundle file for the given content and base data. If the + * specified bundle file should not be wrapped then null is returned * @param bundleFile the bundle file to be wrapped * @param generation the generation the bundle file is for * @param base true if the content is for the base bundle (not an inner jar, directory etc.) diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/ClassLoaderHook.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/ClassLoaderHook.java index 8e0a52949..3a906b9e0 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/ClassLoaderHook.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/ClassLoaderHook.java @@ -32,7 +32,7 @@ import org.eclipse.osgi.storage.bundlefile.BundleEntry; */ public abstract class ClassLoaderHook { /** - * Gets called by a classpath manager before defining a class. This method allows a class loading hook + * Gets called by a classpath manager before defining a class. This method allows a class loading hook * to process the bytes of a class that is about to be defined and return a transformed byte array. * @param name the name of the class being defined * @param classbytes the bytes of the class being defined @@ -47,7 +47,7 @@ public abstract class ClassLoaderHook { /** * Gets called by a classpath manager before defining a class. This method allows a class loading hook - * to reject a transformation to the class bytes by a + * to reject a transformation to the class bytes by a * {@link #processClass(String, byte[], ClasspathEntry, BundleEntry, ClasspathManager) processClass} method. * @param name the name of the class being defined * @param transformedBytes the transformed bytes of the class being defined @@ -61,7 +61,7 @@ public abstract class ClassLoaderHook { } /** - * Gets called by a classpath manager when looking for ClasspathEntry objects. This method allows + * Gets called by a classpath manager when looking for ClasspathEntry objects. This method allows * a class loading hook to add additional ClasspathEntry objects * @param cpEntries the list of ClasspathEntry objects currently available for the requested classpath * @param cp the name of the requested classpath @@ -75,8 +75,8 @@ public abstract class ClassLoaderHook { /** * Gets called by a base data during {@link ModuleClassLoader#findLibrary(String)}. - * A this method is called for each configured class loading hook until one - * class loading hook returns a non-null value. If no class loading hook returns + * A this method is called for each configured class loading hook until one + * class loading hook returns a non-null value. If no class loading hook returns * a non-null value then the default behavior will be used. * @param generation the bundle generation to find a native library for. * @param libName the name of the native library. @@ -93,7 +93,7 @@ public abstract class ClassLoaderHook { * returns null indicating the built-in implementation should be used. * Only one hook is able to provide the implementation of the module class loader * and the first one to return non-null wins. - * + * * @param parent the parent classloader * @param configuration the equinox configuration * @param delegate the delegate for this classloader @@ -107,7 +107,7 @@ public abstract class ClassLoaderHook { } /** - * Gets called by a classpath manager at the end of + * Gets called by a classpath manager at the end of * {@link BundleLoader#getClassLoader()} is called the first time and a class loader is created. * @param classLoader the newly created bundle classloader */ @@ -116,10 +116,10 @@ public abstract class ClassLoaderHook { } /** - * Called by a {@link BundleLoader#findClass(String)} method before delegating to the resolved constraints and - * local bundle for a class load. If this method returns null then normal delegation is done. If this method + * Called by a {@link BundleLoader#findClass(String)} method before delegating to the resolved constraints and + * local bundle for a class load. If this method returns null then normal delegation is done. If this method * returns a non-null value then the rest of the delegation process is skipped and the returned value is used. - * If this method throws a <code>ClassNotFoundException</code> then the calling + * If this method throws a <code>ClassNotFoundException</code> then the calling * {@link BundleLoader#findClass(String)} method re-throws the exception. * @param name the name of the class to find * @param classLoader the module class loader @@ -131,7 +131,7 @@ public abstract class ClassLoaderHook { } /** - * Called by a {@link BundleLoader#findClass(String)} method after delegating to the resolved constraints and + * Called by a {@link BundleLoader#findClass(String)} method after delegating to the resolved constraints and * local bundle for a class load. This method will only be called if no class was found * from the normal delegation. * @param name the name of the class to find @@ -144,8 +144,8 @@ public abstract class ClassLoaderHook { } /** - * Called by a {@link BundleLoader#findResource(String)} before delegating to the resolved constraints and - * local bundle for a resource load. If this method returns null then normal delegation is done. + * Called by a {@link BundleLoader#findResource(String)} before delegating to the resolved constraints and + * local bundle for a resource load. If this method returns null then normal delegation is done. * If this method returns a non-null value then the rest of the delegation process is skipped and the returned value is used. * If this method throws an <code>FileNotFoundException</code> then the delegation is terminated. * @param name the name of the resource to find @@ -158,7 +158,7 @@ public abstract class ClassLoaderHook { } /** - * Called by a {@link BundleLoader#findResource(String)} after delegating to the resolved constraints and + * Called by a {@link BundleLoader#findResource(String)} after delegating to the resolved constraints and * local bundle for a resource load. This method will only be called if no resource was found * from the normal delegation. * @param name the name of the resource to find @@ -171,8 +171,8 @@ public abstract class ClassLoaderHook { } /** - * Called by a {@link BundleLoader#findResources(String)} before delegating to the resolved constraints and - * local bundle for a resource load. If this method returns null then normal delegation is done. + * Called by a {@link BundleLoader#findResources(String)} before delegating to the resolved constraints and + * local bundle for a resource load. If this method returns null then normal delegation is done. * If this method returns a non-null value then the rest of the delegation process is skipped and the returned value is used. * If this method throws an <code>FileNotFoundException</code> then the delegation is terminated * @param name the name of the resource to find @@ -185,7 +185,7 @@ public abstract class ClassLoaderHook { } /** - * Called by a {@link BundleLoader#findResources(String)} after delegating to the resolved constraints and + * Called by a {@link BundleLoader#findResources(String)} after delegating to the resolved constraints and * local bundle for a resource load. This method will only be called if no resources were found * from the normal delegation. * @param name the name of the resource to find @@ -198,7 +198,7 @@ public abstract class ClassLoaderHook { } /** - * Called by a {@link ClasspathManager} before normal delegation. If this method returns + * Called by a {@link ClasspathManager} before normal delegation. If this method returns * a non-null value then the rest of the delegation process is skipped and the returned value * is used. * @param name the name of the library to find @@ -222,8 +222,8 @@ public abstract class ClassLoaderHook { } /** - * Gets called by a classpath manager during {@link ClasspathManager#findLocalClass(String)} before - * searching the local classloader for a class. A classpath manager will call this method for + * Gets called by a classpath manager during {@link ClasspathManager#findLocalClass(String)} before + * searching the local classloader for a class. A classpath manager will call this method for * each configured class loading hook. * @param name the name of the requested class * @param manager the classpath manager used to find and load the requested class @@ -235,7 +235,7 @@ public abstract class ClassLoaderHook { /** * Gets called by a classpath manager during {@link ClasspathManager#findLocalClass(String)} after - * searching the local classloader for a class. A classpath manager will call this method for + * searching the local classloader for a class. A classpath manager will call this method for * each configured class loading hook. * @param name the name of the requested class * @param clazz the loaded class or null if not found @@ -249,7 +249,7 @@ public abstract class ClassLoaderHook { /** * Gets called by a classpath manager during {@link ClasspathManager#findLocalResource(String)} before - * searching the local classloader for a resource. A classpath manager will call this method for + * searching the local classloader for a resource. A classpath manager will call this method for * each configured class loading hook. * @param name the name of the requested resource * @param manager the classpath manager used to find the requested resource @@ -261,7 +261,7 @@ public abstract class ClassLoaderHook { /** * Gets called by a classpath manager during {@link ClasspathManager#findLocalResource(String)} after - * searching the local classloader for a resource. A classpath manager will call this method for + * searching the local classloader for a resource. A classpath manager will call this method for * each configured class loading hook. * @param name the name of the requested resource * @param resource the URL to the requested resource or null if not found @@ -273,8 +273,8 @@ public abstract class ClassLoaderHook { } /** - * Gets called by a classpath manager after an attempt is made to define a class. This method allows - * a class loading hook to record data about a class definition. + * Gets called by a classpath manager after an attempt is made to define a class. This method allows + * a class loading hook to record data about a class definition. * @param name the name of the class that got defined * @param clazz the class object that got defined or null if an error occurred while defining a class * @param classbytes the class bytes used to define the class @@ -300,7 +300,7 @@ public abstract class ClassLoaderHook { } /** - * Returns true if this hook can support invoking + * Returns true if this hook can support invoking * {@link ClassLoaderHook#processClass(String, byte[], ClasspathEntry, BundleEntry, ClasspathManager) processClass} * recursively for the same class name. If false is returned then a class * loading error will occur if recursive class processing is detected. diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/FrameworkUtilHelper.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/FrameworkUtilHelper.java index 80bc1a80c..5bfb4e3c2 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/FrameworkUtilHelper.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/FrameworkUtilHelper.java @@ -27,7 +27,7 @@ public class FrameworkUtilHelper { /** * See {@link FrameworkUtil#getBundle(Class)} * @param classFromBundle a class defined by a bundle class loader. - * @return A Bundle for the specified bundle class or null if the + * @return A Bundle for the specified bundle class or null if the * specified class was not defined by a bundle class loader. */ public Bundle getBundle(Class<?> classFromBundle) { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/HookRegistry.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/HookRegistry.java index a2c9f3969..552438ada 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/HookRegistry.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/HookRegistry.java @@ -40,15 +40,15 @@ import org.eclipse.osgi.util.ManifestElement; public final class HookRegistry { /** * The hook configurators properties file ("hookconfigurators.properties") <p> - * A framework extension may supply a hook configurators properties file to specify a + * A framework extension may supply a hook configurators properties file to specify a * list of hook configurators. * @see #HOOK_CONFIGURATORS */ public static final String HOOK_CONFIGURATORS_FILE = "hookconfigurators.properties"; //$NON-NLS-1$ /** - * The hook configurators property key ("hookconfigurators.properties") used in - * a hook configurators properties file to specify a comma separated list of fully + * The hook configurators property key ("hookconfigurators.properties") used in + * a hook configurators properties file to specify a comma separated list of fully * qualified hook configurator classes. */ public static final String HOOK_CONFIGURATORS = "hook.configurators"; //$NON-NLS-1$ @@ -60,7 +60,7 @@ public final class HookRegistry { public static final String PROP_HOOK_CONFIGURATORS_INCLUDE = "osgi.hook.configurators.include"; //$NON-NLS-1$ /** - * A system property ("osgi.hook.configurators.exclude") used to exclude + * A system property ("osgi.hook.configurators.exclude") used to exclude * any hook configurators. This is helpful for disabling hook * configurators that is specified in hook configurator properties files. */ @@ -68,7 +68,7 @@ public final class HookRegistry { /** * A system property ("osgi.hook.configurators") used to specify the list - * of hook configurators. If this property is set then the list of configurators + * of hook configurators. If this property is set then the list of configurators * specified will be the only configurators used. */ public static final String PROP_HOOK_CONFIGURATORS = "osgi.hook.configurators"; //$NON-NLS-1$ @@ -92,9 +92,9 @@ public final class HookRegistry { /** * Initializes the hook configurators. The following steps are used to initialize the hook configurators. <p> - * 1. Get a list of hook configurators from all hook configurators properties files on the classpath, + * 1. Get a list of hook configurators from all hook configurators properties files on the classpath, * add this list to the overall list of hook configurators, remove duplicates. <p> - * 2. Get a list of hook configurators from the ("osgi.hook.configurators.include") system property + * 2. Get a list of hook configurators from the ("osgi.hook.configurators.include") system property * and add this list to the overall list of hook configurators, remove duplicates. <p> * 3. Get a list of hook configurators from the ("osgi.hook.configurators.exclude") system property * and remove this list from the overall list of hook configurators. <p> diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/StorageHookFactory.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/StorageHookFactory.java index 34cd3dd9b..261e81367 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/StorageHookFactory.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hookregistry/StorageHookFactory.java @@ -41,10 +41,10 @@ public abstract class StorageHookFactory<S, L, H extends StorageHookFactory.Stor protected final String KEY = this.getClass().getName().intern(); /** - * Returns the storage version of this storage hook. This version - * is used by the storage to check the consistency of cached persistent - * data. Any time a storage hook changes the format of its persistent - * data the storage version should be incremented. + * Returns the storage version of this storage hook. This version + * is used by the storage to check the consistency of cached persistent + * data. Any time a storage hook changes the format of its persistent + * data the storage version should be incremented. * @return the storage version of this storage hook */ public int getStorageVersion() { @@ -60,13 +60,13 @@ public abstract class StorageHookFactory<S, L, H extends StorageHookFactory.Stor } /** - * Returns true if the persisted version is compatible with the + * Returns true if the persisted version is compatible with the * current version of this storage hook. The default implementation * returns true if the specified version is identical to the current * version. Implementations must override this method if they * want to support other (older) versions for migration purposes. * @param version the persisted version - * @return true if the persisted version is compatible with + * @return true if the persisted version is compatible with * the current version. */ public boolean isCompatibleWith(int version) { @@ -74,7 +74,7 @@ public abstract class StorageHookFactory<S, L, H extends StorageHookFactory.Stor } /** - * Creates a save context object for a storage hook. The + * Creates a save context object for a storage hook. The * save context is passed to the {@link StorageHook#save(Object, DataOutputStream)} * for each generation being persisted by the framework. * @return a save context object or {@code null} if no save context is needed @@ -108,7 +108,7 @@ public abstract class StorageHookFactory<S, L, H extends StorageHookFactory.Stor * Creates a storage hook for the specified generation and checks that the * factory class of the storage hook equals the class of this storage hook * factory. - * + * * @param generation - The generation for which a storage hook should be * created. * @return A newly created storage hook or {@code null} if no hook is needed @@ -168,7 +168,7 @@ public abstract class StorageHookFactory<S, L, H extends StorageHookFactory.Stor } /** - * Initializes this storage hook with the content of the specified bundle manifest. + * Initializes this storage hook with the content of the specified bundle manifest. * This method is called when a bundle is installed or updated. * @param manifest the bundle manifest to load into this storage hook * @throws BundleException if any error occurs @@ -184,7 +184,7 @@ public abstract class StorageHookFactory<S, L, H extends StorageHookFactory.Stor * This will be either {@link ModuleEvent#INSTALLED installed} or {@link ModuleEvent#UPDATED updated}. * @param origin The module which originated the lifecycle operation. The origin may be {@code null} for * {@link ModuleEvent#INSTALLED installed} operations. This is the module - * passed to the {@link ModuleContainer#install(Module, String, ModuleRevisionBuilder, Object) install} or + * passed to the {@link ModuleContainer#install(Module, String, ModuleRevisionBuilder, Object) install} or * {@link ModuleContainer#update(Module, ModuleRevisionBuilder, Object) update} method. * @param builder the builder that will be used to create a new {@link ModuleRevision}. * @return The modified builder or a completely new builder to be used by the bundle. A {@code null} value @@ -198,10 +198,10 @@ public abstract class StorageHookFactory<S, L, H extends StorageHookFactory.Stor } /** - * Loads the data from the specified - * input stream into the storage hook. This method is called during startup to + * Loads the data from the specified + * input stream into the storage hook. This method is called during startup to * load all the persistently installed bundles. <p> - * It is important that this method and the {@link #save(Object, DataOutputStream)} method + * It is important that this method and the {@link #save(Object, DataOutputStream)} method * stay in sync. This method must be able to successfully read the data saved by the * {@link #save(Object, DataOutputStream)} method. * @param is an input stream used to load the storage hook's data from. @@ -216,7 +216,7 @@ public abstract class StorageHookFactory<S, L, H extends StorageHookFactory.Stor * Saves the data from this storage hook into the specified output stream. This method * is called if some persistent data has changed for the bundle. <p> * It is important that this method and the {@link #load(Object, DataInputStream)} - * method stay in sync. This method must be able to save data which the + * method stay in sync. This method must be able to save data which the * {@link #load(Object, DataInputStream)} method can ready successfully. * @see #load(Object, DataInputStream) * @param os an output stream used to save the storage hook's data from. @@ -235,7 +235,7 @@ public abstract class StorageHookFactory<S, L, H extends StorageHookFactory.Stor } /** - * Validates the data in this storage hook, if the data is invalid then an illegal state + * Validates the data in this storage hook, if the data is invalid then an illegal state * exception is thrown * @throws IllegalStateException if the data is invalid */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hooks/DevClassLoadingHook.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hooks/DevClassLoadingHook.java index a1cfc662c..8a4eb82a9 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hooks/DevClassLoadingHook.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hooks/DevClassLoadingHook.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 *******************************************************************************/ @@ -77,7 +77,7 @@ public class DevClassLoadingHook extends ClassLoaderHook implements KeyedElement } } } - // mark the first entry of the list. + // mark the first entry of the list. // This way we can quickly tell that dev classpath entries have been added to the list if (result && cpEntries.size() > 0) cpEntries.get(0).addUserObject(this); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hooks/EclipseLazyStarter.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hooks/EclipseLazyStarter.java index 8339703cd..c9ade4c9b 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hooks/EclipseLazyStarter.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/hooks/EclipseLazyStarter.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/internal/loader/BundleLoader.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/BundleLoader.java index 4db50392b..b58432099 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/BundleLoader.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/BundleLoader.java @@ -213,7 +213,7 @@ public class BundleLoader extends ModuleLoader { if (!exportNames.contains(name)) { // must force filtered and reexport sources to be created early // to prevent lazy normal package source creation. - // We only do this for the first export of a package name. + // We only do this for the first export of a package name. sources.createPackageSource(export, true); } } @@ -370,9 +370,9 @@ public class BundleLoader extends ModuleLoader { } /** - * This method gets a resource from the bundle. The resource is searched - * for in the same manner as it would if it was being loaded from a bundle - * (i.e. all hosts, fragments, import, required bundles and + * This method gets a resource from the bundle. The resource is searched + * for in the same manner as it would if it was being loaded from a bundle + * (i.e. all hosts, fragments, import, required bundles and * local resources are searched). * * @param name the name of the desired resource. @@ -386,7 +386,7 @@ public class BundleLoader extends ModuleLoader { * Finds a class local to this bundle. Only the classloader for this bundle is searched. * @param name The name of the class to find. * @return The loaded Class or null if the class is not found. - * @throws ClassNotFoundException + * @throws ClassNotFoundException */ public Class<?> findLocalClass(String name) throws ClassNotFoundException { long start = 0; @@ -960,7 +960,7 @@ public class BundleLoader extends ModuleLoader { for (ModuleWire bundleWire : requiredBundleWires) { if (local != null || BundleNamespace.VISIBILITY_REEXPORT.equals(bundleWire.getRequirement().getDirectives().get(BundleNamespace.REQUIREMENT_VISIBILITY_DIRECTIVE))) { // always add required bundles first if we locally provide the package - // This allows a bundle to provide a package from a required bundle without + // This allows a bundle to provide a package from a required bundle without // re-exporting the whole required bundle. BundleLoader loader = getProviderLoader(bundleWire); if (loader != null) { @@ -1147,7 +1147,7 @@ public class BundleLoader extends ModuleLoader { PackageSource result = findImportedSource(pkgName, null); if (result != null) return result; - // Note that dynamic imports are not checked to avoid aggressive wiring (bug 105779) + // Note that dynamic imports are not checked to avoid aggressive wiring (bug 105779) return findRequiredSource(pkgName, null); } @@ -1225,7 +1225,7 @@ public class BundleLoader extends ModuleLoader { // so we do not have to do the search again for this package. source = NullPackageSource.getNullPackageSource(pkgName); } else if (result.size() == 1) { - // if there is just one source, remember just the single source + // if there is just one source, remember just the single source source = result.get(0); } else { // if there was more than one source, build a multisource and cache that. @@ -1240,7 +1240,7 @@ public class BundleLoader extends ModuleLoader { /* * Gets the package source for the pkgName. This will include the local package source - * if the bundle exports the package. This is used to compare the PackageSource of a + * if the bundle exports the package. This is used to compare the PackageSource of a * package from two different bundles. */ public final PackageSource getPackageSource(String pkgName) { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/BundleLoaderSources.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/BundleLoaderSources.java index a4a7f7523..3b24f87c6 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/BundleLoaderSources.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/BundleLoaderSources.java @@ -52,7 +52,7 @@ public class BundleLoaderSources { // creates a PackageSource from an ExportPackageDescription. This is called when initializing // a BundleLoader to ensure that the proper PackageSource gets created and used for // filtered and reexport packages. The storeSource flag is used by initialize to indicate - // that the source for special case package sources (filtered or re-exported should be stored + // that the source for special case package sources (filtered or re-exported should be stored // in the cache. if this flag is set then a normal SinglePackageSource will not be created // (i.e. it will be created lazily) public PackageSource createPackageSource(ModuleCapability packageCapability, boolean storeSource) { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/ModuleClassLoader.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/ModuleClassLoader.java index b51194304..31aa057b6 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/ModuleClassLoader.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/ModuleClassLoader.java @@ -154,9 +154,9 @@ public abstract class ModuleClassLoader extends ClassLoader implements BundleRef /** * Loads a class for the bundle. First delegate.findClass(name) is called. * The delegate will query the system class loader, bundle imports, bundle - * local classes, bundle hosts and fragments. The delegate will call - * BundleClassLoader.findLocalClass(name) to find a class local to this - * bundle. + * local classes, bundle hosts and fragments. The delegate will call + * BundleClassLoader.findLocalClass(name) to find a class local to this + * bundle. * @param name the name of the class to load. * @param resolve indicates whether to resolve the loaded class or not. * @return The Class object. @@ -199,11 +199,11 @@ public abstract class ModuleClassLoader extends ClassLoader implements BundleRef } /** - * Gets a resource for the bundle. First delegate.findResource(name) is + * Gets a resource for the bundle. First delegate.findResource(name) is * called. The delegate will query the system class loader, bundle imports, - * bundle local resources, bundle hosts and fragments. The delegate will - * call BundleClassLoader.findLocalResource(name) to find a resource local - * to this bundle. + * bundle local resources, bundle hosts and fragments. The delegate will + * call BundleClassLoader.findLocalResource(name) to find a resource local + * to this bundle. * @param name The resource path to get. * @return The URL of the resource or null if it does not exist. */ @@ -263,7 +263,7 @@ public abstract class ModuleClassLoader extends ClassLoader implements BundleRef } /** - * Finds a library for this bundle. Simply calls + * Finds a library for this bundle. Simply calls * manager.findLibrary(libname) to find the library. * @param libname The library to find. * @return The absolution path to the library or null if not found @@ -350,7 +350,7 @@ public abstract class ModuleClassLoader extends ClassLoader implements BundleRef * Creates a ProtectionDomain which uses specified BundleFile and the permissions of the baseDomain * @param bundlefile The source bundlefile the domain is for. * @param domainGeneration the source generation for the domain - * @return a ProtectionDomain which uses specified BundleFile and the permissions of the baseDomain + * @return a ProtectionDomain which uses specified BundleFile and the permissions of the baseDomain */ @SuppressWarnings("deprecation") protected ProtectionDomain createProtectionDomain(BundleFile bundlefile, Generation domainGeneration) { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/SystemBundleLoader.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/SystemBundleLoader.java index e8c7f730f..11099cfd4 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/SystemBundleLoader.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/SystemBundleLoader.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 *******************************************************************************/ @@ -55,7 +55,7 @@ public class SystemBundleLoader extends BundleLoader { } /** - * The ClassLoader that loads OSGi framework classes is used to find the class. + * The ClassLoader that loads OSGi framework classes is used to find the class. */ @Override public Class<?> findLocalClass(String name) { @@ -100,7 +100,7 @@ public class SystemBundleLoader extends BundleLoader { /** * The ClassLoader that loads OSGi framework classes is used to find the resource. * This method never gets called because there is no ModuleClassLoader for the framework. - * @throws IOException + * @throws IOException */ @Override public Enumeration<URL> findResources(String name) throws IOException { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/DependentPolicy.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/DependentPolicy.java index 838d9d52c..3e8dd60e2 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/DependentPolicy.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/DependentPolicy.java @@ -24,7 +24,7 @@ import org.osgi.framework.namespace.BundleNamespace; import org.osgi.framework.namespace.PackageNamespace; /** - * DependentPolicy is an implementation of a buddy policy. + * DependentPolicy is an implementation of a buddy policy. * It is responsible for looking up a class in the dependents of the bundle * to which this policy is attached to. */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/IBuddyPolicy.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/IBuddyPolicy.java index f6993fd9b..704b5d129 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/IBuddyPolicy.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/IBuddyPolicy.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/internal/loader/buddy/PolicyHandler.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/PolicyHandler.java index 16285449d..190ca9c31 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/PolicyHandler.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/PolicyHandler.java @@ -190,7 +190,7 @@ public class PolicyHandler implements SynchronousBundleListener { results = new ArrayList<>(policyCount); while (result.hasMoreElements()) { URL url = result.nextElement(); - if (!results.contains(url)) //only add if not already added + if (!results.contains(url)) //only add if not already added results.add(url); } } diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/RegisteredPolicy.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/RegisteredPolicy.java index 3546bb4c2..8bfc83ba7 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/RegisteredPolicy.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/RegisteredPolicy.java @@ -22,7 +22,7 @@ import org.eclipse.osgi.container.namespaces.EquinoxModuleDataNamespace; import org.eclipse.osgi.internal.loader.BundleLoader; /** - *Registered policy is an implementation of a buddy policy. + *Registered policy is an implementation of a buddy policy. * It is responsible for looking up a class in the bundles (registrant) that declare interest in the bundle that require the buddy loading. * Note that the registrants must have a direct dependency on the bundle needing buddy. */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/SystemPolicy.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/SystemPolicy.java index 9c5eb813f..4a5d02698 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/SystemPolicy.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/buddy/SystemPolicy.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/internal/loader/classpath/ClasspathEntry.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/ClasspathEntry.java index 5b7882b67..d93618312 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/ClasspathEntry.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/ClasspathEntry.java @@ -37,9 +37,9 @@ import org.eclipse.osgi.storage.bundlefile.BundleEntry; import org.eclipse.osgi.storage.bundlefile.BundleFile; /** - * A ClasspathEntry contains a single <code>BundleFile</code> which is used as - * a source to load classes and resources from, and a single - * <code>ProtectionDomain</code> which is used as the domain to define classes + * A ClasspathEntry contains a single <code>BundleFile</code> which is used as + * a source to load classes and resources from, and a single + * <code>ProtectionDomain</code> which is used as the domain to define classes * loaded from this ClasspathEntry. * @since 3.2 */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/ClasspathManager.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/ClasspathManager.java index d4b950ffa..fa24f45f3 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/ClasspathManager.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/ClasspathManager.java @@ -51,10 +51,10 @@ import org.osgi.framework.BundleException; import org.osgi.framework.namespace.HostNamespace; /** - * A helper class for {@link ModuleClassLoader} implementations. This class will keep track of - * {@link ClasspathEntry} objects for the host bundle and any attached fragment bundles. This + * A helper class for {@link ModuleClassLoader} implementations. This class will keep track of + * {@link ClasspathEntry} objects for the host bundle and any attached fragment bundles. This * class takes care of searching the {@link ClasspathEntry} objects for a module class loader - * implementation. Additional behavior may be added to a classpath manager by configuring a + * implementation. Additional behavior may be added to a classpath manager by configuring a * {@link ClassLoaderHook}. * @see ModuleClassLoader * @see ClassLoaderHook @@ -173,7 +173,7 @@ public class ClasspathManager { /** * Finds all the ClasspathEntry objects for the requested classpath. This method will first call all * the configured class loading hooks {@link ClassLoaderHook#addClassPathEntry(ArrayList, String, ClasspathManager, Generation)} - * methods. This allows class loading hooks to add additional ClasspathEntry objects to the result for the + * methods. This allows class loading hooks to add additional ClasspathEntry objects to the result for the * requested classpath. Then the local host classpath entries and attached fragment classpath entries are * searched. * @param result a list of ClasspathEntry objects. This list is used to add new ClasspathEntry objects to. @@ -254,12 +254,12 @@ public class ClasspathManager { if (var.equals("ws")) //$NON-NLS-1$ return ClasspathManager.addStandardClassPathEntry(cpEntries, "ws/" + configuration.getWS() + cp.substring(4), hostManager, source); //$NON-NLS-1$ if (var.equals("os")) //$NON-NLS-1$ - return ClasspathManager.addStandardClassPathEntry(cpEntries, "os/" + configuration.getOS() + cp.substring(4), hostManager, source); //$NON-NLS-1$ + return ClasspathManager.addStandardClassPathEntry(cpEntries, "os/" + configuration.getOS() + cp.substring(4), hostManager, source); //$NON-NLS-1$ if (var.equals("nl")) { //$NON-NLS-1$ cp = cp.substring(4); List<String> NL_JAR_VARIANTS = source.getBundleInfo().getStorage().getConfiguration().ECLIPSE_NL_JAR_VARIANTS; for (String nlVariant : NL_JAR_VARIANTS) { - if (ClasspathManager.addStandardClassPathEntry(cpEntries, "nl/" + nlVariant + cp, hostManager, source)) //$NON-NLS-1$ + if (ClasspathManager.addStandardClassPathEntry(cpEntries, "nl/" + nlVariant + cp, hostManager, source)) //$NON-NLS-1$ return true; } } @@ -350,8 +350,8 @@ public class ClasspathManager { /** * Finds a local resource by searching the ClasspathEntry objects of the classpath manager. - * This method will first call all the configured class loading hooks - * {@link ClassLoaderHook#preFindLocalResource(String, ClasspathManager)} methods. Then it + * This method will first call all the configured class loading hooks + * {@link ClassLoaderHook#preFindLocalResource(String, ClasspathManager)} methods. Then it * will search for the resource. Finally it will call all the configured class loading hooks * {@link ClassLoaderHook#postFindLocalResource(String, URL, ClasspathManager)} methods. * @param resource the requested resource name. @@ -536,15 +536,15 @@ public class ClasspathManager { /** * Finds a local class by searching the ClasspathEntry objects of the classpath manager. - * This method will first call all the configured class loader hooks - * {@link ClassLoaderHook#preFindLocalClass(String, ClasspathManager)} methods. Then it + * This method will first call all the configured class loader hooks + * {@link ClassLoaderHook#preFindLocalClass(String, ClasspathManager)} methods. Then it * will search for the class. If a class is found then * <ol> * <li>All configured class loader hooks * {@link ClassLoaderHook#processClass(String, byte[], ClasspathEntry, BundleEntry, ClasspathManager)} * methods will be called.</li> - * <li>The class is then defined.</li> - * <li>Finally, all configured class loading + * <li>The class is then defined.</li> + * <li>Finally, all configured class loading * stats hooks {@link ClassLoaderHook#recordClassDefine(String, Class, byte[], ClasspathEntry, BundleEntry, ClasspathManager)} * methods are called.</li> * </ol> @@ -651,10 +651,10 @@ public class ClasspathManager { } /** - * Defines the specified class. This method will first call all the configured class loader hooks - * {@link ClassLoadingHook#processClass(String, byte[], ClasspathEntry, BundleEntry, ClasspathManager)} - * methods. If any hook modifies the bytes the all configured hook - * {@link ClassLoaderHook#rejectTransformation(String, byte[], ClasspathEntry, BundleEntry, ClasspathManager)} + * Defines the specified class. This method will first call all the configured class loader hooks + * {@link ClassLoadingHook#processClass(String, byte[], ClasspathEntry, BundleEntry, ClasspathManager)} + * methods. If any hook modifies the bytes the all configured hook + * {@link ClassLoaderHook#rejectTransformation(String, byte[], ClasspathEntry, BundleEntry, ClasspathManager)} * methods are called. Then it will call the {@link ModuleClassLoader#defineClass(String, byte[], ClasspathEntry, BundleEntry)} * method to define the class. After that, the class loader hooks are called to announce the class * definition by calling {@link ClassLoaderHook#recordClassDefine(String, Class, byte[], ClasspathEntry, BundleEntry, ClasspathManager)}. @@ -679,7 +679,7 @@ public class ClasspathManager { // First call the hooks that do not handle recursion themselves if (!hookRegistry.getContainer().isProcessClassRecursionSupportedByAll()) { // One or more hooks do not support recursive class processing. - // We need to detect recursions for this set of hooks. + // We need to detect recursions for this set of hooks. if (context.currentlyProcessing.contains(name)) { // Avoid recursion for the same class name for these hooks recursionDetected = true; diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/ManifestPackageAttributes.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/ManifestPackageAttributes.java index 8d2705472..9dec7ab2f 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/ManifestPackageAttributes.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/ManifestPackageAttributes.java @@ -38,8 +38,8 @@ class ManifestPackageAttributes { * Factory method for creating ManifestPackageAttributes. If any of the given title, * version, or vendor values are <code>null</code> then the defaultAttributes will be * used. If the defaultAttributes is null or returns all <code>null</code> values then - * <code>null</code> values will be used. If <code>null</code> values are used for all of the - * versions, titles, and vendors then {@link #NONE} is returned. + * <code>null</code> values will be used. If <code>null</code> values are used for all of the + * versions, titles, and vendors then {@link #NONE} is returned. * @param specificationTitle the package specification title * @param specificationVersion the package specification version * @param specificationVendor the package specification vendor diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/TitleVersionVendor.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/TitleVersionVendor.java index 1ed88db36..1a754a7a8 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/TitleVersionVendor.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/classpath/TitleVersionVendor.java @@ -27,7 +27,7 @@ class TitleVersionVendor { private final String vendor; /** - * Factory for creating TitleVersionVendor objects. If the given title, version and + * Factory for creating TitleVersionVendor objects. If the given title, version and * vendor are <code>null</code> then {@link #NONE} is returned. * @param title * @param version diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/FilteredSourcePackage.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/FilteredSourcePackage.java index 39d203116..051df33eb 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/FilteredSourcePackage.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/FilteredSourcePackage.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/internal/loader/sources/MultiSourcePackage.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/MultiSourcePackage.java index ee7559a39..b42472a58 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/MultiSourcePackage.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/MultiSourcePackage.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/internal/loader/sources/PackageSource.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/PackageSource.java index 99471fd3e..556b07e0f 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/PackageSource.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/PackageSource.java @@ -149,7 +149,7 @@ public abstract class PackageSource { @SuppressWarnings("deprecation") Bundle bundle = container.getPackageAdmin().getBundle(serviceClass); if (bundle != null && bundle != registrant) - // in this case we have a wacky ServiceFactory that is doing something we cannot + // in this case we have a wacky ServiceFactory that is doing something we cannot // verify if it is correct. Instead of failing we allow the assignment and hope for the best // bug 326918 return true; diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/SingleSourcePackage.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/SingleSourcePackage.java index a686cd84e..204e9797a 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/SingleSourcePackage.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/loader/sources/SingleSourcePackage.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/internal/location/BasicLocation.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/location/BasicLocation.java index 45c38d584..7197ef292 100755 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/location/BasicLocation.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/location/BasicLocation.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/internal/location/EquinoxLocations.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/location/EquinoxLocations.java index f58e50a0b..0c13ace6f 100755 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/location/EquinoxLocations.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/location/EquinoxLocations.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 * Rapicorp, Inc - Support for Mac Layout (bug 431116) @@ -115,8 +115,8 @@ public class EquinoxLocations { // only compute the default if the configuration area property is not set defaultLocation = buildURL(computeDefaultConfigurationLocation(), true); configurationLocation = buildLocation(PROP_CONFIG_AREA, defaultLocation, "", false, false, null); //$NON-NLS-1$ - // get the parent location based on the system property. This will have been set on the - // way in either by the caller/user or by main. There will be no parent location if we are not + // get the parent location based on the system property. This will have been set on the + // way in either by the caller/user or by main. There will be no parent location if we are not // cascaded. URL parentLocation = computeSharedConfigurationLocation(); if (parentLocation != null && !parentLocation.equals(configurationLocation.getURL())) { @@ -183,10 +183,10 @@ public class EquinoxLocations { @SuppressWarnings("deprecation") private Location buildLocation(String property, URL defaultLocation, String userDefaultAppendage, boolean readOnlyDefault, boolean computeReadOnly, String dataAreaPrefix) { String location = equinoxConfig.clearConfiguration(property); - // the user/product may specify a non-default readOnly setting + // the user/product may specify a non-default readOnly setting String userReadOnlySetting = equinoxConfig.getConfiguration(property + READ_ONLY_AREA_SUFFIX); boolean readOnly = (userReadOnlySetting == null ? readOnlyDefault : Boolean.valueOf(userReadOnlySetting).booleanValue()); - // if the instance location is not set, predict where the workspace will be and + // if the instance location is not set, predict where the workspace will be and // put the instance area inside the workspace meta area. if (location == null) return new BasicLocation(property, defaultLocation, userReadOnlySetting != null || !computeReadOnly ? readOnly : !canWrite(defaultLocation), dataAreaPrefix, equinoxConfig, container, debugLocations); @@ -247,16 +247,16 @@ public class EquinoxLocations { sharedConfigurationURL = new URL(installURL, sharedConfigurationURL.getPath()); equinoxConfig.setConfiguration(PROP_SHARED_CONFIG_AREA, sharedConfigurationURL.toExternalForm()); } catch (MalformedURLException e) { - // do nothing here since it is basically impossible to get a bogus url + // do nothing here since it is basically impossible to get a bogus url } return null; } private String computeDefaultConfigurationLocation() { // 1) We store the config state relative to the 'eclipse' directory if possible - // 2) If this directory is read-only - // we store the state in <user.home>/.eclipse/<application-id>_<version> where <user.home> - // is unique for each local user, and <application-id> is the one + // 2) If this directory is read-only + // we store the state in <user.home>/.eclipse/<application-id>_<version> where <user.home> + // is unique for each local user, and <application-id> is the one // defined in .eclipseproduct marker file. If .eclipseproduct does not // exist, use "eclipse" as the application-id. @@ -285,8 +285,8 @@ public class EquinoxLocations { } private String computeDefaultUserAreaLocation(String pathAppendage) { - // we store the state in <user.home>/.eclipse/<application-id>_<version> where <user.home> - // is unique for each local user, and <application-id> is the one + // we store the state in <user.home>/.eclipse/<application-id>_<version> where <user.home> + // is unique for each local user, and <application-id> is the one // defined in .eclipseproduct marker file. If .eclipseproduct does not // exist, use "eclipse" as the application-id. String installProperty = equinoxConfig.getConfiguration(PROP_INSTALL_AREA); @@ -310,7 +310,7 @@ public class EquinoxLocations { appVersion = ""; //$NON-NLS-1$ appName += File.separator + appId + "_" + appVersion + "_" + installDirHash; //$NON-NLS-1$ //$NON-NLS-2$ } catch (IOException e) { - // Do nothing if we get an exception. We will default to a standard location + // Do nothing if we get an exception. We will default to a standard location // in the user's home dir. // add the hash to help prevent collisions appName += File.separator + installDirHash; diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/ConfigAdminListener.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/ConfigAdminListener.java index 9252f3517..a2d73193b 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/ConfigAdminListener.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/ConfigAdminListener.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/internal/log/EquinoxLogFactory.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EquinoxLogFactory.java index e24e7bb3a..99a0d0aae 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EquinoxLogFactory.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EquinoxLogFactory.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/internal/log/EquinoxLogServices.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EquinoxLogServices.java index 8040f9009..2efb30678 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EquinoxLogServices.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EquinoxLogServices.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 *******************************************************************************/ @@ -114,7 +114,7 @@ public class EquinoxLogServices { private ServiceRegistration<?> perfLogReg; /** - * @throws BundleException + * @throws BundleException */ public void start(BundleContext context) throws BundleException { logServiceManager.start(context); @@ -123,7 +123,7 @@ public class EquinoxLogServices { } /** - * @throws BundleException + * @throws BundleException */ public void stop(BundleContext context) throws BundleException { frameworkLogReg.unregister(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EquinoxLogWriter.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EquinoxLogWriter.java index 4e4946259..134f4fcb2 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EquinoxLogWriter.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EquinoxLogWriter.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 *******************************************************************************/ @@ -43,7 +43,7 @@ import org.osgi.service.log.admin.LoggerAdmin; import org.osgi.service.log.admin.LoggerContext; class EquinoxLogWriter implements SynchronousLogListener, LogFilter { - private static final String PASSWORD = "-password"; //$NON-NLS-1$ + private static final String PASSWORD = "-password"; //$NON-NLS-1$ /** The session tag */ private static final String SESSION = "!SESSION"; //$NON-NLS-1$ /** The entry tag */ @@ -179,7 +179,7 @@ class EquinoxLogWriter implements SynchronousLogListener, LogFilter { * @return the session timestamp */ private String getSessionTimestamp() { - // Main should have set the session start-up timestamp so return that. + // Main should have set the session start-up timestamp so return that. // Return the "now" time if not available. String ts = environmentInfo.getConfiguration("eclipse.startTime"); //$NON-NLS-1$ if (ts != null) { @@ -233,7 +233,7 @@ class EquinoxLogWriter implements SynchronousLogListener, LogFilter { write(", ARCH=" + environmentInfo.getOSArch()); //$NON-NLS-1$ write(", WS=" + environmentInfo.getWS()); //$NON-NLS-1$ writeln(", NL=" + environmentInfo.getNL()); //$NON-NLS-1$ - // Add the command-line arguments used to invoke the platform + // Add the command-line arguments used to invoke the platform // XXX: this includes runtime-private arguments - should we do that? if (includeCommandLine) { writeArgs("Framework arguments: ", environmentInfo.getNonFrameworkArgs()); //$NON-NLS-1$ @@ -303,7 +303,7 @@ class EquinoxLogWriter implements SynchronousLogListener, LogFilter { writeLog(0, logEntry); writer.flush(); } catch (Exception e) { - // any exceptions during logging should be caught + // any exceptions during logging should be caught System.err.println("An exception occurred while writing to the platform log:");//$NON-NLS-1$ e.printStackTrace(System.err); System.err.println("Logging to the console instead.");//$NON-NLS-1$ @@ -326,7 +326,7 @@ class EquinoxLogWriter implements SynchronousLogListener, LogFilter { } /** - * @throws IOException + * @throws IOException */ public synchronized void setFile(File newFile, boolean append) throws IOException { if (newFile != null && !newFile.equals(this.outFile)) { @@ -591,7 +591,7 @@ class EquinoxLogWriter implements SynchronousLogListener, LogFilter { } /** - * Checks the log file size. If the log file size reaches the limit then the log + * Checks the log file size. If the log file size reaches the limit then the log * is rotated * @return false if an error occured trying to rotate the log */ @@ -614,7 +614,7 @@ class EquinoxLogWriter implements SynchronousLogListener, LogFilter { File backupFile = new File(backupFilename); if (backupFile.exists()) { if (!backupFile.delete()) { - System.err.println("Error when trying to delete old log file: " + backupFile.getName());//$NON-NLS-1$ + System.err.println("Error when trying to delete old log file: " + backupFile.getName());//$NON-NLS-1$ if (backupFile.renameTo(new File(backupFile.getAbsolutePath() + System.currentTimeMillis()))) { System.err.println("So we rename it to filename: " + backupFile.getName()); //$NON-NLS-1$ } else { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EventAdminAdapter.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EventAdminAdapter.java index cf673436d..fe62d5a07 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EventAdminAdapter.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/EventAdminAdapter.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/internal/log/ExtendedLogReaderServiceFactory.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/ExtendedLogReaderServiceFactory.java index cca82e301..4972ccf1f 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/ExtendedLogReaderServiceFactory.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/ExtendedLogReaderServiceFactory.java @@ -114,7 +114,7 @@ public class ExtendedLogReaderServiceFactory implements ServiceFactory<ExtendedL // Catch linkage errors as these are generally recoverable but let other Errors propagate (see bug 222001) getErrorStream().println("LogListener.logged threw a non-fatal unchecked exception as follows:"); //$NON-NLS-1$ e.printStackTrace(getErrorStream()); - } + } } public ExtendedLogReaderServiceFactory(int maxHistory, LogLevel defaultLevel) { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/ExtendedLogReaderServiceImpl.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/ExtendedLogReaderServiceImpl.java index 273f9fcf9..8cd1161c4 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/ExtendedLogReaderServiceImpl.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/ExtendedLogReaderServiceImpl.java @@ -32,7 +32,7 @@ public class ExtendedLogReaderServiceImpl implements ExtendedLogReaderService { throw new IllegalArgumentException("LogListener must not be null"); //$NON-NLS-1$ if (filter == null) - throw new IllegalArgumentException("LogFilter must not be null"); //$NON-NLS-1$ + throw new IllegalArgumentException("LogFilter must not be null"); //$NON-NLS-1$ listeners.add(listener); factory.addLogListener(listener, filter); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/LoggerContextTargetMap.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/LoggerContextTargetMap.java index 2f6c0f832..3dd871992 100755 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/LoggerContextTargetMap.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/log/LoggerContextTargetMap.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/internal/permadmin/BundlePermissions.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/BundlePermissions.java index 6168edb5a..2d874bd4b 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/BundlePermissions.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/BundlePermissions.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,7 +22,7 @@ import org.osgi.framework.PackagePermission; public final class BundlePermissions extends PermissionCollection { private static final long serialVersionUID = -5443618108312606612L; - // Note that this forces the Enumeration inner class to be loaded as soon as possible (see bug 119069) + // Note that this forces the Enumeration inner class to be loaded as soon as possible (see bug 119069) static final Enumeration<Permission> EMPTY_ENUMERATION = new Enumeration<Permission>() { @Override public boolean hasMoreElements() { @@ -60,7 +60,7 @@ public final class BundlePermissions extends PermissionCollection { * <p/> * Bundles may require additional permissions in order to execute byte code * woven by weaving hooks. - * + * * @param permission The package permission to add to this woven bundle. * @throws SecurityException If the <code>permission</code> * does not have an action of {@link PackagePermission#IMPORT}. @@ -73,7 +73,7 @@ public final class BundlePermissions extends PermissionCollection { @Override public Enumeration<Permission> elements() { - // TODO return an empty enumeration for now; + // TODO return an empty enumeration for now; // It does not seem possible to do this properly with multiple exports and conditional permissions. // When looking to fix this be sure the Enumeration class is loaded as soon as possible (see bug 119069) return EMPTY_ENUMERATION; diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/EquinoxSecurityManager.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/EquinoxSecurityManager.java index 0234cc8f3..fed844202 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/EquinoxSecurityManager.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/EquinoxSecurityManager.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 *******************************************************************************/ @@ -20,13 +20,13 @@ import org.eclipse.osgi.internal.permadmin.SecurityRow.Decision; import org.osgi.service.condpermadmin.Condition; /** - * + * * This security manager implements the ConditionalPermission processing for * OSGi. It is to be used with ConditionalPermissionAdmin. - * + * */ public class EquinoxSecurityManager extends SecurityManager { - /* + /* * This is super goofy, but we need to make sure that the CheckContext and * CheckPermissionAction classes load early. Otherwise, we run into problems later. */ @@ -96,7 +96,7 @@ public class EquinoxSecurityManager extends SecurityManager { /** * Gets the AccessControlContext currently being evaluated by * the SecurityManager. - * + * * @return the AccessControlContext currently being evaluated by the SecurityManager, or * null if no AccessControlContext is being evaluated. Note: this method will * return null if the permission check is being done directly on the AccessControlContext diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/PermissionAdminTable.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/PermissionAdminTable.java index 49e4db187..54e2d4549 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/PermissionAdminTable.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/PermissionAdminTable.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/internal/permadmin/PermissionInfoCollection.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/PermissionInfoCollection.java index cb057962e..e6635428a 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/PermissionInfoCollection.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/PermissionInfoCollection.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 *******************************************************************************/ @@ -69,7 +69,7 @@ public final class PermissionInfoCollection extends PermissionCollection { @Override public Enumeration<Permission> elements() { - // TODO return an empty enumeration for now; + // TODO return an empty enumeration for now; return BundlePermissions.EMPTY_ENUMERATION; } diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityAdmin.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityAdmin.java index 255577039..4a1ad5223 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityAdmin.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityAdmin.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/internal/permadmin/SecurityRow.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityRow.java index 0dbb366ee..af9efdae4 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityRow.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityRow.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 * Connexta, LLC - performance improvements diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityRowSnapShot.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityRowSnapShot.java index e9c0b1b86..b2b415c82 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityRowSnapShot.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityRowSnapShot.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/internal/permadmin/SecurityTable.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityTable.java index 34aa2a171..ff32046ac 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityTable.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityTable.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 * Connexta, LLC - evaluation cache implementation diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityTableUpdate.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityTableUpdate.java index 1522f8a1a..e99eafb64 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityTableUpdate.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/permadmin/SecurityTableUpdate.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/internal/provisional/service/security/AuthorizationEngine.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationEngine.java index 0d148788a..b57c39297 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationEngine.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationEngine.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 *******************************************************************************/ @@ -38,9 +38,9 @@ public abstract class AuthorizationEngine { } /** - * Authorizes a <code>SignedContent</code> object. The engine determines if the - * signed content authorization should be granted. The context is the entity - * associated with the signed content. For example, signed content + * Authorizes a <code>SignedContent</code> object. The engine determines if the + * signed content authorization should be granted. The context is the entity + * associated with the signed content. For example, signed content * for a bundle will have a <code>Bundle</code> object as the context. * @param content the signed content. The value may be <code>null</code>. * @param context the context associated with the signed content. The value may be <code>null</code>. @@ -65,7 +65,7 @@ public abstract class AuthorizationEngine { } /** - * Authorizes a <code>SignedContent</code> object. The engine determines if the + * Authorizes a <code>SignedContent</code> object. The engine determines if the * signed content authorization should be granted. * @param content * @param context the context associated with the signed content @@ -76,7 +76,7 @@ public abstract class AuthorizationEngine { /** * Return the current status of the Authorization system. - * + * * @return A value of {@link AuthorizationStatus#OK} or {@link AuthorizationStatus#ERROR} * @see AuthorizationStatus#OK * @see AuthorizationStatus#ERROR diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationEvent.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationEvent.java index 41c314799..3798cb6b8 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationEvent.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationEvent.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 *******************************************************************************/ @@ -17,7 +17,7 @@ import org.eclipse.osgi.signedcontent.SignedContent; /** * An event that is fired when an AuthorizationEngine implementation makes - * a decision. + * a decision. * @since 3.4 */ public class AuthorizationEvent { @@ -39,7 +39,7 @@ public class AuthorizationEvent { /** * Create a new AuthorizationEvent - * @param result - the result code + * @param result - the result code * @param content - the signed content * @param context - operation specific context * @param severity - severity code diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationListener.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationListener.java index 516087eab..4284fff24 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationListener.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationListener.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.internal.provisional.service.security; import java.util.EventListener; /** - * A Listener interface for an authorization handler. Implementors + * A Listener interface for an authorization handler. Implementors * should register as an OSGI service. * @since 3.4 */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationStatus.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationStatus.java index 1a6493d90..b06088847 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationStatus.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/service/security/AuthorizationStatus.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.internal.provisional.service.security; * <p> * This class is not intended to be extended by clients. * </p> - * + * * @since 3.4 */ public class AuthorizationStatus { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateChain.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateChain.java index 14d98825a..f4a9d562e 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateChain.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateChain.java @@ -28,7 +28,7 @@ import java.util.Date; public interface CertificateChain { /** * Returns the list of X500 distinguished names that make up the certificate chain. Each - * distinguished name is separated by a ';'. The first distinguished name is the signer + * distinguished name is separated by a ';'. The first distinguished name is the signer * and the last is the root Certificate Authority. * @return the list of X500 distinguished names that make up the certificate chain */ @@ -60,7 +60,7 @@ public interface CertificateChain { /** * Return the signing time for this signer. - * + * * @return null if there is a signing time for this signer null otherwise */ public Date getSigningTime(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateTrustAuthority.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateTrustAuthority.java index 324d1ce57..ec126b747 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateTrustAuthority.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateTrustAuthority.java @@ -19,12 +19,12 @@ import java.security.cert.CertificateException; /** * A CertificateTrustAuthority is used to check if certificate chains are trusted. - * + * */ public interface CertificateTrustAuthority { /** - * Determines if the certificates are trusted. This method will throw a + * Determines if the certificates are trusted. This method will throw a * <code>CertificateException</code> if the specified certificate chain is not trusted. * @param certChain a chain of certificates * @throws CertificateException if the certficates are not trusted @@ -33,7 +33,7 @@ public interface CertificateTrustAuthority { /** * Add the specified certificate chain as a trusted certificate chain. - * + * * @param certChain a chain of certificates */ public void addTrusted(Certificate[] certChain) throws CertificateException; diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateVerifier.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateVerifier.java index 96fbf3907..b8170bce2 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateVerifier.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateVerifier.java @@ -17,8 +17,8 @@ import java.security.SignatureException; import java.security.cert.*; /** - * A certificate verifier is used to verify the authenticity of a signed - * repository. A certificate verifier is created using a + * A certificate verifier is used to verify the authenticity of a signed + * repository. A certificate verifier is created using a * {@link CertificateVerifierFactory}. * <p> * <strong>EXPERIMENTAL</strong>. This class or interface has been added as @@ -30,8 +30,8 @@ import java.security.cert.*; public interface CertificateVerifier { /** * Verify the content of the repository. - * - * @throws CertificateException + * + * @throws CertificateException * @throws CertificateExpiredException * @throws CertificateParsingException * @throws SignatureException @@ -39,10 +39,10 @@ public interface CertificateVerifier { public void checkContent() throws CertificateException, CertificateExpiredException, SignatureException; /** - * Verifies the content of the repository. An array is returned with the entry names + * Verifies the content of the repository. An array is returned with the entry names * which are corrupt. If no entries are corrupt then an empty array is returned. - * @return An array of entry names which are corrupt. An empty array is returned if the - * repository is not corrupt or if the repository is not signed. + * @return An array of entry names which are corrupt. An empty array is returned if the + * repository is not corrupt or if the repository is not signed. */ public String[] verifyContent(); @@ -54,7 +54,7 @@ public interface CertificateVerifier { /** * Returns all certificate chains of the repository. All certificate chains - * are returned whether they are trusted or not. If the repository is not signed + * are returned whether they are trusted or not. If the repository is not signed * then an empty array is returned. * @return all certificate chains of the repository */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateVerifierFactory.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateVerifierFactory.java index 25c91cb4c..c03e47093 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateVerifierFactory.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/provisional/verifier/CertificateVerifierFactory.java @@ -37,7 +37,7 @@ public interface CertificateVerifierFactory { /** * Returns a certificate verifier for the specified bundle. - * @param bundle the bundle to get a verifier for + * @param bundle the bundle to get a verifier for * @return a certificate verifier for the specified bundle. * @throws IOException if an IO exception occurs while reading the bundle content */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/service/security/KeyStoreTrustEngine.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/service/security/KeyStoreTrustEngine.java index 4295da3f1..47764b5ac 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/service/security/KeyStoreTrustEngine.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/service/security/KeyStoreTrustEngine.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 class KeyStoreTrustEngine extends TrustEngine { private final SignedBundleHook signedBundleHook; /** - * Create a new KeyStoreTrustEngine that is backed by a KeyStore + * Create a new KeyStoreTrustEngine that is backed by a KeyStore * @param path - path to the keystore * @param type - the type of keystore at the path location * @param password - the password required to unlock the keystore @@ -77,7 +77,7 @@ public class KeyStoreTrustEngine extends TrustEngine { /** * Return the password - * @return password - the password as a char[] + * @return password - the password as a char[] */ private char[] getPassword() { return password; diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/FilteredServiceListener.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/FilteredServiceListener.java index 1a6638366..7468872f8 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/FilteredServiceListener.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/FilteredServiceListener.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 *******************************************************************************/ @@ -73,7 +73,7 @@ class FilteredServiceListener implements ServiceListener, ListenerHook.ListenerI /** * Receives notification that a service has had a lifecycle change. - * + * * @param event The <code>ServiceEvent</code> object. */ @Override @@ -85,7 +85,7 @@ class FilteredServiceListener implements ServiceListener, ListenerHook.ListenerI String[] classes = reference.getClasses(); int size = classes.length; for (int i = 0; i < size; i++) { - if (classes[i] == objectClass) // objectClass strings have previously been interned for identity comparison + if (classes[i] == objectClass) // objectClass strings have previously been interned for identity comparison break objectClassCheck; } return; // no class in this event matches a required part of the filter; we do not need to deliver this event @@ -117,7 +117,7 @@ class FilteredServiceListener implements ServiceListener, ListenerHook.ListenerI /** * Returns a service event that should be delivered to the listener based on the filter evaluation. * This may result in a service event of type MODIFIED_ENDMATCH. - * + * * @param delivered The service event delivered by the framework. * @return The event to be delivered or null if no event is to be delivered to the listener. */ @@ -155,7 +155,7 @@ class FilteredServiceListener implements ServiceListener, ListenerHook.ListenerI return listener.getClass().getName() + "@" + Integer.toHexString(System.identityHashCode(listener)) + filterString; //$NON-NLS-1$ } - /** + /** * Return the bundle context for the ListenerHook. * @return The context of the bundle which added the service listener. * @see org.osgi.framework.hooks.service.ListenerHook.ListenerInfo#getBundleContext() @@ -165,7 +165,7 @@ class FilteredServiceListener implements ServiceListener, ListenerHook.ListenerI return context; } - /** + /** * Return the filter string for the ListenerHook. * @return The filter string with which the listener was added. This may * be <code>null</code> if the listener was added without a filter. @@ -185,7 +185,7 @@ class FilteredServiceListener implements ServiceListener, ListenerHook.ListenerI * indicating the listener has been added but has not been removed. * After the listener has been removed, this method must always return * <code>true</code>. - * + * * @return <code>false</code> if the listener has not been been removed, * <code>true</code> otherwise. */ @@ -194,7 +194,7 @@ class FilteredServiceListener implements ServiceListener, ListenerHook.ListenerI return removed; } - /** + /** * Mark the service listener registration as removed. */ void markRemoved() { @@ -203,7 +203,7 @@ class FilteredServiceListener implements ServiceListener, ListenerHook.ListenerI /** * Returns an objectClass filter string for the specified class name. - * @return A filter string for the specified class name or <code>null</code> if the + * @return A filter string for the specified class name or <code>null</code> if the * specified class name is <code>null</code>. */ private static String getObjectClassFilterString(String className) { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/HookContext.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/HookContext.java index c4fb74cf8..a16d885ec 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/HookContext.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/HookContext.java @@ -27,7 +27,7 @@ public interface HookContext { /** * Call the specified hook. - * + * * @param hook The hook object to call. The hook object must be of the type * supported by this hook context. If it is not, then this method will * simply return. @@ -38,14 +38,14 @@ public interface HookContext { /** * Return the class name of the hook type supported by this hook context. - * + * * @return The class name of the hook type supported by this hook context. */ public String getHookClassName(); /** * Return the hook method name called by this hook context. - * + * * @return The hook method name called by this hook context. */ public String getHookMethodName(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ModifiedServiceEvent.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ModifiedServiceEvent.java index 247d8930a..4ae46dc54 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ModifiedServiceEvent.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ModifiedServiceEvent.java @@ -29,7 +29,7 @@ class ModifiedServiceEvent extends ServiceEvent { /** * Create a ServiceEvent containing the service properties prior to modification. - * + * * @param reference Reference to service with modified properties. * @param previousProperties Service properties prior to modification. */ @@ -42,7 +42,7 @@ class ModifiedServiceEvent extends ServiceEvent { /** * Return the service event of type MODIFIED. - * + * * @return The service event of type MODIFIED. */ ServiceEvent getModifiedEvent() { @@ -51,7 +51,7 @@ class ModifiedServiceEvent extends ServiceEvent { /** * Return the service event of type MODIFIED_ENDMATCH. - * + * * @return The service event of type MODIFIED_ENDMATCH. */ ServiceEvent getModifiedEndMatchEvent() { @@ -59,15 +59,15 @@ class ModifiedServiceEvent extends ServiceEvent { } /** - * Return if the specified filter matches the previous service + * Return if the specified filter matches the previous service * properties. - * - * @param filter The filer to evaluate using the previous service + * + * @param filter The filer to evaluate using the previous service * properties. * @return True is the filter matches the previous service properties. */ boolean matchPreviousProperties(Filter filter) { - /* We use matches here since ServiceProperties already + /* We use matches here since ServiceProperties already * does case insensitive lookup. */ return filter.matches(previousProperties); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/PrototypeServiceFactoryUse.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/PrototypeServiceFactoryUse.java index 12bda08f4..20a25f8fc 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/PrototypeServiceFactoryUse.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/PrototypeServiceFactoryUse.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,11 +24,11 @@ import org.osgi.framework.*; /** * This class represents the use of a service by a bundle. One is created for each - * service acquired by a bundle. - * + * service acquired by a bundle. + * * <p> * This class manages a prototype service factory. - * + * * @ThreadSafe */ public class PrototypeServiceFactoryUse<S> extends ServiceFactoryUse<S> { @@ -49,9 +49,9 @@ public class PrototypeServiceFactoryUse<S> extends ServiceFactoryUse<S> { /** * Create a new service object for the service. - * + * * <p> - * + * * @return The service object. */ /* @GuardedBy("this") */ @@ -79,7 +79,7 @@ public class PrototypeServiceFactoryUse<S> extends ServiceFactoryUse<S> { /** * Release a service object for the service. - * + * * @param service The service object to release. * @return true if the service was released; otherwise false. * @throws IllegalArgumentException If the specified service was not @@ -105,7 +105,7 @@ public class PrototypeServiceFactoryUse<S> extends ServiceFactoryUse<S> { /** * Release all uses of the service and reset the use count to zero. - * + * * <ol> * <li>The bundle's use count for this service is set to zero. * <li>The {@link PrototypeServiceFactory#ungetService(Bundle, ServiceRegistration, Object)} method @@ -127,7 +127,7 @@ public class PrototypeServiceFactoryUse<S> extends ServiceFactoryUse<S> { /** * Is this service use using any services? - * + * * @return true if no services are being used and this service use can be discarded. */ /* @GuardedBy("this") */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceConsumer.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceConsumer.java index 192f83048..1e62ea934 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceConsumer.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceConsumer.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,10 +16,10 @@ package org.eclipse.osgi.internal.serviceregistry; /** * Closure to allow sharing the same code for getting and ungetting a service. - * The {@link #prototypeConsumer} closure must be used for calls from + * The {@link #prototypeConsumer} closure must be used for calls from * ServiceObjects and the {@link #singletonConsumer} closure must be used * for calls from BundleContext. - * + * * The closure instance calls the correct method on the specified ServiceUse * object for the current service consumer type. */ @@ -56,7 +56,7 @@ public interface ServiceConsumer { /** * Get a service for the consumer. - * + * * @param use Service Use object to get the service from. * @return The obtained service. */ @@ -64,7 +64,7 @@ public interface ServiceConsumer { /** * Unget the service for the consumer. - * + * * @param use Service Use object to unget the service from. * @param service The Service to unget. * @return true if the service was ungotten, false otherwise. diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceFactoryUse.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceFactoryUse.java index cd55b5b54..18dff7ba1 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceFactoryUse.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceFactoryUse.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,11 +24,11 @@ import org.osgi.framework.*; /** * This class represents the use of a service by a bundle. One is created for each - * service acquired by a bundle. - * + * service acquired by a bundle. + * * <p> * This class manages a service factory. - * + * * @ThreadSafe */ public class ServiceFactoryUse<S> extends ServiceUse<S> { @@ -73,7 +73,7 @@ public class ServiceFactoryUse<S> extends ServiceUse<S> { * is called to create a service object for the context bundle. * This service object is cached. * While the use count is greater than zero, - * subsequent calls to get the service object + * subsequent calls to get the service object * will return the cached service object. * <br>If the service object returned by the {@link ServiceFactory} * is not an <code>instanceof</code> @@ -127,7 +127,7 @@ public class ServiceFactoryUse<S> extends ServiceUse<S> { /** * Unget a service's service object. - * + * * <p> * Decrements the use count if the service was being used. * @@ -166,7 +166,7 @@ public class ServiceFactoryUse<S> extends ServiceUse<S> { /** * Release all uses of the service and reset the use count to zero. - * + * * <ol> * <li>The bundle's use count for this service is set to zero. * <li>The {@link ServiceFactory#ungetService(Bundle, ServiceRegistration, Object)} method @@ -203,7 +203,7 @@ public class ServiceFactoryUse<S> extends ServiceUse<S> { /** * Call the service factory to get the service. - * + * * @return The service returned by the factory or null if there was an error. */ /* @GuardedBy("this") */ @@ -223,7 +223,7 @@ public class ServiceFactoryUse<S> extends ServiceUse<S> { } // allow the adaptor to handle this unexpected error context.getContainer().handleRuntimeError(t); - ServiceException se = new ServiceException(NLS.bind(Msg.SERVICE_FACTORY_EXCEPTION, factory.getClass().getName(), "getService"), ServiceException.FACTORY_EXCEPTION, t); //$NON-NLS-1$ + ServiceException se = new ServiceException(NLS.bind(Msg.SERVICE_FACTORY_EXCEPTION, factory.getClass().getName(), "getService"), ServiceException.FACTORY_EXCEPTION, t); //$NON-NLS-1$ context.getContainer().getEventPublisher().publishFrameworkEvent(FrameworkEvent.ERROR, registration.getBundle(), se); return null; } @@ -253,7 +253,7 @@ public class ServiceFactoryUse<S> extends ServiceUse<S> { /** * Call the service factory to unget the service. - * + * * @param service The service object to pass to the factory. */ /* @GuardedBy("this") */ @@ -272,7 +272,7 @@ public class ServiceFactoryUse<S> extends ServiceUse<S> { Debug.printStackTrace(t); } - ServiceException se = new ServiceException(NLS.bind(Msg.SERVICE_FACTORY_EXCEPTION, factory.getClass().getName(), "ungetService"), ServiceException.FACTORY_EXCEPTION, t); //$NON-NLS-1$ + ServiceException se = new ServiceException(NLS.bind(Msg.SERVICE_FACTORY_EXCEPTION, factory.getClass().getName(), "ungetService"), ServiceException.FACTORY_EXCEPTION, t); //$NON-NLS-1$ context.getContainer().getEventPublisher().publishFrameworkEvent(FrameworkEvent.ERROR, registration.getBundle(), se); } } diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceObjectsImpl.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceObjectsImpl.java index da22a81d8..6b924272d 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceObjectsImpl.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceObjectsImpl.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 *******************************************************************************/ @@ -44,7 +44,7 @@ public class ServiceObjectsImpl<S> implements ServiceObjects<S> { /** * Returns a service object for the {@link #getServiceReference() * referenced} service. - * + * * <p> * This {@code ServiceObjects} object can be used to obtain multiple service * objects for the referenced service if the service has @@ -54,11 +54,11 @@ public class ServiceObjectsImpl<S> implements ServiceObjects<S> { * as calling the {@link BundleContext#getService(ServiceReference)} method * for the referenced service. That is, only one, use-counted service object * is available from this {@link ServiceObjects} object. - * + * * <p> * This method will always return {@code null} when the referenced service * has been unregistered. - * + * * <p> * For a prototype scope service, the following steps are required to get * the service object: @@ -76,7 +76,7 @@ public class ServiceObjectsImpl<S> implements ServiceObjects<S> { * {@link ServiceException} describing the error is fired.</li> * <li>The service object is returned.</li> * </ol> - * + * * @return A service object for the referenced service or {@code null} if * the service is not registered, the service object returned by a * {@code ServiceFactory} does not implement the classes under which @@ -95,7 +95,7 @@ public class ServiceObjectsImpl<S> implements ServiceObjects<S> { /** * Releases a service object for the {@link #getServiceReference() * referenced} service. - * + * * <p> * This {@code ServiceObjects} object can be used to obtain multiple service * objects for the referenced service if the service has @@ -105,7 +105,7 @@ public class ServiceObjectsImpl<S> implements ServiceObjects<S> { * as calling the {@link BundleContext#ungetService(ServiceReference)} * method for the referenced service. That is, only one, use-counted service * object is available from this {@link ServiceObjects} object. - * + * * <p> * For a prototype scope service, the following steps are required to * release the service object: @@ -116,11 +116,11 @@ public class ServiceObjectsImpl<S> implements ServiceObjects<S> { * {@link PrototypeServiceFactory#ungetService(Bundle, ServiceRegistration, Object)} * method is called to release the specified service object.</li> * </ol> - * + * * <p> * The specified service object must no longer be used and all references to * it should be destroyed after calling this method. - * + * * @param service A service object previously provided by this * {@code ServiceObjects} object. * @throws IllegalStateException If the BundleContext used to create this @@ -144,7 +144,7 @@ public class ServiceObjectsImpl<S> implements ServiceObjects<S> { /** * Returns the {@link ServiceReference} for the service associated with this * {@code ServiceObjects} object. - * + * * @return The {@link ServiceReference} for the service associated with this * {@code ServiceObjects} object. */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceProperties.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceProperties.java index 982d0029e..29ac598bb 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceProperties.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceProperties.java @@ -23,7 +23,7 @@ import org.osgi.framework.Constants; /** * Service properties. - * + * * Supports case-insensitive key lookup. */ class ServiceProperties extends CaseInsensitiveDictionaryMap<String, Object> { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceReferenceImpl.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceReferenceImpl.java index a1887a767..3cafc1623 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceReferenceImpl.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceReferenceImpl.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 org.osgi.framework.*; /** * A reference to a service. - * + * * <p> * The Framework returns <code>ServiceReference</code> objects from the * <code>BundleContext.getServiceReference</code> and @@ -40,7 +40,7 @@ import org.osgi.framework.*; * If the same service object is registered multiple times, * <code>ServiceReference</code> objects associated with different * <code>ServiceRegistration</code> objects are not equal. - * + * * @see BundleContext#getServiceReference * @see BundleContext#getServiceReferences * @see BundleContext#getService @@ -66,16 +66,16 @@ public class ServiceReferenceImpl<S> implements ServiceReference<S> { * Returns the property value to which the specified property key is mapped * in the properties <code>Dictionary</code> object of the service * referenced by this <code>ServiceReference</code> object. - * + * * <p> * Property keys are case-insensitive. - * + * * <p> * This method must continue to return property values after the service has * been unregistered. This is so references to unregistered services (for * example, <code>ServiceReference</code> objects stored in the log) can * still be interrogated. - * + * * @param key The property key. * @return The property value to which the key is mapped; <code>null</code> * if there is no property named after the key. @@ -89,20 +89,20 @@ public class ServiceReferenceImpl<S> implements ServiceReference<S> { * Returns an array of the keys in the properties <code>Dictionary</code> * object of the service referenced by this <code>ServiceReference</code> * object. - * + * * <p> * This method will continue to return the keys after the service has been * unregistered. This is so references to unregistered services (for * example, <code>ServiceReference</code> objects stored in the log) can * still be interrogated. - * + * * <p> * This method is <i>case-preserving </i>; this means that every key in the * returned array must have the same case as the corresponding key in the * properties <code>Dictionary</code> that was passed to the * {@link BundleContext#registerService(String[],Object,java.util.Dictionary)} * or {@link ServiceRegistration#setProperties} methods. - * + * * @return An array of property keys. */ @Override @@ -113,12 +113,12 @@ public class ServiceReferenceImpl<S> implements ServiceReference<S> { /** * Returns the bundle that registered the service referenced by this * <code>ServiceReference</code> object. - * + * * <p> * This method must return <code>null</code> when the service has been * unregistered. This can be used to determine if the service has been * unregistered. - * + * * @return The bundle that registered the service referenced by this * <code>ServiceReference</code> object; <code>null</code> if * that service has already been unregistered. @@ -133,12 +133,12 @@ public class ServiceReferenceImpl<S> implements ServiceReference<S> { * Returns the bundles that are using the service referenced by this * <code>ServiceReference</code> object. Specifically, this method returns * the bundles whose usage count for that service is greater than zero. - * + * * @return An array of bundles whose usage count for the service referenced * by this <code>ServiceReference</code> object is greater than * zero; <code>null</code> if no bundles are currently using that * service. - * + * * @since 1.1 */ @Override @@ -163,14 +163,14 @@ public class ServiceReferenceImpl<S> implements ServiceReference<S> { * package source of the specified bundle then return <code>true</code>; * otherwise return <code>false</code>.</li> * </ol> - * + * * @param bundle The <code>Bundle</code> object to check. * @param className The class name to check. * @return <code>true</code> if the bundle which registered the service * referenced by this <code>ServiceReference</code> and the * specified bundle use the same source for the package of the * specified class name. Otherwise <code>false</code> is returned. - * + * * @since 1.3 */ @Override @@ -181,7 +181,7 @@ public class ServiceReferenceImpl<S> implements ServiceReference<S> { /** * Compares this <code>ServiceReference</code> with the specified * <code>ServiceReference</code> for order. - * + * * <p> * If this <code>ServiceReference</code> and the specified * <code>ServiceReference</code> have the same @@ -196,7 +196,7 @@ public class ServiceReferenceImpl<S> implements ServiceReference<S> { * <code>ServiceReference</code> if it has a higher * {@link Constants#SERVICE_ID service id} and greater if it has a lower * service id. - * + * * @param object The <code>ServiceReference</code> to be compared. * @return Returns a negative integer, zero, or a positive integer if this * <code>ServiceReference</code> is less than, equal to, or @@ -270,7 +270,7 @@ public class ServiceReferenceImpl<S> implements ServiceReference<S> { /** * Return the ServiceRegistrationImpl for this ServiceReferenceImpl. - * + * * @return The ServiceRegistrationImpl for this ServiceReferenceImpl. */ public ServiceRegistrationImpl<S> getRegistration() { @@ -309,7 +309,7 @@ public class ServiceReferenceImpl<S> implements ServiceReference<S> { * {@link ServiceRegistration#setProperties(Dictionary)} must be called to * modify the properties of the service.</li> * </ul> - * + * * @return A copy of the properties of the service referenced by this * {@code ServiceReference} object * @since 1.9 diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceRegistrationImpl.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceRegistrationImpl.java index 9c9f09bd0..09a0c8277 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceRegistrationImpl.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceRegistrationImpl.java @@ -35,7 +35,7 @@ import org.osgi.framework.*; * the service. This implies that if a * bundle wants to keep its service registered, it should keep the * ServiceRegistration object referenced. - * + * * @ThreadSafe */ public class ServiceRegistrationImpl<S> implements ServiceRegistration<S>, Comparable<ServiceRegistrationImpl<?>> { @@ -57,7 +57,7 @@ public class ServiceRegistrationImpl<S> implements ServiceRegistration<S>, Compa /* @GuardedBy("registrationLock") */ private ServiceReferenceImpl<S> reference; - /** List of contexts using the service. + /** List of contexts using the service. * List<BundleContextImpl>. * */ /* @GuardedBy("registrationLock") */ @@ -258,7 +258,7 @@ public class ServiceRegistrationImpl<S> implements ServiceRegistration<S>, Compa /** * Is this registration unregistered? - * + * * @return true if unregistered; otherwise false. */ boolean isUnregistered() { @@ -454,7 +454,7 @@ public class ServiceRegistrationImpl<S> implements ServiceRegistration<S>, Compa } /** - * This method returns the bundle which registered the + * This method returns the bundle which registered the * service regardless of the registration status of this * service registration. This is not an OSGi specified * method. @@ -529,7 +529,7 @@ public class ServiceRegistrationImpl<S> implements ServiceRegistration<S>, Compa } S serviceObject = consumer.getService(use); /* if the service factory failed to return an object and - * we created the service use, then remove the + * we created the service use, then remove the * optimistically added ServiceUse. */ if ((serviceObject == null) && added) { synchronized (servicesInUse) { @@ -546,7 +546,7 @@ public class ServiceRegistrationImpl<S> implements ServiceRegistration<S>, Compa /** * Create a new ServiceObjects for the requesting bundle. - * + * * @param user The requesting bundle. * @return A new ServiceObjects for this service and the requesting bundle. */ @@ -563,7 +563,7 @@ public class ServiceRegistrationImpl<S> implements ServiceRegistration<S>, Compa /** * Create a new ServiceUse object for this service and user. - * + * * @param user The bundle using this service. * @return The ServiceUse object for the bundle using this service. */ @@ -717,12 +717,12 @@ public class ServiceRegistrationImpl<S> implements ServiceRegistration<S>, Compa /** * Compares this <code>ServiceRegistrationImpl</code> with the specified * <code>ServiceRegistrationImpl</code> for order. - * + * * <p> * This does a reverse comparison so that the highest item is sorted to the left. * We keep ServiceRegistationImpls in sorted lists such that the highest * ranked service is at element 0 for quick retrieval. - * + * * @param other The <code>ServiceRegistrationImpl</code> to be compared. * @return Returns a negative integer, zero, or a positive integer if this * <code>ServiceRegistrationImpl</code> is greater than, equal to, or diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceRegistry.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceRegistry.java index d53f3b246..36ceb9790 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceRegistry.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceRegistry.java @@ -60,9 +60,9 @@ import org.osgi.framework.hooks.service.ListenerHook; import org.osgi.framework.hooks.service.ListenerHook.ListenerInfo; /** - * The Service Registry. This class is the main control point for service + * The Service Registry. This class is the main control point for service * layer operations in the framework. - * + * * @ThreadSafe */ public class ServiceRegistry { @@ -74,23 +74,23 @@ public class ServiceRegistry { static final String eventListenerHookName = EventListenerHook.class.getName(); static final String listenerHookName = ListenerHook.class.getName(); - /** Published services by class name. - * The {@literal List<ServiceRegistrationImpl<?>>}s are both sorted + /** Published services by class name. + * The {@literal List<ServiceRegistrationImpl<?>>}s are both sorted * in the natural order of ServiceRegistrationImpl and also are sets in that * there must be no two entries in a List which are equal. */ /* @GuardedBy("this") */ private final Map<String, List<ServiceRegistrationImpl<?>>> publishedServicesByClass; - /** All published services. + /** All published services. * The List is both sorted in the natural order of ServiceRegistrationImpl and also is a * set in that there must be no two entries in the List which are equal. */ /* @GuardedBy("this") */ private final List<ServiceRegistrationImpl<?>> allPublishedServices; - /** Published services by BundleContextImpl. - * The {@literal List<ServiceRegistrationImpl<?>>}s are NOT sorted + /** Published services by BundleContextImpl. + * The {@literal List<ServiceRegistrationImpl<?>>}s are NOT sorted * and also are sets in that * there must be no two entries in a List which are equal. */ @@ -142,12 +142,12 @@ public class ServiceRegistry { * bundles. The registering bundle is defined to be the context bundle. * Other bundles can locate the service by using either the * {@link #getServiceReferences} or {@link #getServiceReference} method. - * + * * <p> * A bundle can register a service object that implements the * {@link ServiceFactory} interface to have more flexibility in providing * service objects to other bundles. - * + * * <p> * The following steps are required to register a service: * <ol> @@ -168,7 +168,7 @@ public class ServiceRegistry { * <li>A <code>ServiceRegistration</code> object for this registration is * returned. * </ol> - * + * * @param context The BundleContext of the registering bundle. * @param clazzes The class names under which the service can be located. * The class names in this array will be stored in the service's @@ -183,11 +183,11 @@ public class ServiceRegistry { * {@link ServiceRegistration#setProperties} method must be called. * The set of properties may be <code>null</code> if the service * has no properties. - * + * * @return A <code>ServiceRegistrationImpl</code> object for use by the bundle * registering the service to update the service's properties or to * unregister the service. - * + * * @throws java.lang.IllegalArgumentException If one of the following is * true: * <ul> @@ -198,15 +198,15 @@ public class ServiceRegistry { * <li><code>properties</code> contains case variants of the same * key name. * </ul> - * + * * @throws java.lang.SecurityException If the caller does not have the * <code>ServicePermission</code> to register the service for all * the named classes and the Java Runtime Environment supports * permissions. - * + * * @throws java.lang.IllegalStateException If this BundleContext is no * longer valid. - * + * * @see ServiceRegistration * @see ServiceFactory */ @@ -269,23 +269,23 @@ public class ServiceRegistry { * criteria, and the packages for the class names under which the services * were registered match the context bundle's packages as defined in * {@link ServiceReference#isAssignableTo(Bundle, String)}. - * + * * <p> * The list is valid at the time of the call to this method, however since * the Framework is a very dynamic environment, services can be modified or * unregistered at anytime. - * + * * <p> * <code>filter</code> is used to select the registered service whose * properties objects contain keys and values which satisfy the filter. See * {@link Filter} for a description of the filter string syntax. - * + * * <p> * If <code>filter</code> is <code>null</code>, all registered services * are considered to match the filter. If <code>filter</code> cannot be * parsed, an {@link InvalidSyntaxException} will be thrown with a human * readable message where the filter became unparsable. - * + * * <p> * The following steps are required to select a set of * <code>ServiceReferenceImpl</code> objects: @@ -320,7 +320,7 @@ public class ServiceRegistry { * <li>An array of the remaining <code>ServiceReferenceImpl</code> objects is * returned. * </ol> - * + * * @param context The BundleContext of the requesting bundle. * @param clazz The class name with which the service was registered or * <code>null</code> for all services. @@ -379,12 +379,12 @@ public class ServiceRegistry { /** * Returns a <code>ServiceReference</code> object for a service that * implements and was registered under the specified class. - * + * * <p> * This <code>ServiceReference</code> object is valid at the time of the * call to this method, however as the Framework is a very dynamic * environment, services can be modified or unregistered at anytime. - * + * * <p> * This method is the same as calling * {@link BundleContext#getServiceReferences(String, String)} with a @@ -398,7 +398,7 @@ public class ServiceRegistry { * If there is a tie in ranking, the service with the lowest service ID (as * specified in its {@link Constants#SERVICE_ID} property); that is, the * service that was registered first is returned. - * + * * @param context The BundleContext of the requesting bundle. * @param clazz The class name with which the service was registered. * @return A <code>ServiceReference</code> object, or <code>null</code> @@ -441,11 +441,11 @@ public class ServiceRegistry { * <p> * When a bundle's use count for a service drops to zero, the bundle should * no longer use that service. - * + * * <p> * This method will always return <code>null</code> when the service * associated with this <code>reference</code> has been unregistered. - * + * * <p> * The following steps are required to get the service object: * <ol> @@ -470,7 +470,7 @@ public class ServiceRegistry { * describing the error is fired. * <li>The service object for the service is returned. * </ol> - * + * * @param context The BundleContext of the requesting bundle. * @param reference A reference to the service. * @return A service object for the service associated with @@ -497,7 +497,7 @@ public class ServiceRegistry { /** * Returns the {@link ServiceObjects} object for the service referenced by * the specified {@code ServiceReference} object. - * + * * <p> * The {@link ServiceObjects} object can be used to obtain multiple * service objects for services with {@link Constants#SCOPE_PROTOTYPE @@ -509,11 +509,11 @@ public class ServiceRegistry { * the {@link BundleContext#ungetService(ServiceReference)} method. That is, only one, * use-counted service object is available from the {@link ServiceObjects} * object. - * + * * <p> * This method will always return {@code null} when the service associated * with the specified {@code reference} has been unregistered. - * + * * @param <S> Type of Service. * @param context The BundleContext of the requesting bundle. * @param reference A reference to the service. @@ -536,12 +536,12 @@ public class ServiceRegistry { * for the service is zero, this method returns <code>false</code>. * Otherwise, the context bundle's use count for the service is decremented * by one. - * + * * <p> * The service's service object should no longer be used and all references * to it should be destroyed when a bundle's use count for the service drops * to zero. - * + * * <p> * The following steps are required to unget the service object: * <ol> @@ -556,7 +556,7 @@ public class ServiceRegistry { * method is called to release the service object for the context bundle. * <li><code>true</code> is returned. * </ol> - * + * * @param context The BundleContext of the requesting bundle. * @param reference A reference to the service to be released. * @return <code>false</code> if the context bundle's use count for the @@ -577,18 +577,18 @@ public class ServiceRegistry { * Returns this bundle's <code>ServiceReference</code> list for all * services it has registered or <code>null</code> if this bundle has no * registered services. - * + * * <p> * If the Java runtime supports permissions, a <code>ServiceReference</code> * object to a service is included in the returned list only if the caller * has the <code>ServicePermission</code> to get the service using at * least one of the named classes the service was registered under. - * + * * <p> * The list is valid at the time of the call to this method, however, as the * Framework is a very dynamic environment, services can be modified or * unregistered at anytime. - * + * * @param context The BundleContext of the requesting bundle. * @return An array of <code>ServiceReference</code> objects or * <code>null</code>. @@ -629,7 +629,7 @@ public class ServiceRegistry { * services it is using or returns <code>null</code> if this bundle is not * using any services. A bundle is considered to be using a service if its * use count for that service is greater than zero. - * + * * <p> * If the Java Runtime Environment supports permissions, a * <code>ServiceReference</code> object to a service is included in the @@ -640,7 +640,7 @@ public class ServiceRegistry { * The list is valid at the time of the call to this method, however, as the * Framework is a very dynamic environment, services can be modified or * unregistered at anytime. - * + * * @param context The BundleContext of the requesting bundle. * @return An array of <code>ServiceReference</code> objects or * <code>null</code>. @@ -689,7 +689,7 @@ public class ServiceRegistry { /** * Called when the BundleContext is closing to unregister all services * currently registered by the bundle. - * + * * @param context The BundleContext of the closing bundle. */ public void unregisterServices(BundleContextImpl context) { @@ -706,7 +706,7 @@ public class ServiceRegistry { /** * Called when the BundleContext is closing to unget all services * currently used by the bundle. - * + * * @param context The BundleContext of the closing bundle. */ public void releaseServicesInUse(BundleContextImpl context) { @@ -731,7 +731,7 @@ public class ServiceRegistry { /** * Add a new Service Listener for a bundle. - * + * * @param context Context of bundle adding listener. * @param listener Service Listener to be added. * @param filter Filter string for listener or null. @@ -766,7 +766,7 @@ public class ServiceRegistry { /** * Remove a Service Listener for a bundle. - * + * * @param context Context of bundle removing listener. * @param listener Service Listener to be removed. */ @@ -795,7 +795,7 @@ public class ServiceRegistry { /** * Remove all Service Listener for a bundle. - * + * * @param context Context of bundle removing all listeners. */ public void removeAllServiceListeners(BundleContextImpl context) { @@ -826,7 +826,7 @@ public class ServiceRegistry { /** * Deliver a ServiceEvent. - * + * * @param event The ServiceEvent to deliver. */ public void publishServiceEvent(final ServiceEvent event) { @@ -909,7 +909,7 @@ public class ServiceRegistry { /** * Return the next available service id. - * + * * @return next service id. */ synchronized long getNextServiceId() { @@ -920,7 +920,7 @@ public class ServiceRegistry { /** * Add the ServiceRegistrationImpl to the data structure. - * + * * @param context The BundleContext of the bundle registering the service. * @param registration The new ServiceRegistration. */ @@ -959,7 +959,7 @@ public class ServiceRegistry { /** * Modify the ServiceRegistrationImpl in the data structure. - * + * * @param context The BundleContext of the bundle registering the service. * @param registration The modified ServiceRegistration. */ @@ -990,7 +990,7 @@ public class ServiceRegistry { /** * Remove the ServiceRegistrationImpl from the data structure. - * + * * @param context The BundleContext of the bundle registering the service. * @param registration The ServiceRegistration to remove. */ @@ -1018,7 +1018,7 @@ public class ServiceRegistry { /** * Lookup Service Registrations in the data structure by class name and filter. - * + * * @param clazz The class name with which the service was registered or * <code>null</code> for all services. * @param filter The filter criteria. @@ -1064,7 +1064,7 @@ public class ServiceRegistry { /** * Lookup Service Registrations in the data structure by BundleContext. - * + * * @param context The BundleContext for which to return Service Registrations. * @return List<ServiceRegistrationImpl> */ @@ -1081,7 +1081,7 @@ public class ServiceRegistry { /** * Remove Service Registrations in the data structure by BundleContext. - * + * * @param context The BundleContext for which to remove Service Registrations. */ private synchronized void removeServiceRegistrations(BundleContextImpl context) { @@ -1090,7 +1090,7 @@ public class ServiceRegistry { /** * Check for permission to register a service. - * + * * The caller must have permission for ALL names. */ private static void checkRegisterServicePermission(String[] names) { @@ -1130,8 +1130,8 @@ public class ServiceRegistry { return domain.implies(new ServicePermission(event.getServiceReference(), ServicePermission.GET)); } - /** - * Return the name of the class that is not satisfied by the service object. + /** + * Return the name of the class that is not satisfied by the service object. * @param clazzes Array of class names. * @param serviceObject Service object. * @return The name of the class that is not satisfied by the service object. @@ -1184,7 +1184,7 @@ public class ServiceRegistry { * Call the registered FindHook services to allow them to inspect and possibly shrink the result. * The FindHook must be called in order: descending by service.ranking, then ascending by service.id. * This is the natural order for ServiceReference. - * + * * @param context The context of the bundle getting the service references. * @param clazz The class name used to search for the service references. * @param filterstring The filter used to search for the service references. @@ -1238,13 +1238,13 @@ public class ServiceRegistry { * Call the registered EventHook services to allow them to inspect and possibly shrink the result. * The EventHooks must be called in order: descending by service.ranking, then ascending by service.id. * This is the natural order for ServiceReference. - * + * * @param event The service event to be delivered. * @param result The result to return to the caller which may have been shrunk by the EventHooks. */ private void notifyEventHooksPrivileged(final ServiceEvent event, final Collection<BundleContext> result) { if (debug.DEBUG_HOOKS) { - Debug.println("notifyServiceEventHooks(" + event.getType() + ":" + event.getServiceReference() + "," + result + ")"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ + Debug.println("notifyServiceEventHooks(" + event.getType() + ":" + event.getServiceReference() + "," + result + ")"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ } notifyHooksPrivileged(new HookContext() { @SuppressWarnings("deprecation") @@ -1276,13 +1276,13 @@ public class ServiceRegistry { * Call the registered EventListenerHook services to allow them to inspect and possibly shrink the result. * The EventListenerHooks must be called in order: descending by service.ranking, then ascending by service.id. * This is the natural order for ServiceReference. - * + * * @param event The service event to be delivered. * @param result The result to return to the caller which may have been shrunk by the EventListenerHooks. */ private void notifyEventListenerHooksPrivileged(final ServiceEvent event, final Map<BundleContext, Collection<ListenerInfo>> result) { if (debug.DEBUG_HOOKS) { - Debug.println("notifyServiceEventListenerHooks(" + event.getType() + ":" + event.getServiceReference() + "," + result + ")"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ + Debug.println("notifyServiceEventListenerHooks(" + event.getType() + ":" + event.getServiceReference() + "," + result + ")"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ } notifyHooksPrivileged(new HookContext() { @Override @@ -1311,7 +1311,7 @@ public class ServiceRegistry { /** * Calls all hook services of the type specified by the hook context. - * + * * @param hookContext Context to use when calling the hook services. */ public void notifyHooksPrivileged(HookContext hookContext) { @@ -1326,7 +1326,7 @@ public class ServiceRegistry { /** * Call a hook service via a hook context. - * + * * @param context Context of the bundle to get the hook service. * @param registration Hook service to call. * @param hookContext Context to use when calling the hook service. @@ -1358,7 +1358,7 @@ public class ServiceRegistry { /** * Call a newly registered ListenerHook service to provide the current collection of * service listeners. - * + * * @param registration The newly registered ListenerHook service. */ private void notifyNewListenerHook(final ServiceRegistrationImpl<?> registration) { @@ -1378,7 +1378,7 @@ public class ServiceRegistry { void notifyNewListenerHookPrivileged(ServiceRegistrationImpl<?> registration) { if (debug.DEBUG_HOOKS) { - Debug.println("notifyServiceNewListenerHook(" + registration + ")"); //$NON-NLS-1$ //$NON-NLS-2$ + Debug.println("notifyServiceNewListenerHook(" + registration + ")"); //$NON-NLS-1$ //$NON-NLS-2$ } // snapshot the listeners @@ -1421,9 +1421,9 @@ public class ServiceRegistry { * Call the registered ListenerHook services to notify them of newly added or removed service listeners. * The ListenerHook must be called in order: descending by service.ranking, then ascending by service.id. * This is the natural order for ServiceReference. - * - * @param listeners A non-empty, unmodifiable collection of ListenerInfo objects. - * All elements in the list must be for the same bundle. + * + * @param listeners A non-empty, unmodifiable collection of ListenerInfo objects. + * All elements in the list must be for the same bundle. * @param added <code>true</code> if the specified listeners are being added. <code>false</code> * if they are being removed. */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceUse.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceUse.java index 54b0ef021..7575322f6 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceUse.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ServiceUse.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 *******************************************************************************/ @@ -20,11 +20,11 @@ import org.osgi.framework.ServiceException; /** * This class represents the use of a service by a bundle. One is created for each - * service acquired by a bundle. - * + * service acquired by a bundle. + * * <p> * This class manages a singleton service. - * + * * @ThreadSafe */ public class ServiceUse<S> { @@ -60,10 +60,10 @@ public class ServiceUse<S> { /** * Unget a service's service object. - * + * * <p> * Decrements the use count if the service was being used. - * + * * @return true if the service was ungotten; otherwise false. */ /* @GuardedBy("this") */ @@ -88,10 +88,10 @@ public class ServiceUse<S> { /** * Get a new service object for the service. - * + * * <p> * By default, this returns the result of {@link #getService()}. - * + * * @return The service object. */ /* @GuardedBy("this") */ @@ -101,10 +101,10 @@ public class ServiceUse<S> { /** * Release a service object for the service. - * + * * <p> * By default, this returns the result of {@link #ungetService()}. - * + * * @param service The service object to release. * @return true if the service was released; otherwise false. * @throws IllegalArgumentException If the specified service was not @@ -129,7 +129,7 @@ public class ServiceUse<S> { /** * Is this service use using any services? - * + * * @return true if no services are being used and this service use can be discarded. */ /* @GuardedBy("this") */ @@ -140,7 +140,7 @@ public class ServiceUse<S> { /** * Is the use count non zero? - * + * * @return true if the use count is greater than zero. */ /* @GuardedBy("this") */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ShrinkableCollection.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ShrinkableCollection.java index 43e41bd11..f770d9d6e 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ShrinkableCollection.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ShrinkableCollection.java @@ -19,12 +19,12 @@ import java.util.*; /** * A Shrinkable Collection. This class provides a wrapper for a list of collections * that allows items to be removed from the wrapped collections (shrinking) but - * does not allow items to be added to the wrapped collections. - * + * does not allow items to be added to the wrapped collections. + * * <p> * The collections must act as sets in that each collection in the list * must not have two entries which are equal. - * + * * <p> * All the optional <code>Collection</code> operations except * <code>add</code> and <code>addAll</code> are supported. Attempting to add to the diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ShrinkableValueCollectionMap.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ShrinkableValueCollectionMap.java index b3190bad0..34b337dfd 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ShrinkableValueCollectionMap.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/serviceregistry/ShrinkableValueCollectionMap.java @@ -120,7 +120,7 @@ public class ShrinkableValueCollectionMap<K, V> extends AbstractMap<K, Collectio } } - /** + /** * Iterator class used for entry sets. */ private final class EntryIterator implements Iterator<Map.Entry<K, Collection<V>>> { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/BERProcessor.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/BERProcessor.java index 9c6742a8f..567c78abd 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/BERProcessor.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/BERProcessor.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 *******************************************************************************/ @@ -83,11 +83,11 @@ public class BERProcessor { /** * Constructs a BERProcessor to operate on the passed buffer. The first structure in the * buffer will be processed before this method returns. - * + * * @param buffer the buffer containing the BER structures. * @param offset the offset into <code>buffer</code> to the start of the first structure. * @param len the length of the BER structure. - * @throws SignatureException + * @throws SignatureException */ public BERProcessor(byte buffer[], int offset, int len) throws SignatureException { this.buffer = buffer; @@ -98,7 +98,7 @@ public class BERProcessor { /** * Parse the structure found at the current <code>offset</code> into <code>buffer</code>. - * Most methods, constructor, and stepinto, will call this method automatically. If + * Most methods, constructor, and stepinto, will call this method automatically. If * <code>offset</code> is modified outside of those methods, this method will need to * be invoked. */ @@ -197,7 +197,7 @@ public class BERProcessor { /** * Returns a BERProcessor for the content of the current structure. - * @throws SignatureException + * @throws SignatureException */ public BERProcessor stepInto() throws SignatureException { return new BERProcessor(buffer, contentOffset, contentLength); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/Base64.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/Base64.java index d6d552852..940b6b5d8 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/Base64.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/Base64.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 *******************************************************************************/ @@ -26,7 +26,7 @@ public class Base64 { * This method decodes the byte array in base 64 encoding into a char array * Base 64 encoding has to be according to the specification given by the * RFC 1521 (5.2). - * + * * @param data the encoded byte array * @return the decoded byte array */ @@ -110,7 +110,7 @@ public class Base64 { /** * This method converts a Base 64 digit to its numeric value. - * + * * @param data digit (character) to convert * @return value for the digit */ @@ -135,7 +135,7 @@ public class Base64 { /** * This method encodes the byte array into a char array in base 64 according * to the specification given by the RFC 1521 (5.2). - * + * * @param data the encoded char array * @return the byte array that needs to be encoded */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/DigestedInputStream.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/DigestedInputStream.java index 3c39a4f90..812bcad8c 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/DigestedInputStream.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/DigestedInputStream.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,12 +40,12 @@ class DigestedInputStream extends FilterInputStream { * Constructs an InputStream that uses another InputStream as a source and * calculates the digest. At the end of the stream an exception will be * thrown if the calculated digest doesn't match the passed digest. - * + * * @param in the stream to use as an input source. * @param signerInfos the signers. * @param results the expected digest. - * @throws IOException - * @throws NoSuchAlgorithmException + * @throws IOException + * @throws NoSuchAlgorithmException */ DigestedInputStream(BundleEntry entry, BundleFile bundleFile, SignerInfo[] signerInfos, byte results[][], long size) throws IOException, NoSuchAlgorithmException { super(entry.getInputStream()); @@ -77,7 +77,7 @@ class DigestedInputStream extends FilterInputStream { /** * Read a byte from the InputStream. Digests are calculated on reads. At the * end of the stream the calculated digests must match the expected digests. - * + * * @return the character read or -1 at end of stream. * @throws IOException if there was an problem reading the byte or at the * end of the stream the calculated digests do not match the @@ -115,7 +115,7 @@ class DigestedInputStream extends FilterInputStream { /** * Read bytes from the InputStream. Digests are calculated on reads. At the * end of the stream the calculated digests must match the expected digests. - * + * * @return the number of characters read or -1 at end of stream. * @throws IOException if there was an problem reading or at the * end of the stream the calculated digests do not match the @@ -143,7 +143,7 @@ class DigestedInputStream extends FilterInputStream { /** * Not supported. - * + * * @throws IOException always thrown if this method is called since mark/reset is not supported. * @see java.io.InputStream#reset() */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/PKCS7DateParser.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/PKCS7DateParser.java index 1e394f8ac..7bb56d42b 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/PKCS7DateParser.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/PKCS7DateParser.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 ******************************************************************************/ package org.eclipse.osgi.internal.signedcontent; diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/PKCS7Processor.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/PKCS7Processor.java index 394ce0147..d8db5d543 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/PKCS7Processor.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/PKCS7Processor.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 ******************************************************************************/ package org.eclipse.osgi.internal.signedcontent; @@ -228,7 +228,7 @@ public class PKCS7Processor implements SignedContentConstants { int noS = dateString.indexOf('Z') - 1 - dotIndex; dateFormatSB.append('.'); - // append s + // append s for (int i = 0; i < noS; i++) { dateFormatSB.append('s'); } @@ -237,8 +237,8 @@ public class PKCS7Processor implements SignedContentConstants { try { // if the current locale is th_TH, or ja_JP_JP, then our dateFormat object will end up with - // a calendar such as Buddhist or Japanese Imperial Calendar, and the signing time will be - // incorrect ... so always use English as the locale for parsing the time, resulting in a + // a calendar such as Buddhist or Japanese Imperial Calendar, and the signing time will be + // incorrect ... so always use English as the locale for parsing the time, resulting in a // Gregorian calendar DateFormat dateFormt = new SimpleDateFormat(dateFormatSB.toString(), Locale.ENGLISH); dateFormt.setTimeZone(TimeZone.getTimeZone("GMT")); //$NON-NLS-1$ @@ -305,7 +305,7 @@ public class PKCS7Processor implements SignedContentConstants { } private Certificate processSignerInfos(BERProcessor bp, List<Certificate> certs) throws CertificateException, NoSuchAlgorithmException, SignatureException { - // We assume there is only one SingerInfo element + // We assume there is only one SingerInfo element // PKCS7: SignerINFOS processing bp = bp.stepInto(); // Step into the set of signerinfos @@ -317,7 +317,7 @@ public class PKCS7Processor implements SignedContentConstants { throw new CertificateException(SignedContentMessages.PKCS7_SignerInfo_Version_Not_Supported); } - // PKCS7: version CMSVersion + // PKCS7: version CMSVersion bp.stepOver(); // Skip the version // PKCS7: sid [SignerIdentifier : issuerAndSerialNumber or subjectKeyIdentifer] @@ -367,7 +367,7 @@ public class PKCS7Processor implements SignedContentConstants { // PKCS7: signature signature = bp.getBytes(); - // PKCS7: Step into the unsignedAttrs, + // PKCS7: Step into the unsignedAttrs, bp.stepOver(); // process the unsigned attributes if there is any @@ -383,7 +383,7 @@ public class PKCS7Processor implements SignedContentConstants { // there are some unsignedAttrs are found!! unsignedAttrs = new HashMap<>(); - // step into a set of unsigned attributes, I believe, when steps + // step into a set of unsigned attributes, I believe, when steps // into here, the 'poiter' is pointing to the first element BERProcessor unsignedAttrsBERS = bp.stepInto(); do { @@ -445,7 +445,7 @@ public class PKCS7Processor implements SignedContentConstants { /** * Return a map of signed attributes, the key(objid) = value(PKCSBlock in bytes for the key) - * + * * @return map if there is any signed attributes, null otherwise */ public Map<int[], byte[]> getUnsignedAttrs() { @@ -454,7 +454,7 @@ public class PKCS7Processor implements SignedContentConstants { /** * Return a map of signed attributes, the key(objid) = value(PKCSBlock in bytes for the key) - * + * * @return map if there is any signed attributes, null otherwise */ public Map<int[], byte[]> getSignedAttrs() { @@ -462,12 +462,12 @@ public class PKCS7Processor implements SignedContentConstants { } /** - * + * * @param bp * @return a List of certificates from target cert to root cert in order - * + * * @throws CertificateException - * @throws SignatureException + * @throws SignatureException */ private List<Certificate> processCertificates(BERProcessor bp) throws CertificateException, SignatureException { List<Certificate> rtvList = new ArrayList<>(3); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignatureBlockProcessor.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignatureBlockProcessor.java index e3eb1a381..defe49a31 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignatureBlockProcessor.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignatureBlockProcessor.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 ******************************************************************************/ package org.eclipse.osgi.internal.signedcontent; @@ -103,7 +103,7 @@ public class SignatureBlockProcessor implements SignedContentConstants { be = bf.getEntry(signer.substring(0, dotIndex) + DOT_SF); byte sfBytes[] = readIntoArray(be); - // Step 1, verify the .SF file is signed by the private key that corresponds to the public key + // Step 1, verify the .SF file is signed by the private key that corresponds to the public key // in the .RSA/.DSA file String baseFile = bf.getBaseFile() != null ? bf.getBaseFile().toString() : null; PKCS7Processor processor = new PKCS7Processor(pkcs7Bytes, 0, pkcs7Bytes.length, signer, baseFile); @@ -138,7 +138,7 @@ public class SignatureBlockProcessor implements SignedContentConstants { /** * Verify the digest listed in each entry in the .SF file with corresponding section in the manifest - * @throws SignatureException + * @throws SignatureException */ private void verifyManifestAndSignatureFile(byte[] manifestBytes, byte[] sfBytes) throws SignatureException { @@ -163,7 +163,7 @@ public class SignatureBlockProcessor implements SignedContentConstants { manifestDigest = calculateDigest(getMessageDigest(digestName), manifestBytes); off += digestManifestSearchLen; - // find out the index of first '\n' after the -Digest-Manifest: + // find out the index of first '\n' after the -Digest-Manifest: int nIndex = sf.indexOf('\n', off); String digestValue = sf.substring(off, nIndex - 1); @@ -334,10 +334,10 @@ public class SignatureBlockProcessor implements SignedContentConstants { } /** - * Read the .SF file abd assuming that same digest algorithm will be used through out the whole - * .SF file. That digest algorithm name in the last entry will be returned. - * - * @param SFBuf a .SF file in bytes + * Read the .SF file abd assuming that same digest algorithm will be used through out the whole + * .SF file. That digest algorithm name in the last entry will be returned. + * + * @param SFBuf a .SF file in bytes * @return the digest algorithm name used in the .SF file */ private static String getDigAlgFromSF(byte SFBuf[]) { @@ -378,16 +378,16 @@ public class SignatureBlockProcessor implements SignedContentConstants { } /** - * + * * @param manifestEntry contains a single MF file entry of the format * "Name: foo" * "MD5-Digest: [base64 encoded MD5 digest data]" * "SHA1-Digest: [base64 encoded SHA1 digest dat]" - * + * * @param desireDigestAlg a string representing the desire digest value to be returned if there are * multiple digest lines. * If this value is null, return whatever digest value is in the entry. - * + * * @return this function returns a digest line based on the desire digest algorithm value * (since only MD5 and SHA1 are recognized here), * or a 'null' will be returned if none of the digest algorithms @@ -445,8 +445,8 @@ public class SignatureBlockProcessor implements SignedContentConstants { /** * Return the Message Digest name - * - * @param digLine the message digest line is in the following format. That is in the + * + * @param digLine the message digest line is in the following format. That is in the * following format: * DIGEST_NAME-digest: digest value * @return a string representing a message digest. diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentConstants.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentConstants.java index 11deee0be..3847cfdfe 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentConstants.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentConstants.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/internal/signedcontent/SignedContentFile.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentFile.java index b80afe18e..60890c2b7 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentFile.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentFile.java @@ -20,9 +20,9 @@ import java.util.*; import org.eclipse.osgi.signedcontent.*; /* - * This class is used by the SignedContentFactory to create SignedContent objects from File objects. This is needed - * to avoid leaving the underlying ZipFiles open for the SignedContent objects returned from the - * SignedContentFactory (bug 225090) + * This class is used by the SignedContentFactory to create SignedContent objects from File objects. This is needed + * to avoid leaving the underlying ZipFiles open for the SignedContent objects returned from the + * SignedContentFactory (bug 225090) */ public class SignedContentFile implements SignedContent { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentImpl.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentImpl.java index 327023560..5b741d06d 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentImpl.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentImpl.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 ******************************************************************************/ package org.eclipse.osgi.internal.signedcontent; diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentMessages.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentMessages.java index bf4b4b826..f128b2755 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentMessages.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedContentMessages.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/internal/signedcontent/SignedStorageHook.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedStorageHook.java index 4222cef06..6c112f7b0 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedStorageHook.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignedStorageHook.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 ******************************************************************************/ package org.eclipse.osgi.internal.signedcontent; diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignerInfoImpl.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignerInfoImpl.java index de7de15a7..fa4162434 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignerInfoImpl.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/SignerInfoImpl.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 ******************************************************************************/ package org.eclipse.osgi.internal.signedcontent; @@ -57,7 +57,7 @@ public class SignerInfoImpl implements SignerInfo { result += cert.hashCode(); } // Note that we do not hash based on trustAnchor; - // this changes dynamically but we need a constant hashCode for purposes of + // this changes dynamically but we need a constant hashCode for purposes of // hashing in a Set. return result; } diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/TrustEngineListener.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/TrustEngineListener.java index b3b5fc86a..e745e8834 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/TrustEngineListener.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/signedcontent/TrustEngineListener.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 ******************************************************************************/ package org.eclipse.osgi.internal.signedcontent; diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/ContentHandlerFactoryImpl.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/ContentHandlerFactoryImpl.java index 077ade007..f6d2fbb6b 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/ContentHandlerFactoryImpl.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/ContentHandlerFactoryImpl.java @@ -35,7 +35,7 @@ import org.osgi.util.tracker.ServiceTracker; * The ContentHandlerFactory is registered with the JVM to provide content handlers * to requestors. The ContentHandlerFactory will first look for built-in content handlers. * If a built in handler exists, this factory will return null. Otherwise, this ContentHandlerFactory - * will search the service registry for a maching Content-Handler and, if found, return a + * will search the service registry for a maching Content-Handler and, if found, return a * proxy for that content handler. */ public class ContentHandlerFactoryImpl extends MultiplexingFactory implements java.net.ContentHandlerFactory { @@ -88,7 +88,7 @@ public class ContentHandlerFactoryImpl extends MultiplexingFactory implements ja try { clazz = URLStreamHandlerFactoryImpl.secureAction.loadSystemClass(name.toString()); if (clazz != null) { - return (null); //this class exists, it is a built in handler, let the JVM handle it + return (null); //this class exists, it is a built in handler, let the JVM handle it } } catch (ClassNotFoundException ex) { //keep looking diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/ContentHandlerProxy.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/ContentHandlerProxy.java index 0c2051d8e..f182360e7 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/ContentHandlerProxy.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/ContentHandlerProxy.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 *******************************************************************************/ @@ -25,7 +25,7 @@ import org.osgi.util.tracker.ServiceTrackerCustomizer; /** * The ContentHandlerProxy is a ContentHandler that acts as a proxy for registered ContentHandlers. * When a ContentHandler is requested from the ContentHandlerFactory and it exists in the service - * registry, a ContentHandlerProxy is created which will pass all the requests from the requestor to + * registry, a ContentHandlerProxy is created which will pass all the requests from the requestor to * the real ContentHandler. We can't return the real ContentHandler from the ContentHandlerFactory * because the JVM caches ContentHandlers and therefore would not support a dynamic environment of * ContentHandlers being registered and unregistered. @@ -47,7 +47,7 @@ public class ContentHandlerProxy extends ContentHandler implements ServiceTracke this.context = context; this.contentType = contentType; - // In case the reference == null, the proxy is constructed with DefaultContentHandler for a Content Handler + // In case the reference == null, the proxy is constructed with DefaultContentHandler for a Content Handler // until a real ContentHandler for this mime-type is registered setNewHandler(reference, getRank(reference)); @@ -105,7 +105,7 @@ public class ContentHandlerProxy extends ContentHandler implements ServiceTracke int newrank = getRank(reference); if (reference == contentHandlerServiceReference) { if (newrank < ranking) { - // The ContentHandler we are currently using has dropped it's ranking below a ContentHandler + // The ContentHandler we are currently using has dropped it's ranking below a ContentHandler // registered for the same protocol. We need to swap out ContentHandlers. // this should get us the highest ranked service, if available ServiceReference<ContentHandler> newReference = contentHandlerServiceTracker.getServiceReference(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/EquinoxFactoryManager.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/EquinoxFactoryManager.java index 569112435..7c55f0e41 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/EquinoxFactoryManager.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/EquinoxFactoryManager.java @@ -65,7 +65,7 @@ public class EquinoxFactoryManager { Object lock = getURLStreamHandlerFactoryLock(); synchronized (lock) { URLStreamHandlerFactory factory = (URLStreamHandlerFactory) factoryField.get(null); - // doing a null check here just in case, but it would be really strange if it was null, + // doing a null check here just in case, but it would be really strange if it was null, // because we failed to set the factory normally!! if (factory != null) { try { @@ -134,7 +134,7 @@ public class EquinoxFactoryManager { throw new Exception("Could not find ContentHandlerFactory field"); //$NON-NLS-1$ synchronized (URLConnection.class) { java.net.ContentHandlerFactory factory = (java.net.ContentHandlerFactory) factoryField.get(null); - // doing a null check here just in case, but it would be really strange if it was null, + // doing a null check here just in case, but it would be really strange if it was null, // because we failed to set the factory normally!! if (factory != null) { @@ -148,7 +148,7 @@ public class EquinoxFactoryManager { factory = chf; } } - // null out the field so that we can successfully call setContentHandlerFactory + // null out the field so that we can successfully call setContentHandlerFactory factoryField.set(null, null); // always attempt to clear the handlers cache // This allows an optimization for the single framework use-case @@ -221,7 +221,7 @@ public class EquinoxFactoryManager { Method unregister = factory.getClass().getMethod("unregister", new Class[] {Object.class}); //$NON-NLS-1$ unregister.invoke(factory, new Object[] {contentHandlerFactory}); } - // null out the field so that we can successfully call setContentHandlerFactory + // null out the field so that we can successfully call setContentHandlerFactory factoryField.set(null, null); // always attempt to clear the handlers cache // This allows an optomization for the single framework use-case diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/MultiplexingContentHandler.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/MultiplexingContentHandler.java index 87ea74c33..08f6a6ff1 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/MultiplexingContentHandler.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/MultiplexingContentHandler.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * *******************************************************************************/ package org.eclipse.osgi.internal.url; diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/MultiplexingFactory.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/MultiplexingFactory.java index ec38d9bed..0470a7af8 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/MultiplexingFactory.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/MultiplexingFactory.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * *******************************************************************************/ package org.eclipse.osgi.internal.url; @@ -31,7 +31,7 @@ import org.osgi.framework.BundleContext; import org.osgi.framework.FrameworkUtil; /* - * An abstract class for handler factory impls (Stream and Content) that can + * An abstract class for handler factory impls (Stream and Content) that can * handle environments running multiple osgi frameworks with the same VM. */ public abstract class MultiplexingFactory { @@ -159,7 +159,7 @@ public abstract class MultiplexingFactory { Object successor = released.remove(0); try { Class<?> clazz = successor.getClass(); - Method register = clazz.getMethod("register", new Class[] {Object.class}); //$NON-NLS-1$ + Method register = clazz.getMethod("register", new Class[] {Object.class}); //$NON-NLS-1$ for (Object r : released) { register.invoke(successor, new Object[] {r}); } diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/NullURLStreamHandlerService.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/NullURLStreamHandlerService.java index 474a7e942..6e828d6b7 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/NullURLStreamHandlerService.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/NullURLStreamHandlerService.java @@ -23,7 +23,7 @@ import org.osgi.service.url.URLStreamHandlerSetter; * The NullURLStreamService is created when a registered URLStreamHandler service * with an associated URLStreamHandlerProxy becomes unregistered. The associated * URLStreamHandlerProxy must still handle all future requests for the now unregistered - * scheme (the JVM caches URLStreamHandlers making up impossible to "unregister" them). + * scheme (the JVM caches URLStreamHandlers making up impossible to "unregister" them). * When requests come in for an unregistered URLStreamHandlerService, the * NullURLStreamHandlerService is used in it's place. */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/URLStreamHandlerFactoryImpl.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/URLStreamHandlerFactoryImpl.java index d74f030b9..ddad3ba34 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/URLStreamHandlerFactoryImpl.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/URLStreamHandlerFactoryImpl.java @@ -74,7 +74,7 @@ public class URLStreamHandlerFactoryImpl extends MultiplexingFactory implements try { clazz = secureAction.loadSystemClass(name.toString()); if (clazz != null) - return clazz; //this class exists, it is a built in handler + return clazz; //this class exists, it is a built in handler } catch (ClassNotFoundException ex) { // keep looking } diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/URLStreamHandlerProxy.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/URLStreamHandlerProxy.java index 7cb6567a3..eb585627b 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/URLStreamHandlerProxy.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/url/URLStreamHandlerProxy.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 *******************************************************************************/ @@ -25,17 +25,17 @@ import org.osgi.util.tracker.ServiceTracker; import org.osgi.util.tracker.ServiceTrackerCustomizer; /** - * The URLStreamHandlerProxy is a URLStreamHandler that acts as a proxy for registered - * URLStreamHandlerServices. When a URLStreamHandler is requested from the URLStreamHandlerFactory - * and it exists in the service registry, a URLStreamHandlerProxy is created which will pass all the - * requests from the requestor to the real URLStreamHandlerService. We can't return the real - * URLStreamHandlerService from the URLStreamHandlerFactory because the JVM caches URLStreamHandlers - * and therefore would not support a dynamic environment of URLStreamHandlerServices being registered + * The URLStreamHandlerProxy is a URLStreamHandler that acts as a proxy for registered + * URLStreamHandlerServices. When a URLStreamHandler is requested from the URLStreamHandlerFactory + * and it exists in the service registry, a URLStreamHandlerProxy is created which will pass all the + * requests from the requestor to the real URLStreamHandlerService. We can't return the real + * URLStreamHandlerService from the URLStreamHandlerFactory because the JVM caches URLStreamHandlers + * and therefore would not support a dynamic environment of URLStreamHandlerServices being registered * and unregistered. */ public class URLStreamHandlerProxy extends URLStreamHandler implements ServiceTrackerCustomizer<URLStreamHandlerService, ServiceReference<URLStreamHandlerService>> { - // TODO lots of type-based names + // TODO lots of type-based names protected URLStreamHandlerService realHandlerService; protected URLStreamHandlerSetter urlSetter; @@ -159,8 +159,8 @@ public class URLStreamHandlerProxy extends URLStreamHandler implements ServiceTr @Override public void setURL(URL url, String protocol, String host, int port, String file, String ref) { - //using non-deprecated URLStreamHandler.setURL method. - //setURL(URL u, String protocol, String host, int port, String authority, String userInfo, String file, String query, String ref) + //using non-deprecated URLStreamHandler.setURL method. + //setURL(URL u, String protocol, String host, int port, String authority, String userInfo, String file, String query, String ref) super.setURL(url, protocol, host, port, null, null, file, null, ref); } @@ -201,7 +201,7 @@ public class URLStreamHandlerProxy extends URLStreamHandler implements ServiceTr int newRank = getRank(reference); if (reference == urlStreamServiceReference) { if (newRank < ranking) { - // The URLHandler we are currently using has dropped it's ranking below a URLHandler registered + // The URLHandler we are currently using has dropped it's ranking below a URLHandler registered // for the same protocol. We need to swap out URLHandlers. // this should get us the highest ranked service, if available ServiceReference<URLStreamHandlerService> newReference = urlStreamHandlerServiceTracker.getServiceReference(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/weaving/DynamicImportList.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/weaving/DynamicImportList.java index b68adabba..f44923f25 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/weaving/DynamicImportList.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/internal/weaving/DynamicImportList.java @@ -19,7 +19,7 @@ import org.osgi.framework.Constants; import org.osgi.framework.PackagePermission; /** - * A list of DynamicImport-Package statements that are to be used for adding new + * A list of DynamicImport-Package statements that are to be used for adding new * dynamic imports to a bundle class loader. * */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/launch/Equinox.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/launch/Equinox.java index 40d7bad54..049334f98 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/launch/Equinox.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/launch/Equinox.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 *******************************************************************************/ @@ -23,7 +23,7 @@ import org.osgi.framework.launch.Framework; /** * The System Bundle implementation for the Equinox Framework. - * + * * @since 3.5 */ public class Equinox implements Framework { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/launch/EquinoxFactory.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/launch/EquinoxFactory.java index c836951ab..17d9c041f 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/launch/EquinoxFactory.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/launch/EquinoxFactory.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/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(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/InvalidContentException.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/InvalidContentException.java index a01b67a3c..5f399462f 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/InvalidContentException.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/InvalidContentException.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 @@ public class InvalidContentException extends IOException { /** * Constructs an <code>InvalidContentException</code> with the specified detail - * message and cause. + * message and cause. * * @param message the exception message * @param cause the cause, may be <code>null</code> @@ -40,7 +40,7 @@ public class InvalidContentException extends IOException { /** * Returns the cause of this exception or <code>null</code> if no cause * was specified when this exception was created. - * + * * @return The cause of this exception or <code>null</code> if no cause was created. */ @Override @@ -50,7 +50,7 @@ public class InvalidContentException extends IOException { /** * The cause of this exception can only be set when constructed. - * + * * @param t Cause of the exception. * @return This object. * @throws java.lang.IllegalStateException This method will always throw an diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignedContent.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignedContent.java index a3b59f923..6fdedc2c2 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignedContent.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignedContent.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 *******************************************************************************/ @@ -21,7 +21,7 @@ import java.util.Date; * A <code>SignedContent</code> object represents content which may be signed. A * {@link SignedContentFactory} is used to create signed content objects. * <p> - * A <code>SignedContent</code> object is intended to provide information about + * A <code>SignedContent</code> object is intended to provide information about * the signers of the content, and cannot be used to access the actual data of the content. * </p> * <p> @@ -34,13 +34,13 @@ public interface SignedContent { /** * Returns all entries of the content. The returned entries can be used - * to verify the entry content using {@link SignedContentEntry#verify()} and + * to verify the entry content using {@link SignedContentEntry#verify()} and * get signer info for each entry in this content using {@link SignedContentEntry#getSignerInfos()}. - * Note that this operation may be expensive because it requires an + * Note that this operation may be expensive because it requires an * exhaustive search for entries over the entire content. * <p> * Unsigned entries are included in the result. Entries for which signer info exists - * but no content is found are also returned. For example, when an entry is removed from + * but no content is found are also returned. For example, when an entry is removed from * a signed jar but the jar is not resigned, the signer thinks the entry should exist * but the content got removed. This would be considered an invalid entry which would fail verification. * </p> @@ -64,7 +64,7 @@ public interface SignedContent { /** * Returns true if the content is signed; false otherwise. This is a convenience method - * equivalent to calling <code>{@link #getSignerInfos()}.length > 0</code> + * equivalent to calling <code>{@link #getSignerInfos()}.length > 0</code> * @return true if the content is signed */ public boolean isSigned(); @@ -84,8 +84,8 @@ public interface SignedContent { public SignerInfo getTSASignerInfo(SignerInfo signerInfo); /** - * Checks if the certificates are valid for the specified signer. If the signer has a singing time - * returned by {@link #getSigningTime(SignerInfo)} then that time is used to check the + * Checks if the certificates are valid for the specified signer. If the signer has a singing time + * returned by {@link #getSigningTime(SignerInfo)} then that time is used to check the * validity of the certificates; otherwise the current time is used. * @param signerInfo the signer info to check validity for. * @throws CertificateExpiredException if one of the certificates of this signer is expired diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignedContentEntry.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignedContentEntry.java index 190569947..47603cf20 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignedContentEntry.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignedContentEntry.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 *******************************************************************************/ @@ -21,7 +21,7 @@ import java.io.IOException; * A <code>SignedContentEntry</code> represents a content entry which may be * signed. * <p> - * A <code>SignedContentEntry</code> object is intended to provide information about + * A <code>SignedContentEntry</code> object is intended to provide information about * the signers of the content entry, and cannot be used to access the actual data of the entry. * </p> * <p> @@ -46,7 +46,7 @@ public interface SignedContentEntry { /** * Returns true if the entry is signed; false otherwise. This is a convenience method - * equivalent to calling <code>{@link #getSignerInfos()}.length > 0</code> + * equivalent to calling <code>{@link #getSignerInfos()}.length > 0</code> * @return true if the content is signed */ public boolean isSigned(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignedContentFactory.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignedContentFactory.java index c7dbc80fd..64bc245c0 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignedContentFactory.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignedContentFactory.java @@ -25,7 +25,7 @@ import org.osgi.framework.Bundle; * The framework will register a factory implementation as an OSGi service. * This service can be used to get <code>SignedContent</code> for a bundle. * It can also be used to get <code>SignedContent</code> for a repository file. - * The supported formats for file repositories are jar files and directories containing the + * The supported formats for file repositories are jar files and directories containing the * content of an extracted jar. * </p> * <p> @@ -50,7 +50,7 @@ public interface SignedContentFactory { /** * Returns a <code>SignedContent</code> object for the specified bundle. - * @param bundle the bundle to get a signed content for. + * @param bundle the bundle to get a signed content for. * @return signed content for the specified bundle. * @throws IOException if an IO exception occurs while reading the bundle content * @throws NoSuchProviderException if there's no security provider for the signed content diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignerInfo.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignerInfo.java index 92243d994..4d62547b4 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignerInfo.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/signedcontent/SignerInfo.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,14 +39,14 @@ public interface SignerInfo { public Certificate getTrustAnchor(); /** - * Returns true if the trust anchor has been authenticated. This is a convenience + * Returns true if the trust anchor has been authenticated. This is a convenience * method equivalent to calling <code>{@link #getTrustAnchor()} != null</code> * @return true if the the signer info is trusted */ public boolean isTrusted(); /** - * Returns the <code>MessageDigest</code> algorithm used to verify content signed by this + * Returns the <code>MessageDigest</code> algorithm used to verify content signed by this * signer info. * @return the algorithm */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/BundleInfo.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/BundleInfo.java index fd100cd18..3a3014837 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/BundleInfo.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/BundleInfo.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 *******************************************************************************/ @@ -307,9 +307,9 @@ public final class BundleInfo { } /** - * Gets called by BundleFile during {@link BundleFile#getFile(String, boolean)}. This method - * will allocate a File object where content of the specified path may be - * stored for this generation. The returned File object may + * Gets called by BundleFile during {@link BundleFile#getFile(String, boolean)}. This method + * will allocate a File object where content of the specified path may be + * stored for this generation. The returned File object may * not exist if the content has not previously been stored. * @param path the path to the content to extract from the generation * @return a file object where content of the specified path may be stored. @@ -320,14 +320,14 @@ public final class BundleInfo { } /** - * Gets called by BundleFile during {@link BundleFile#getFile(String, boolean)}. This method - * will allocate a File object where content of the specified path may be - * stored for this generation. The returned File object may + * Gets called by BundleFile during {@link BundleFile#getFile(String, boolean)}. This method + * will allocate a File object where content of the specified path may be + * stored for this generation. The returned File object may * not exist if the content has not previously been stored. * @param path the path to the content to extract from the generation * @param base the base path that is prepended to the path, may be null * @return a file object where content of the specified path may be stored. - * @throws StorageException if the path will escape the persistent storage of + * @throws StorageException if the path will escape the persistent storage of * the generation starting at the specified base */ public File getExtractFile(String base, String path) { @@ -556,7 +556,7 @@ public final class BundleInfo { return true; break; case 'I' : - if (line.startsWith("Implementation-Title: ") || line.startsWith("Implementation-Version: ") || line.startsWith("Implementation-Vendor: ")) //$NON-NLS-1$ //$NON-NLS-2$//$NON-NLS-3$ + if (line.startsWith("Implementation-Title: ") || line.startsWith("Implementation-Version: ") || line.startsWith("Implementation-Vendor: ")) //$NON-NLS-1$ //$NON-NLS-2$//$NON-NLS-3$ return true; break; } diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/BundleLocalizationImpl.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/BundleLocalizationImpl.java index 28950e758..099ba2d2d 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/BundleLocalizationImpl.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/BundleLocalizationImpl.java @@ -22,9 +22,9 @@ import org.eclipse.osgi.storage.BundleInfo.Generation; import org.osgi.framework.Bundle; /** - * The implementation of the service that gets ResourceBundle objects from a given - * bundle with a given locale. - * + * The implementation of the service that gets ResourceBundle objects from a given + * bundle with a given locale. + * * <p>Internal class.</p> */ @@ -32,7 +32,7 @@ public class BundleLocalizationImpl implements BundleLocalization { /** * The getLocalization method gets a ResourceBundle object for the given * locale and bundle. - * + * * @return A <code>ResourceBundle</code> object for the given bundle and locale. * If null is passed for the locale parameter, the default locale is used. */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/FrameworkExtensionInstaller.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/FrameworkExtensionInstaller.java index 59f570185..bcc1da392 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/FrameworkExtensionInstaller.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/FrameworkExtensionInstaller.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/storage/ManifestLocalization.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/ManifestLocalization.java index cf49f7e95..ce0025b21 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/ManifestLocalization.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/ManifestLocalization.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/storage/PermissionData.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/PermissionData.java index abd867c81..4b3087475 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/PermissionData.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/PermissionData.java @@ -107,7 +107,7 @@ public class PermissionData { /** * Returns the persistent array of encoded ConditionalPermissionInfo strings - * @return an array of encoded ConditionalPermissionInfo strings or null + * @return an array of encoded ConditionalPermissionInfo strings or null * if none exist in persistent storage. */ public String[] getConditionalPermissionInfos() { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/Storage.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/Storage.java index 2d5893bdd..f64df7d72 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/Storage.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/Storage.java @@ -7,10 +7,10 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation - * Christoph Laeubrich - Bug 527175 - Storage#getSystemContent() should first make the file absolute + * Christoph Laeubrich - Bug 527175 - Storage#getSystemContent() should first make the file absolute *******************************************************************************/ package org.eclipse.osgi.storage; @@ -577,7 +577,7 @@ public class Storage { if (in != null) { return new URLConnection(null) { /** - * @throws IOException + * @throws IOException */ @Override public void connect() throws IOException { @@ -585,7 +585,7 @@ public class Storage { } /** - * @throws IOException + * @throws IOException */ @Override public InputStream getInputStream() throws IOException { @@ -1960,7 +1960,7 @@ public class Storage { // search the generation until we have searched them all while (nextElement == null && curDataIndex < generationArray.length) nextElement = generationArray[curDataIndex++].getEntry(curPath); - // we have searched all datas then advance to the next path + // we have searched all datas then advance to the next path if (curDataIndex >= generationArray.length) { curPathIndex++; curDataIndex = 0; @@ -2062,7 +2062,7 @@ public class Storage { return buffer == null ? filePattern : buffer.toString(); } - // Use LinkedHashSet for optimized performance of contains() plus ordering + // Use LinkedHashSet for optimized performance of contains() plus ordering // guarantees. private static LinkedHashSet<String> listEntryPaths(BundleFile bundleFile, String path, Filter patternFilter, Hashtable<String, String> patternProps, int options, LinkedHashSet<String> pathList) { if (pathList == null) @@ -2117,7 +2117,7 @@ public class Storage { // This has been worked around by the bundles loading the libraries in a particular order (and setting some LIB_PATH env). // The one catch is that the libraries need to be in the same directory and they must use their original lib names. // - // This bit of code attempts to do that by using the bundle ID as an ID for the temp dir along with an incrementing ID + // This bit of code attempts to do that by using the bundle ID as an ID for the temp dir along with an incrementing ID // in cases where the temp dir may already exist. Long bundleID = new Long(generation.getBundleInfo().getBundleId()); for (int i = 0; i < Integer.MAX_VALUE; i++) { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/StorageUtil.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/StorageUtil.java index 634c069c7..a47980df7 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/StorageUtil.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/StorageUtil.java @@ -222,7 +222,7 @@ public class StorageUtil { /** * To remain Java 6 compatible work around the unreliable renameTo() via * retries: http://bugs.java.com/view_bug.do?bug_id=6213298 - * + * * @param from * @param to */ diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/SystemBundleFile.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/SystemBundleFile.java index c959047c9..c679185e0 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/SystemBundleFile.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/SystemBundleFile.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/storage/bundlefile/BundleEntry.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleEntry.java index 81ccd3165..ffbde9a61 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleEntry.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleEntry.java @@ -61,7 +61,7 @@ public abstract class BundleEntry { /** * Get a URL to the bundle entry that uses a common protocol (i.e. file: - * jar: or http: etc.). + * jar: or http: etc.). * @return a URL to the bundle entry that uses a common protocol */ public abstract URL getLocalURL(); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleFile.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleFile.java index 6fba2d6c4..7a964a21d 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleFile.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleFile.java @@ -26,7 +26,7 @@ import org.eclipse.osgi.storage.url.BundleResourceHandler; import org.eclipse.osgi.storage.url.bundleresource.Handler; /** - * The BundleFile API is used by Adaptors to read resources out of an + * The BundleFile API is used by Adaptors to read resources out of an * installed Bundle in the Framework. * <p/> * Clients wishing to modify or extend the functionality of this class at @@ -43,7 +43,7 @@ abstract public class BundleFile { /** * BundleFile constructor - * @param basefile The File object where this BundleFile is + * @param basefile The File object where this BundleFile is * persistently stored. */ public BundleFile(File basefile) { @@ -69,35 +69,35 @@ abstract public class BundleFile { */ abstract public BundleEntry getEntry(String path); - /** - * Performs the same function as calling + /** + * Performs the same function as calling * {@link #getEntryPaths(String, boolean)} with <code>recurse</code> equal * to <code>false</code>. * @param path path of the entry to locate in the bundle * @return an Enumeration of Strings that indicate the paths found or - * null if the path does not exist. + * null if the path does not exist. */ public Enumeration<String> getEntryPaths(String path) { return getEntryPaths(path, false); } - /** - * Allows to access the entries of the bundle. - * Since the bundle content is usually a jar, this + /** + * Allows to access the entries of the bundle. + * Since the bundle content is usually a jar, this * allows to access the jar contents. - * + * * GetEntryPaths allows to enumerate the content of "path". * If path is a directory, it is equivalent to listing the directory - * contents. The returned names are either files or directories - * themselves. If a returned name is a directory, it finishes with a + * contents. The returned names are either files or directories + * themselves. If a returned name is a directory, it finishes with a * slash. If a returned name is a file, it does not finish with a slash. * @param path path of the entry to locate in the bundle - * @param recurse - If <code>true</code>, provide entries for the files and + * @param recurse - If <code>true</code>, provide entries for the files and * directories within the directory denoted by <code>path</code> plus * all sub-directories and files; otherwise, provide only the entries * within the immediate directory. * @return an Enumeration of Strings that indicate the paths found or - * null if the path does not exist. + * null if the path does not exist. */ abstract public Enumeration<String> getEntryPaths(String path, boolean recurse); diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleFileWrapper.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleFileWrapper.java index e9146e233..ee593ebdb 100755 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleFileWrapper.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleFileWrapper.java @@ -22,12 +22,12 @@ import org.eclipse.osgi.internal.hookregistry.BundleFileWrapperFactoryHook; import org.eclipse.osgi.storage.BundleInfo; /** - * A {@link BundleFile bundle file} decorator. + * A {@link BundleFile bundle file} decorator. * <p/> - * Clients wishing to modify or extend the behavior of a bundle file at runtime - * should extend this class instead. A hook is provided by the related {@link - * BundleFileWrapperFactoryHook abstract factory} class in response to a - * {@link BundleFileWrapperFactoryHook#wrapBundleFile(BundleFile, + * Clients wishing to modify or extend the behavior of a bundle file at runtime + * should extend this class instead. A hook is provided by the related {@link + * BundleFileWrapperFactoryHook abstract factory} class in response to a + * {@link BundleFileWrapperFactoryHook#wrapBundleFile(BundleFile, * BundleInfo.Generation, boolean) call} from the framework. */ public class BundleFileWrapper extends BundleFile { @@ -36,7 +36,7 @@ public class BundleFileWrapper extends BundleFile { /** * Creates a new <code>BundleFileWrapper</code> instance wrapping the * given {@link BundleFile bundle file}. - * + * * @param bundleFile - The bundle file to wrap. * @throws NullPointerException - If the bundle file is <code>null</code>. */ @@ -67,7 +67,7 @@ public class BundleFileWrapper extends BundleFile { /** * Get the wrapped bundle file. - * + * * @return The wrapped bundle file. */ public BundleFile getBundleFile() { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleFileWrapperChain.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleFileWrapperChain.java index 3421da4f2..1fcabe05e 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleFileWrapperChain.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/BundleFileWrapperChain.java @@ -17,7 +17,7 @@ package org.eclipse.osgi.storage.bundlefile; import org.eclipse.osgi.internal.hookregistry.BundleFileWrapperFactoryHook; /** - * Used to chain the BundleFile objects returned from {@link BundleFileWrapperFactoryHook}. + * Used to chain the BundleFile objects returned from {@link BundleFileWrapperFactoryHook}. * This class is useful for traversing the chain of wrapped bundle files. */ public class BundleFileWrapperChain extends BundleFileWrapper { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/CloseableBundleFile.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/CloseableBundleFile.java index a06223c46..73720b9eb 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/CloseableBundleFile.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/CloseableBundleFile.java @@ -84,7 +84,7 @@ public abstract class CloseableBundleFile<E> extends BundleFile { // If the revision has been removed from the list of revisions then it has been deleted // because the bundle has been uninstalled or updated if (!r.getRevisions().getModuleRevisions().contains(r)) { - // instead of filling the log with errors about missing files from + // instead of filling the log with errors about missing files from // uninstalled/updated bundles just give it an info level eventType = ContainerEvent.INFO; } @@ -148,7 +148,7 @@ public abstract class CloseableBundleFile<E> extends BundleFile { * Extracts a directory and all sub content to disk * @param dirName the directory name to extract * @return the File used to extract the content to. A value - * of <code>null</code> is returned if the directory to extract does + * of <code>null</code> is returned if the directory to extract does * not exist or if content extraction is not supported. */ File extractDirectory(String dirName) { @@ -294,7 +294,7 @@ public abstract class CloseableBundleFile<E> extends BundleFile { LinkedHashSet<String> result = new LinkedHashSet<>(); // Get all entries and add the ones of interest. for (String entryPath : getPaths()) { - // Is the entry of possible interest? Note that + // Is the entry of possible interest? Note that // string.startsWith("") == true. if (entryPath.startsWith(path)) { // If we get here, we know that the entry is either (1) equal to @@ -430,7 +430,7 @@ public abstract class CloseableBundleFile<E> extends BundleFile { * This method will ensure the bundle file is open, * call {@link #doGetInputStream(Object)} to get the * actual input stream, then if the bundle file limit - * is enabled it will wrapper the input stream in a + * is enabled it will wrapper the input stream in a * special input stream that keeps track of active * input streams to prevent the bundle file from being * closed until the stream is closed (or a timeout happens). diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/DirZipBundleEntry.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/DirZipBundleEntry.java index 8e6237967..288f43650 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/DirZipBundleEntry.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/DirZipBundleEntry.java @@ -19,7 +19,7 @@ import java.net.MalformedURLException; import java.net.URL; /** - * Represents a directory entry in a ZipBundleFile. This object is used to + * Represents a directory entry in a ZipBundleFile. This object is used to * reference a directory entry in a ZipBundleFile when the directory entries are * not included in the zip file. */ @@ -40,7 +40,7 @@ public class DirZipBundleEntry extends BundleEntry { } /** - * @throws IOException + * @throws IOException */ @Override public InputStream getInputStream() throws IOException { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/MRUBundleFileList.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/MRUBundleFileList.java index e6d8caf09..15d6ac979 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/MRUBundleFileList.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/MRUBundleFileList.java @@ -72,8 +72,8 @@ public class MRUBundleFileList implements EventDispatcher<Object, Object, Bundle } /** - * Adds a BundleFile which is about to be opened to the MRU list. If - * the number of open BundleFiles == the fileLimit then the least + * Adds a BundleFile which is about to be opened to the MRU list. If + * the number of open BundleFiles == the fileLimit then the least * recently used BundleFile is closed. * @param bundleFile the bundle file about to be opened. * @return true if back pressure is needed @@ -98,7 +98,7 @@ public class MRUBundleFileList implements EventDispatcher<Object, Object, Bundle } } else { // numOpen has reached the fileLimit - // find the least recently used bundleFile and close it + // find the least recently used bundleFile and close it // and use its slot for the new bundleFile to be opened. index = 0; for (int i = 1; i < fileLimit; i++) diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/NestedDirBundleFile.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/NestedDirBundleFile.java index 1167b9f45..b37922b63 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/NestedDirBundleFile.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/NestedDirBundleFile.java @@ -143,7 +143,7 @@ public class NestedDirBundleFile extends BundleFile { } /** - * @throws IOException + * @throws IOException */ @Override public void open() throws IOException { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/ZipBundleEntry.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/ZipBundleEntry.java index 8dba5fdfc..b15a4cca4 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/ZipBundleEntry.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/ZipBundleEntry.java @@ -95,7 +95,7 @@ public class ZipBundleEntry extends BundleEntry { try { return new URL("jar:" + bundleFile.basefile.toURL() + "!/" + zipEntry.getName()); //$NON-NLS-1$//$NON-NLS-2$ } catch (MalformedURLException e) { - //This can not happen. + //This can not happen. return null; } } @@ -108,7 +108,7 @@ public class ZipBundleEntry extends BundleEntry { if (file != null) return file.toURL(); } catch (MalformedURLException e) { - //This can not happen. + //This can not happen. } return null; } diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/ZipBundleFile.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/ZipBundleFile.java index d20689927..3f668a758 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/ZipBundleFile.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/bundlefile/ZipBundleFile.java @@ -50,7 +50,7 @@ public class ZipBundleFile extends CloseableBundleFile<ZipEntry> { /** * Returns a ZipEntry for the bundle file. Must be called while holding the open lock. - * This method does not ensure that the ZipFile is opened. Callers may need to call getZipfile() prior to calling this + * This method does not ensure that the ZipFile is opened. Callers may need to call getZipfile() prior to calling this * method. * @param path the path to an entry * @return a ZipEntry or null if the entry does not exist diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/BundleResourceHandler.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/BundleResourceHandler.java index 991f0574b..d3770493f 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/BundleResourceHandler.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/BundleResourceHandler.java @@ -45,8 +45,8 @@ public abstract class BundleResourceHandler extends URLStreamHandler { this.bundleEntry = bundleEntry; } - /** - * Parse reference URL. + /** + * Parse reference URL. */ @Override protected void parseURL(URL url, String str, int start, int end) { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/BundleURLConverter.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/BundleURLConverter.java index 2e4afbc11..d3aa6d9bf 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/BundleURLConverter.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/BundleURLConverter.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 *******************************************************************************/ @@ -23,7 +23,7 @@ import org.eclipse.osgi.util.NLS; /** * The service implementation that allows bundleresource or bundleentry * URLs to be converted to native file URLs on the local file system. - * + * * <p>Internal class.</p> */ public class BundleURLConverter implements URLConverter { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/reference/Handler.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/reference/Handler.java index a6b1c4f66..93c1e3608 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/reference/Handler.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/reference/Handler.java @@ -18,7 +18,7 @@ import java.io.IOException; import java.net.*; /** - * URLStreamHandler for reference protocol. A reference URL is used to hold a + * URLStreamHandler for reference protocol. A reference URL is used to hold a * reference to a local file URL. A reference URL allows bundles to be installed * by reference. This means the content of the bundle will not be copied. Instead * the content of the bundle will be loaded from the reference location specified @@ -44,7 +44,7 @@ public class Handler extends URLStreamHandler { } /** - * @throws IOException + * @throws IOException */ @Override protected URLConnection openConnection(URL url) throws IOException { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/reference/ReferenceURLConnection.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/reference/ReferenceURLConnection.java index 80041aa15..d6b653f55 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/reference/ReferenceURLConnection.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/storage/url/reference/ReferenceURLConnection.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 *******************************************************************************/ @@ -72,19 +72,19 @@ public class ReferenceURLConnection extends URLConnection { if (file.isFile()) { // Try to open the file to ensure that this is possible: see bug 260217 // If access is denied, a FileNotFoundException with (access denied) message is thrown - // Here file.canRead() cannot be used, because on Windows it does not + // Here file.canRead() cannot be used, because on Windows it does not // return correct values - bug 6203387 in Sun's bug database InputStream is = new FileInputStream(file); is.close(); } else if (file.isDirectory()) { // There is no straightforward way to check if a directory - // has read permissions - same issues for File.canRead() as above; + // has read permissions - same issues for File.canRead() as above; // try to list the files in the directory File[] files = file.listFiles(); - // File.listFiles() returns null if the directory does not exist + // File.listFiles() returns null if the directory does not exist // (which is not the current case, because we check that it exists and is directory), // or if an IO error occurred during the listing of the files, including if the - // access is denied + // access is denied if (files == null) throw new FileNotFoundException(file.toString() + " (probably access denied)"); //$NON-NLS-1$ } else { diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/util/TextProcessor.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/util/TextProcessor.java index 69f2e910b..f871c4c3c 100644 --- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/util/TextProcessor.java +++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/util/TextProcessor.java @@ -1,13 +1,13 @@ /******************************************************************************* * Copyright (c) 2006, 2012 IBM Corporation and others. * - * This program and the accompanying materials + * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 * which accompanies this distribution, and is available at * 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 java.util.Locale; * its semantic meaning and conforms with the Unicode BiDi algorithm within each * segment. * </p> - * + * * @since 3.2 * @noextend This class is not intended to be subclassed by clients. */ @@ -71,7 +71,7 @@ public class TextProcessor { // whether or not processing is needed private static boolean IS_PROCESSING_NEEDED = false; - // constant used to indicate an LRM need not precede a delimiter + // constant used to indicate an LRM need not precede a delimiter private static final int INDEX_NOT_SET = 999999999; static { @@ -91,7 +91,7 @@ public class TextProcessor { * substitution based on the locale. This is equivalent to calling * <code>process(String, String)</code> with the default set of * delimiters. - * + * * @param text * the text to be processed * @return the manipulated string @@ -144,7 +144,7 @@ public class TextProcessor { * <code>String.length()</code> called on the resulting string will not * return the same values as would be returned for the original string. * </p> - * + * * @param str * the text to process, if <code>null</code> return the string * as it was passed in @@ -185,7 +185,7 @@ public class TextProcessor { } else if (Character.isDigit(ch)) { if (delimIndex != INDEX_NOT_SET) { // consecutive neutral and weak directional characters - // explicitly force direction to be LRM + // explicitly force direction to be LRM target.insert(delimIndex, LRM); delimIndex = INDEX_NOT_SET; isLastRTL = false; @@ -195,7 +195,7 @@ public class TextProcessor { isStringBidi = true; if (delimIndex != INDEX_NOT_SET) { // neutral character followed by strong right directional character - // explicitly force direction to be LRM + // explicitly force direction to be LRM target.insert(delimIndex, LRM); delimIndex = INDEX_NOT_SET; } @@ -211,10 +211,10 @@ public class TextProcessor { /* * TextProcessor is not aware of the orientation of the component owning * the processed string. Enclose the string in LRE/PDF in either of 2 - * cases: + * cases: * (1) The string contains BiDi characters - implying that the - * string appearance depends on the basic orientation - * (2) The runtime locale is BiDi AND either the string does not start with + * string appearance depends on the basic orientation + * (2) The runtime locale is BiDi AND either the string does not start with * an LTR character or it ends with LTR char or digit. */ if (isStringBidi || !Character.isLetter(str.charAt(0)) || isNeutral(str.charAt(str.length() - 1))) { @@ -226,12 +226,12 @@ public class TextProcessor { } /** - * Removes directional marker characters in the given string that were inserted by + * Removes directional marker characters in the given string that were inserted by * utilizing the <code>process(String)</code> or <code>process(String, String)</code> * methods. - * + * * @param str string with directional markers to remove - * @return string with no directional markers + * @return string with no directional markers * @see #process(String) * @see #process(String, String) * @since 3.3 @@ -261,7 +261,7 @@ public class TextProcessor { /** * Return the string containing all the default delimiter characters to be * used to segment a given string. - * + * * @return delimiter string */ public static String getDefaultDelimiters() { @@ -275,11 +275,11 @@ public class TextProcessor { /* * Cannot use Character.getDirectionality() since the OSGi library can * be compiled with execution environments that pre-date that API. - * + * * The first range of characters is Unicode Hebrew and Arabic * characters. The second range of characters is Unicode Hebrew and * Arabic presentation forms. - * + * * NOTE: Farsi and Urdu fall within the Arabic scripts. */ return (((c >= 0x05d0) && (c <= 0x07b1)) || ((c >= 0xfb1d) && (c <= 0xfefc))); |