diff options
Diffstat (limited to 'bundles/org.eclipse.osgi/supplement/src/org')
37 files changed, 460 insertions, 460 deletions
diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/ExtendedLogEntry.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/ExtendedLogEntry.java index b87daeb1f..5c9501fb4 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/ExtendedLogEntry.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/ExtendedLogEntry.java @@ -16,7 +16,7 @@ import org.osgi.service.log.LogListener; /** * Extends the OSGi Log Services <code>LogEntry</code> object to provide additional context information. * Otherwise similarly accessible by registering a <code>LogListener</code> object. - * + * * @ThreadSafe * @see LogListener * @since 3.7 @@ -26,7 +26,7 @@ public interface ExtendedLogEntry extends LogEntry { /** * Returns the logger name associated with this <code>LogEntry</code> * object. - * + * * @return <code>String</code> containing the logger name associated with this * <code>LogEntry</code> object;<code>null</code> if no logger name is * associated with this <code>LogEntry</code> object. @@ -37,7 +37,7 @@ public interface ExtendedLogEntry extends LogEntry { /** * Returns the context associated with this <code>LogEntry</code> * object. - * + * * @return <code>Object</code> containing the context associated with this * <code>LogEntry</code> object;<code>null</code> if no context is * associated with this <code>LogEntry</code> object. @@ -47,7 +47,7 @@ public interface ExtendedLogEntry extends LogEntry { /** * Returns the thread id of the logging thread associated with this <code>LogEntry</code> * object. - * + * * @return <code>long</code> containing the thread id associated with this * <code>LogEntry</code> object. */ @@ -56,7 +56,7 @@ public interface ExtendedLogEntry extends LogEntry { /** * Returns the thread name of the logging thread associated with this <code>LogEntry</code> * object. - * + * * @return <code>String</code> containing the message associated with this * <code>LogEntry</code> object. */ @@ -64,8 +64,8 @@ public interface ExtendedLogEntry extends LogEntry { /** * Returns the log sequence number associated with this <code>LogEntry</code> - * object. - * + * object. + * * @return <code>long</code> containing the sequence number associated with this * <code>LogEntry</code> object. */ diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/ExtendedLogReaderService.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/ExtendedLogReaderService.java index 2cdf63814..909c2786d 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/ExtendedLogReaderService.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/ExtendedLogReaderService.java @@ -21,13 +21,13 @@ import org.osgi.service.log.*; public interface ExtendedLogReaderService extends LogReaderService { /** * Subscribes to <code>LogEntry</code> objects. - * + * * <p> * This method registers a <code>LogListener</code> object with the Log Reader * Service with a <code>LogFilter</code> to allow pre-filtering of interesting log entries. * The <code>LogListener.logged(LogEntry)</code> method will be * called for each <code>LogEntry</code> object placed into the log that matches the filter. - * + * * @param listener A <code>LogListener</code> object to register; the * <code>LogListener</code> object is used to receive <code>LogEntry</code> * objects. diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/ExtendedLogService.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/ExtendedLogService.java index 698088f9c..8f463ecf9 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/ExtendedLogService.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/ExtendedLogService.java @@ -25,9 +25,9 @@ public interface ExtendedLogService extends LogService, Logger { /** * Returns the <code>Logger<code> object associated with this logger name for the bundle that retrieved this log service. - * If loggerName is null the default <code>Logger</code> for this bundle is returned. - * - * @param loggerName The logger name. + * If loggerName is null the default <code>Logger</code> for this bundle is returned. + * + * @param loggerName The logger name. * @return <code>Logger</code> associated with the logger name. */ @Override @@ -35,8 +35,8 @@ public interface ExtendedLogService extends LogService, Logger { /** * Returns the logger associated with this logger name and bundle. - * - * @param loggerName The logger name. + * + * @param loggerName The logger name. * @param bundle The bundles associated with this logger. If null the bundle that retrieved this log service is used. * @return <code>Logger</code> associated with the logger name. * @throws SecurityException if the caller does not have <code>LogPermission[*,LOG]</code>. diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/LogPermission.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/LogPermission.java index 70ce208ef..6c4dd3d40 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/LogPermission.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/LogPermission.java @@ -15,9 +15,9 @@ import java.security.PermissionCollection; /** * Indicates a bundle's authority to log on behalf of other bundles. - * + * * This permission has only a single action: LOG. - * + * * @ThreadSafe * @since 3.7 */ @@ -32,7 +32,7 @@ public class LogPermission extends Permission { /** * Create a new LogPermission. - * + * * @param name Name must be "*". * @param actions <code>log</code> or "*". */ diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/Logger.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/Logger.java index e03633f68..b1caf3b96 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/Logger.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/equinox/log/Logger.java @@ -44,7 +44,7 @@ public interface Logger extends org.osgi.service.log.Logger { /** * Extends the <code>LogService</code> * Logs a message with a context object - * + * * @param context The context object this message is associated with. * @param level The log level or severity of the message. * @param message A human readable string to associate with log entry. @@ -55,8 +55,8 @@ public interface Logger extends org.osgi.service.log.Logger { /** * Logs a message with an exception associated and a * context object. - * - * + * + * * @param context The context object this message is associated with. * @param level The log level or severity of the message. * @param message A human readable string to associate with log entry. @@ -66,10 +66,10 @@ public interface Logger extends org.osgi.service.log.Logger { public void log(Object context, int level, String message, Throwable exception); /** - * Pre-checks if there are LogListeners who are listening for a matching log entry from this <code>Logger</code>. - * + * Pre-checks if there are LogListeners who are listening for a matching log entry from this <code>Logger</code>. + * * @param level The log level or severity of the message. - * @return <code>boolean</code> True if there a LogListener listening that can handle a log entry for this log level; false otherwise. + * @return <code>boolean</code> True if there a LogListener listening that can handle a log entry for this log level; false otherwise. * @see ExtendedLogReaderService#addLogListener(org.osgi.service.log.LogListener, LogFilter) * @see LogFilter */ @@ -78,7 +78,7 @@ public interface Logger extends org.osgi.service.log.Logger { /** * Returns the name associated with this <code>Logger</code> * object. - * + * * @return <code>String</code> containing the name associated with this * <code>Logger</code> object;<code>null</code> if no name is * associated. diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/console/CommandInterpreter.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/console/CommandInterpreter.java index 844a17cef..a4b711d72 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/console/CommandInterpreter.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/console/CommandInterpreter.java @@ -17,7 +17,7 @@ package org.eclipse.osgi.framework.console; import java.util.Dictionary; import org.osgi.framework.Bundle; -/** +/** * A command interpreter is a shell that can interpret command * lines. This object is passed as parameter when a CommandProvider * is invoked. diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/console/ConsoleSession.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/console/ConsoleSession.java index cdfedce04..cbfab740a 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/console/ConsoleSession.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/console/ConsoleSession.java @@ -20,13 +20,13 @@ import org.osgi.framework.*; /** * A console session service provides the input and output to a single console session. * The input will be used by the console to read in console commands. The output will - * be used to print the results of console commands. + * be used to print the results of console commands. * <p> - * The console session must be registered as an OSGi service in order to be associated - * with a console instance. The console implementation will discover any console session - * services and will create a new console instance using the console session for input and - * output. When a session is closed then the console session service will be unregistered - * and the console instance will terminate and be disposed of. The console instance will + * The console session must be registered as an OSGi service in order to be associated + * with a console instance. The console implementation will discover any console session + * services and will create a new console instance using the console session for input and + * output. When a session is closed then the console session service will be unregistered + * and the console instance will terminate and be disposed of. The console instance will * also terminate if the console session service is unregistered for any reason. * </p> * @since 3.6 @@ -48,7 +48,7 @@ public abstract class ConsoleSession implements ServiceFactory<Object> { try { current.unregister(); } catch (IllegalStateException e) { - // This can happen if the service is in the process of being + // This can happen if the service is in the process of being // unregistered or if another thread unregistered the service. // Ignoring the exception. } @@ -56,8 +56,8 @@ public abstract class ConsoleSession implements ServiceFactory<Object> { } /** - * Called by the {@link #close()} method to free resources associated - * with this console session. For example, closing the streams + * Called by the {@link #close()} method to free resources associated + * with this console session. For example, closing the streams * associated with the input and output for this session. * @noreference This method is not intended to be referenced by clients. */ @@ -72,7 +72,7 @@ public abstract class ConsoleSession implements ServiceFactory<Object> { public abstract InputStream getInput(); /** - * Returns the output for this console session. This output will be + * Returns the output for this console session. This output will be * used to write the results of console commands. * @return the output for this console session. * @noreference This method is not intended to be referenced by clients. diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/CopyOnWriteIdentityMap.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/CopyOnWriteIdentityMap.java index 4625925a0..321aaaca8 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/CopyOnWriteIdentityMap.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/CopyOnWriteIdentityMap.java @@ -20,10 +20,10 @@ import java.util.*; * A copy-on-write identity map. Write operations result in copying the underlying data so that * simultaneous read operations are not affected. * This allows for safe, unsynchronized traversal. - * + * * <p> * Note: This class uses identity for key and value comparison, not equals. - * + * * @since 3.5 */ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { @@ -34,7 +34,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { private static final Entry[] emptyArray = new Entry[0]; /** - * The array of entries. This field is volatile so it can be + * The array of entries. This field is volatile so it can be * accessed from unsynchronized reader methods. */ private volatile Entry<K, V>[] entries; @@ -106,7 +106,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { /** * Add all the entries from the specified map to this map. - * + * * @param source The map whose entries are to be added to this map. */ @Override @@ -133,7 +133,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { /** * Add all the keys from the specified array to this map with the value * <code>null</code>. - * + * * @param keys The array of keys to be added to this map. */ public <L extends K> void putAll(L[] keys) { @@ -151,7 +151,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { /** * Add all the entries to this map. - * + * * @param toCopy Array of entries to add to this map. */ private synchronized void putAll(Entry<? extends K, ? extends V>[] toCopy) { @@ -187,7 +187,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { * Key objects are compared using identity. * * @param key The key object to be removed from the map. - * @return <code>null</code> if the key was not in the list. + * @return <code>null</code> if the key was not in the list. * Otherwise, the value associated with the key. * @throws IllegalArgumentException If key is null. */ @@ -230,7 +230,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { /** * Remove all entries from the map. - * + * */ @Override public synchronized void clear() { @@ -259,7 +259,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { /** * Is the map empty? - * + * * @return <code>true</code> if the list is empty. */ @Override @@ -269,7 +269,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { /** * Return the number of entries in the map. - * + * * @return The number of entries in the map. */ @Override @@ -280,7 +280,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { /** * Return the value object for the specified key. * Keys are compared using identity. - * + * * @param key The key object. * @return The value object for the specified key. * @throws IllegalArgumentException If key is null. @@ -302,7 +302,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { /** * Check if the map contains the specified key. * Keys are compared using identity. - * + * * @param key The key object. * @return <code>true</code> if the specified key is in the map. * @throws IllegalArgumentException If key is null. @@ -324,7 +324,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { /** * Check if the map contains the specified value. * Values are compared using identity. - * + * * @param value The value object. * @return <code>true</code> if the specified value is in the map. */ @@ -341,7 +341,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { /** * Returns a snapshot of the entries in this map. * Changes to the returned set or this map will not affect each other. - * + * * @return A Set of Map.Entry for each entry in this map. * The entries returned by the set cannot be modified. */ @@ -353,7 +353,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { /** * Returns a snapshot of the keys in this map. * Changes to the returned set or this map will not affect each other. - * + * * @return A Set of the key objects in this map */ @Override @@ -364,7 +364,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { /** * Returns a snapshot of the values in this map. * Changes to the returned set or this map will not affect each other. - * + * * @return A Collection of the value objects in this map. */ @Override @@ -439,7 +439,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { /** * A snapshot of the entries in the map. This snapshot used by - * the map collection views. Changes made by the collection + * the map collection views. Changes made by the collection * views only mutate the snapshot and not the map. The collection * views only allow removal not addition. */ @@ -516,7 +516,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { } } - /** + /** * Entry set iterator over the snapshot. */ private final class EntryIterator extends SnapshotIterator<Map.Entry<K, V>> { @@ -572,7 +572,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { } } - /** + /** * Key set iterator over the snapshot. */ private final class KeyIterator extends SnapshotIterator<K> { @@ -628,7 +628,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { } } - /** + /** * Value collection iterator over the snapshot. */ private final class ValueIterator extends SnapshotIterator<V> { @@ -642,7 +642,7 @@ public class CopyOnWriteIdentityMap<K, V> implements Map<K, V> { } } - /** + /** * Base iterator class handling removal and concurrent modifications. */ private abstract class SnapshotIterator<E> implements Iterator<E> { diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/EventDispatcher.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/EventDispatcher.java index 4d802f258..da51c2b6f 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/EventDispatcher.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/EventDispatcher.java @@ -27,7 +27,7 @@ public interface EventDispatcher<K, V, E> { * This method is called once for each listener. * This method must cast the event listener object to the appropriate listener * class for the event type and call the appropriate listener method. - * + * * <p>The method should properly log/handle any exceptions thrown by the called * listener. The EventManager will ignore any Throwable thrown by this method * in order to continue delivery of the event to the next listener. diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/EventListeners.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/EventListeners.java index e99af1575..9779cd95b 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/EventListeners.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/EventListeners.java @@ -18,12 +18,12 @@ import java.util.Map; import java.util.Set; /** - * This class manages a list of listeners. - * + * This class manages a list of listeners. + * * Listeners may be added or removed as necessary. - * + * * This class uses identity for comparison, not equals. - * + * * @since 3.1 * @deprecated As of 3.5. Replaced by CopyOnWriteIdentityMap. * @noextend This class is not intended to be subclassed by clients. @@ -76,7 +76,7 @@ public class EventListeners<K, V> { /** * Remove all listeners from the list. - * + * * This method calls the clear method. */ public void removeAllListeners() { diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/EventManager.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/EventManager.java index e35f244bc..32e1067c7 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/EventManager.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/EventManager.java @@ -26,8 +26,8 @@ import java.util.Set; * ListenerQueue for dispatching events. CopyOnWriteIdentityMap objects * must be used to manage listener lists. * - * <p>This example uses the fictitious SomeEvent class and shows how to use this package - * to deliver a SomeEvent to a set of SomeEventListeners. + * <p>This example uses the fictitious SomeEvent class and shows how to use this package + * to deliver a SomeEvent to a set of SomeEventListeners. * <pre> * * // Create an EventManager with a name for an asynchronous event dispatch thread @@ -43,7 +43,7 @@ import java.util.Set; * ListenerQueue listenerQueue = new ListenerQueue(eventManager); * // Add the listeners to the queue and associate them with the event dispatcher * listenerQueue.queueListeners(eventListeners.entrySet(), new EventDispatcher() { - * public void dispatchEvent(Object eventListener, Object listenerObject, + * public void dispatchEvent(Object eventListener, Object listenerObject, * int eventAction, Object eventObject) { * try { * (SomeEventListener)eventListener.someEventOccured((SomeEvent)eventObject); @@ -52,51 +52,51 @@ import java.util.Set; * } * } * }); - * // Deliver the event to the listeners. + * // Deliver the event to the listeners. * listenerQueue.dispatchEventAsynchronous(0, new SomeEvent()); - * + * * // Remove the listener from the listener list * eventListeners.remove(someEventListener); * * // Close EventManager to clean when done to terminate async event dispatch thread. - * // Note that closing the event manager while asynchronously delivering events - * // may cause some events to not be delivered before the async event dispatch + * // Note that closing the event manager while asynchronously delivering events + * // may cause some events to not be delivered before the async event dispatch * // thread terminates * eventManager.close(); * </pre> - * + * * <p>At first glance, this package may seem more complicated than necessary * but it has support for some important features. The listener list supports * companion objects for each listener object. This is used by the OSGi framework * to create wrapper objects for a listener which are passed to the event dispatcher. * The ListenerQueue class is used to build a snap shot of the listeners prior to beginning - * event dispatch. - * - * The OSGi framework uses a 2 level listener list for each listener type (4 types). - * Level one is managed per framework instance and contains the list of BundleContexts which have - * registered a listener. Level 2 is managed per BundleContext for the listeners in that - * context. This allows all the listeners of a bundle to be easily and atomically removed from - * the level one list. To use a "flat" list for all bundles would require the list to know which - * bundle registered a listener object so that the list could be traversed when stopping a bundle - * to remove all the bundle's listeners. - * - * When an event is fired, a snapshot list (ListenerQueue) must be made of the current listeners before delivery - * is attempted. The snapshot list is necessary to allow the listener list to be modified while the + * event dispatch. + * + * The OSGi framework uses a 2 level listener list for each listener type (4 types). + * Level one is managed per framework instance and contains the list of BundleContexts which have + * registered a listener. Level 2 is managed per BundleContext for the listeners in that + * context. This allows all the listeners of a bundle to be easily and atomically removed from + * the level one list. To use a "flat" list for all bundles would require the list to know which + * bundle registered a listener object so that the list could be traversed when stopping a bundle + * to remove all the bundle's listeners. + * + * When an event is fired, a snapshot list (ListenerQueue) must be made of the current listeners before delivery + * is attempted. The snapshot list is necessary to allow the listener list to be modified while the * event is being delivered to the snapshot list. The memory cost of the snapshot list is - * low since the ListenerQueue object uses the copy-on-write semantics + * low since the ListenerQueue object uses the copy-on-write semantics * of the CopyOnWriteIdentityMap. This guarantees the snapshot list is never modified once created. - * + * * The OSGi framework also uses a 2 level dispatch technique (EventDispatcher). - * Level one dispatch is used by the framework to add the level 2 listener list of each + * Level one dispatch is used by the framework to add the level 2 listener list of each * BundleContext to the snapshot in preparation for delivery of the event. - * Level 2 dispatch is used as the final event deliverer and must cast the listener + * Level 2 dispatch is used as the final event deliverer and must cast the listener * and event objects to the proper type before calling the listener. Level 2 dispatch - * will cancel delivery of an event + * will cancel delivery of an event * to a bundle that has stopped between the time the snapshot was created and the * attempt was made to deliver the event. - * - * <p> The highly dynamic nature of the OSGi framework had necessitated these features for - * proper and efficient event delivery. + * + * <p> The highly dynamic nature of the OSGi framework had necessitated these features for + * proper and efficient event delivery. * @since 3.1 * @noextend This class is not intended to be subclassed by clients. */ @@ -110,9 +110,9 @@ public class EventManager { */ private EventThread<?, ?, ?> thread; - /** - * Once closed, an attempt to create a new EventThread will result in an - * IllegalStateException. + /** + * Once closed, an attempt to create a new EventThread will result in an + * IllegalStateException. */ private boolean closed; @@ -167,8 +167,8 @@ public class EventManager { * This method can be called to release any resources associated with this * EventManager. * <p> - * Closing this EventManager while it is asynchronously delivering events - * may cause some events to not be delivered before the async event dispatch + * Closing this EventManager while it is asynchronously delivering events + * may cause some events to not be delivered before the async event dispatch * thread terminates. */ public synchronized void close() { @@ -291,8 +291,8 @@ public class EventManager { private volatile boolean running; /** - * Constructor for the event thread. - * @param threadName Name of the EventThread + * Constructor for the event thread. + * @param threadName Name of the EventThread */ EventThread(ThreadGroup threadGroup, String threadName) { super(threadGroup, threadName == null ? getNextName() : threadName); @@ -308,8 +308,8 @@ public class EventManager { } /** - * Constructor for the event thread. - * @param threadName Name of the EventThread + * Constructor for the event thread. + * @param threadName Name of the EventThread */ EventThread(String threadName) { this(null, threadName); @@ -344,7 +344,7 @@ public class EventManager { } EventManager.dispatchEvent(item.listeners, item.dispatcher, item.action, item.object); // Bug 299589: since the call to getNextEvent() will eventually block for a long time, we need to make sure that the 'item' - // variable is cleared of the previous value before the call to getNextEvent(). See VM SPec 2.5.7 for why the compiler + // variable is cleared of the previous value before the call to getNextEvent(). See VM SPec 2.5.7 for why the compiler // will not automatically clear this variable for each loop iteration. item = null; } diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/ListenerQueue.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/ListenerQueue.java index 37a0f188b..69973aa8f 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/ListenerQueue.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/ListenerQueue.java @@ -32,8 +32,8 @@ import org.eclipse.osgi.framework.eventmgr.EventManager.EventThread; * can then be synchronously or asynchronously delivered to the list of * listeners. After the event has been dispatched for delivery, the * ListenerQueue object should be discarded as it is likely the list of listeners is stale. - * A new ListenerQueue object should be created when it is time to deliver - * another event. The Sets used to build the list of listeners must not change after being + * A new ListenerQueue object should be created when it is time to deliver + * another event. The Sets used to build the list of listeners must not change after being * added to the list. * @since 3.1 */ @@ -48,7 +48,7 @@ public class ListenerQueue<K, V, E> { private final Map<Set<Map.Entry<K, V>>, EventDispatcher<K, V, E>> queue; /** - * Once the listener queue has been used to dispatch an event, + * Once the listener queue has been used to dispatch an event, * you cannot add modify the queue. * Access to this field must be protected by a synchronized region. */ diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/internal/reliablefile/ReliableFile.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/internal/reliablefile/ReliableFile.java index ca2b71651..7cd527100 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/internal/reliablefile/ReliableFile.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/internal/reliablefile/ReliableFile.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,17 +27,17 @@ import java.util.zip.Checksum; */ public class ReliableFile { /** - * Open mask. Obtain the best data stream available. If the primary data - * contents are invalid (corrupt, missing, etc.), the data for a prior - * version may be used. + * Open mask. Obtain the best data stream available. If the primary data + * contents are invalid (corrupt, missing, etc.), the data for a prior + * version may be used. * An IOException will be thrown if a valid data content can not be - * determined. + * determined. * This is mutually exclusive with <code>OPEN_FAIL_ON_PRIMARY</code>. */ public static final int OPEN_BEST_AVAILABLE = 0; /** - * Open mask. Obtain only the data stream for the primary file where any other - * version will not be valid. This should be used for data streams that are + * Open mask. Obtain only the data stream for the primary file where any other + * version will not be valid. This should be used for data streams that are * managed as a group as a prior contents may not match the other group data. * If the primary data is not invalid, a IOException will be thrown. * This is mutually exclusive with <code>OPEN_BEST_AVAILABLE</code>. @@ -62,14 +62,14 @@ public class ReliableFile { /** * Property to set the maximum size of a file that will be buffered. When calculating a ReliableFile - * checksum, if the file is this size or small, ReliableFile will read the file contents into a + * checksum, if the file is this size or small, ReliableFile will read the file contents into a * <code>BufferedInputStream</code> and reset the buffer to avoid having to read the data from the * media twice. Since this method require memory for storage, it is limited to this size. The default * maximum is 128-KBytes. */ public static final String PROP_MAX_BUFFER = "osgi.reliableFile.maxInputStreamBuffer"; //$NON-NLS-1$ /** - * The maximum number of generations to keep as backup files in case last generation + * The maximum number of generations to keep as backup files in case last generation * file is determined to be invalid. */ public static final String PROP_MAX_GENERATIONS = "osgi.ReliableFile.maxGenerations"; //$NON-NLS-1$ @@ -231,7 +231,7 @@ public class ReliableFile { * Returns an InputStream object for reading the target file. * * @param generation the maximum generation to evaluate - * @param openMask mask used to open data. + * @param openMask mask used to open data. * are invalid (corrupt, missing, etc). * @return An InputStream object which can be used to read the target file. * @throws IOException If an error occurs preparing the file. @@ -340,7 +340,7 @@ public class ReliableFile { /** * Returns an OutputStream object for writing the target file. - * + * * @param append append new data to an existing file. * @param appendGeneration specific generation of file to append from. * @return An OutputStream object which can be used to write the target file. @@ -445,7 +445,7 @@ public class ReliableFile { String name = referenceFile.getName(); File parent = new File(referenceFile.getParent()); int generationCount = generations.length; - // if a base file is in the list (0 in generations[]), we will + // if a base file is in the list (0 in generations[]), we will // never delete these files, so don't count them in the old // generation count. if (generations[generationCount - 1] == 0) @@ -529,7 +529,7 @@ public class ReliableFile { /** * Answers a boolean indicating whether or not the specified reliable file - * exists on the underlying file system. This call only returns if a file + * exists on the underlying file system. This call only returns if a file * exists and not if the file contents are valid. * @param file returns true if the specified reliable file exists; otherwise false is returned * @@ -556,7 +556,7 @@ public class ReliableFile { } /** - * Returns the time that the reliable file was last modified. Only the time + * Returns the time that the reliable file was last modified. Only the time * of the last file generation is returned. * @param file the file to determine the time of. * @return time the file was last modified (see java.io.File.lastModified()). @@ -590,7 +590,7 @@ public class ReliableFile { /** * Returns the a version number of a reliable managed file. The version can be expected * to be unique for each successful file update. - * + * * @param file the file to determine the version of. * @return a unique version of this current file. A value of -1 indicates the file does * not exist or an error occurred. @@ -634,7 +634,7 @@ public class ReliableFile { * Get a list of ReliableFile base names in a given directory. Only files with a valid * ReliableFile generation are included. * @param directory the directory to inquire. - * @return an array of ReliableFile names in the directory. + * @return an array of ReliableFile names in the directory. * @throws IOException if an error occurs. */ public static String[] getBaseFiles(File directory) throws IOException { @@ -682,7 +682,7 @@ public class ReliableFile { } /** - * Inform ReliableFile that a file has been updated outside of + * Inform ReliableFile that a file has been updated outside of * ReliableFile. * @param file */ @@ -710,10 +710,10 @@ public class ReliableFile { /** * Returns the size of the ReliableFile signature + CRC at the end of the file. - * This method should be called only after calling getInputStream() or + * This method should be called only after calling getInputStream() or * getOutputStream() methods. * - * @return <code>int</code> size of the ReliableFIle signature + CRC appended + * @return <code>int</code> size of the ReliableFIle signature + CRC appended * to the end of the file. * @throws IOException if getInputStream() or getOutputStream has not been * called. @@ -745,11 +745,11 @@ public class ReliableFile { } /** - * Returns a Checksum object for the current file contents. This method - * should be called only after calling getInputStream() or + * Returns a Checksum object for the current file contents. This method + * should be called only after calling getInputStream() or * getOutputStream() methods. * - * @return Object implementing Checksum interface initialized to the + * @return Object implementing Checksum interface initialized to the * current file contents. * @throws IOException if getOutputStream for append has not been called. */ diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/internal/reliablefile/ReliableFileInputStream.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/internal/reliablefile/ReliableFileInputStream.java index 2c514dc94..089f0e63e 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/internal/reliablefile/ReliableFileInputStream.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/internal/reliablefile/ReliableFileInputStream.java @@ -30,17 +30,17 @@ public class ReliableFileInputStream extends FilterInputStream { */ private ReliableFile reliable; - /** + /** * size of crc and signature */ private int sigSize; - /** + /** * current position reading from file */ private long readPos; - /** + /** * total file length available for reading */ private long length; @@ -72,7 +72,7 @@ public class ReliableFileInputStream extends FilterInputStream { /** * Constructs a new ReliableFileInputStream on the File <code>file</code>. If the * file does not exist, the <code>FileNotFoundException</code> is thrown. - * + * * @param file the File on which to stream reads. * @param generation a specific generation requested. * @param openMask mask used to open data. @@ -84,10 +84,10 @@ public class ReliableFileInputStream extends FilterInputStream { } /** - * + * * @param reliable The ReliableFile on which to read. * @param generation a specific generation requested. - * @param openMask mask used to open data. + * @param openMask mask used to open data. * are invalid (corrupt, missing, etc). * @throws IOException If an error occurs opening the file. */ @@ -170,7 +170,7 @@ public class ReliableFileInputStream extends FilterInputStream { /** * Override default available method. - * @throws IOException + * @throws IOException * @see FilterInputStream#available() */ @Override diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/FrameworkLog.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/FrameworkLog.java index c09858966..eb1ff489b 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/FrameworkLog.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/FrameworkLog.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,18 +19,18 @@ import org.osgi.framework.FrameworkEvent; /** * The FramworkLog interface. A FrameworkLog implementation is provided by the * FrameworkAdaptor and used by the Framework to log any error messages and - * FrameworkEvents of type ERROR. The FrameworkLog may persist the log messages + * FrameworkEvents of type ERROR. The FrameworkLog may persist the log messages * to the filesystem or allow other ways of accessing the log information. * @since 3.1 * @noimplement This interface is not intended to be implemented by clients. */ public interface FrameworkLog { /** - * A service lookup constant (value "performance") indicating an - * implementation of the logging service that logs performance events. - * Create a filter with this property set to <code>"true"</code> in order to + * A service lookup constant (value "performance") indicating an + * implementation of the logging service that logs performance events. + * Create a filter with this property set to <code>"true"</code> in order to * obtain a performance log. - * + * * @since 3.1 */ public static final String SERVICE_PERFORMANCE = "performance"; //$NON-NLS-1$ @@ -50,28 +50,28 @@ public interface FrameworkLog { /** * Sets the current Writer used to log messages to the specified * newWriter. If append is set to true then the content - * of the current Writer will be appended to the new Writer + * of the current Writer will be appended to the new Writer * if possible. - * @param newWriter The Writer to use for logging messages. + * @param newWriter The Writer to use for logging messages. * @param append Indicates whether the content of the current Writer - * used for logging messages should be appended to the end of the new + * used for logging messages should be appended to the end of the new * Writer. */ public void setWriter(Writer newWriter, boolean append); - /** + /** * Sets the current File used to log messages to a FileWriter - * using the specified File. If append is set to true then the - * content of the current Writer will be appended to the + * using the specified File. If append is set to true then the + * content of the current Writer will be appended to the * new File if possible. * @param newFile The File to create a new FileWriter which will be * used for logging messages. * @param append Indicates whether the content of the current Writer - * used for logging messages should be appended to the end of the new + * used for logging messages should be appended to the end of the new * File. * @throws IOException if any problem occurs while constructing a - * FileWriter from the newFile. If this exception is thrown the - * FrameworkLog will not be affected and will continue to use the + * FileWriter from the newFile. If this exception is thrown the + * FrameworkLog will not be affected and will continue to use the * current Writer to log messages. */ public void setFile(File newFile, boolean append) throws IOException; diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/FrameworkLogEntry.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/FrameworkLogEntry.java index be7dab922..1a1dcb5da 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/FrameworkLogEntry.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/FrameworkLogEntry.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,21 +27,21 @@ public class FrameworkLogEntry { */ public static final int OK = 0; - /** + /** * Severity constant (bit mask, value 1) indicating this log entry is informational only. * @see #getSeverity() * @since 3.2 */ public static final int INFO = 0x01; - /** + /** * Severity constant (bit mask, value 2) indicating this log entry represents a warning. * @see #getSeverity() * @since 3.2 */ public static final int WARNING = 0x02; - /** + /** * Severity constant (bit mask, value 4) indicating this log entry represents an error. * @see #getSeverity() * @since 3.2 @@ -57,7 +57,7 @@ public class FrameworkLogEntry { // It would be nice to rename some of these fields but we cannot change the getter method // names without breaking clients. Changing only the field names would be confusing. - //TODO "entry" has another meaning here - title, summary, tag are better names + //TODO "entry" has another meaning here - title, summary, tag are better names private final String entry; private final String message; //TODO get rid of this @@ -120,7 +120,7 @@ public class FrameworkLogEntry { } /** - * + * * @return Returns the children. */ public FrameworkLogEntry[] getChildren() { @@ -170,7 +170,7 @@ public class FrameworkLogEntry { * no children. * </p> * - * @return the severity: one of <code>OK</code>, <code>ERROR</code>, + * @return the severity: one of <code>OK</code>, <code>ERROR</code>, * <code>INFO</code>, <code>WARNING</code>, or <code>CANCEL</code> * @since 3.2 */ @@ -191,7 +191,7 @@ public class FrameworkLogEntry { /** * Returns the context associated with this <code>FrameworkLogEntry</code> * object. - * + * * @return <code>Object</code> containing the context associated with this * <code>FrameworkLogEntry</code> object;<code>null</code> if no context is * associated with this <code>FrameworkLogEntry</code> object. diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/location/LocationHelper.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/location/LocationHelper.java index 19237ed91..eaf93e2ed 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/location/LocationHelper.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/location/LocationHelper.java @@ -1,13 +1,13 @@ /******************************************************************************* * Copyright (c) 2006, 2016 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 *******************************************************************************/ @@ -129,7 +129,7 @@ public class LocationHelper { } public static String decode(String urlString, boolean plusEncoded) { - //first encode '+' characters, because URLDecoder incorrectly converts + //first encode '+' characters, because URLDecoder incorrectly converts //them to spaces on certain class library implementations. if (plusEncoded && urlString.indexOf('+') >= 0) { int len = urlString.length(); diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/location/Locker.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/location/Locker.java index 217ad8ca0..7a64386a3 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/location/Locker.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/location/Locker.java @@ -27,7 +27,7 @@ public interface Locker { static class MockLocker implements Locker { /** - * @throws IOException + * @throws IOException */ @Override public boolean lock() throws IOException { diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/messages/Msg.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/messages/Msg.java index e14523340..5434a0e4c 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/messages/Msg.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/messages/Msg.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/supplement/src/org/eclipse/osgi/internal/util/SupplementDebug.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/util/SupplementDebug.java index 2e22d58e0..8583e4bdc 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/util/SupplementDebug.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/internal/util/SupplementDebug.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM - Initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/report/resolution/ResolutionReport.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/report/resolution/ResolutionReport.java index bc731a1a6..df608aef4 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/report/resolution/ResolutionReport.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/report/resolution/ResolutionReport.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 *******************************************************************************/ @@ -52,7 +52,7 @@ import org.osgi.service.resolver.ResolutionException; targetTriggers.add(revision); } } - + } class DiagResolverHook implements ResolverHook, ResolutionReport.Listener { @@ -70,7 +70,7 @@ import org.osgi.service.resolver.ResolutionException; Collection<BundleCapability> candidates) { } public void end() { } - + } public ResolverHook begin(Collection<BundleRevision> triggers) { if (triggers.containsAll(targetTriggers)) { @@ -85,7 +85,7 @@ import org.osgi.service.resolver.ResolutionException; return report; } } - * </pre> + * </pre> * @since 3.10 */ public interface ResolutionReport { @@ -131,10 +131,10 @@ public interface ResolutionReport { // TODO Can this make use of generics? Or should this be Map<String, Object> // and each enum would define the key constants? /** - * Returns the data associated with this resolution report entry. The + * Returns the data associated with this resolution report entry. The * structure of the data is determined by the <code>Type</code> * of the entry and may by <code>null</code>. - * + * * @return the data associated with this resolution report entry. * @see Type */ @@ -159,7 +159,7 @@ public interface ResolutionReport { /** * Returns all resolution report entries associated with this report. - * The key is the unresolved resource and the value is a list of + * The key is the unresolved resource and the value is a list of * report entries that caused the associated resource to not be able to resolve. * @return all resolution report entries associated with this report. */ @@ -168,10 +168,10 @@ public interface ResolutionReport { /** * Returns the resolution exception associated with the resolve process * or {@code null} if there is no resolution exception. For some resolve - * operations a resolution exception may not be thrown even if the + * operations a resolution exception may not be thrown even if the * resolve process could not resolve some resources. For example, if * the resources are optional resources to resolve. - * @return the resolution exception or {@code null} if there is + * @return the resolution exception or {@code null} if there is * no resolution exception. */ ResolutionException getResolutionException(); diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/datalocation/Location.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/datalocation/Location.java index 2bddc4f96..8ca4cb0f2 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/datalocation/Location.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/datalocation/Location.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,12 +17,12 @@ import java.io.IOException; import java.net.URL; /** - * A Location represents a URL which may have a default value, may be read only, may + * A Location represents a URL which may have a default value, may be read only, may * or may not have a current value and may be cascaded on to a parent location. * <p> * This interface is not intended to be implemented by clients. * </p> - * + * * @since 3.0 * @noimplement This interface is not intended to be implemented by clients. */ @@ -31,7 +31,7 @@ public interface Location { /** * Constant which defines the filter string for acquiring the service which * specifies the instance location. - * + * * @since 3.2 */ public static final String INSTANCE_FILTER = "(&(objectClass=" + Location.class.getName() + ")(type=osgi.instance.area))"; //$NON-NLS-1$ //$NON-NLS-2$ @@ -39,7 +39,7 @@ public interface Location { /** * Constant which defines the filter string for acquiring the service which * specifies the install location. - * + * * @since 3.2 */ public static final String INSTALL_FILTER = "(&(objectClass=" + Location.class.getName() + ")(type=osgi.install.area))"; //$NON-NLS-1$ //$NON-NLS-2$ @@ -47,7 +47,7 @@ public interface Location { /** * Constant which defines the filter string for acquiring the service which * specifies the configuration location. - * + * * @since 3.2 */ public static final String CONFIGURATION_FILTER = "(&(objectClass=" + Location.class.getName() + ")(type=osgi.configuration.area))"; //$NON-NLS-1$ //$NON-NLS-2$ @@ -55,7 +55,7 @@ public interface Location { /** * Constant which defines the filter string for acquiring the service which * specifies the user location. - * + * * @since 3.2 */ public static final String USER_FILTER = "(&(objectClass=" + Location.class.getName() + ")(type=osgi.user.area))"; //$NON-NLS-1$ //$NON-NLS-2$ @@ -63,7 +63,7 @@ public interface Location { /** * Constant which defines the filter string for acquiring the service which * specifies the eclipse home location. - * + * * @since 3.4 */ public static final String ECLIPSE_HOME_FILTER = "(&(objectClass=" + Location.class.getName() + ")(type=eclipse.home.location))"; //$NON-NLS-1$ //$NON-NLS-2$ @@ -71,7 +71,7 @@ public interface Location { /** * Returns <code>true</code> if this location allows a default value to be assigned * and <code>false</code> otherwise. - * + * * @return whether or not this location can have a default value assigned */ public boolean allowsDefault(); @@ -80,24 +80,24 @@ public interface Location { * Returns the default value of this location if any. If no default is available then * <code>null</code> is returned. Note that even locations which allow defaults may still * return <code>null</code>. - * + * * @return the default value for this location or <code>null</code> */ public URL getDefault(); /** * Returns the parent of this location or <code>null</code> if none is available. - * + * * @return the parent of this location or <code>null</code> */ public Location getParentLocation(); /** - * Returns the actual {@link URL} of this location. If the location's value has been set, - * that value is returned. If the value is not set and the location allows defaults, + * Returns the actual {@link URL} of this location. If the location's value has been set, + * that value is returned. If the value is not set and the location allows defaults, * the value is set to the default and returned. In all other cases <code>null</code> * is returned. - * + * * @return the URL for this location or <code>null</code> if none */ public URL getURL(); @@ -105,7 +105,7 @@ public interface Location { /** * Returns <code>true</code> if this location has a value and <code>false</code> * otherwise. - * + * * @return boolean value indicating whether or not the value is set */ public boolean isSet(); @@ -115,18 +115,18 @@ public interface Location { * <code>false</code> otherwise. The read only character * of a location is not in enforced in any way but rather expresses the intention of the * location's creator. - * + * * @return boolean value indicating whether the location is read only */ public boolean isReadOnly(); /** - * Sets and optionally locks the location's value to the given {@link URL}. If the location + * Sets and optionally locks the location's value to the given {@link URL}. If the location * already has a value an exception is thrown. If locking is requested and fails, <code>false</code> * is returned and the {@link URL} of this location is not set. - * + * * @param value the value of this location - * @param lock whether or not to lock this location + * @param lock whether or not to lock this location * @return whether or not the location was successfully set and, if requested, locked. * @throws IllegalStateException if the location's value is already set * @deprecated use {@link #set(URL, boolean)} instead. @@ -134,12 +134,12 @@ public interface Location { public boolean setURL(URL value, boolean lock) throws IllegalStateException; /** - * Sets and optionally locks the location's value to the given {@link URL}. If the location + * Sets and optionally locks the location's value to the given {@link URL}. If the location * already has a value an exception is thrown. If locking is requested and fails, <code>false</code> * is returned and the {@link URL} of this location is not set. - * + * * @param value the value of this location - * @param lock whether or not to lock this location + * @param lock whether or not to lock this location * @return whether or not the location was successfully set and, if requested, locked. * @throws IllegalStateException if the location's value is already set * @throws IOException if there was an unexpected problem while acquiring the lock @@ -148,12 +148,12 @@ public interface Location { public boolean set(URL value, boolean lock) throws IllegalStateException, IOException; /** - * Sets and optionally locks the location's value to the given {@link URL} using the given lock file. If the location + * Sets and optionally locks the location's value to the given {@link URL} using the given lock file. If the location * already has a value an exception is thrown. If locking is requested and fails, <code>false</code> * is returned and the {@link URL} of this location is not set. - * + * * @param value the value of this location - * @param lock whether or not to lock this location + * @param lock whether or not to lock this location * @param lockFilePath the path to the lock file. This path will be used to establish locks on this location. * The path may be an absolute path or it may be relative to the given URL. If a <code>null</code> * value is used then a default lock path will be used for this location. @@ -166,20 +166,20 @@ public interface Location { /** * Attempts to lock this location with a canonical locking mechanism and return - * <code>true</code> if the lock could be acquired. Not all locations can be + * <code>true</code> if the lock could be acquired. Not all locations can be * locked. * <p> - * Locking a location is advisory only. That is, it does not prevent other applications from + * Locking a location is advisory only. That is, it does not prevent other applications from * modifying the same location * </p> * @return true if the lock could be acquired; otherwise false is returned - * + * * @exception IOException if there was an unexpected problem while acquiring the lock */ public boolean lock() throws IOException; /** - * Releases the lock on this location. If the location is not already locked, no action + * Releases the lock on this location. If the location is not already locked, no action * is taken. */ public void release(); @@ -204,12 +204,12 @@ public interface Location { public Location createLocation(Location parent, URL defaultValue, boolean readonly); /** - * Returns a URL to the specified path within this location. The path - * of the returned URL may not exist yet. It is the responsibility of the + * Returns a URL to the specified path within this location. The path + * of the returned URL may not exist yet. It is the responsibility of the * client to create the content of the data area returned if it does not exist. * <p> - * This method can be used to obtain a private area within the given location. - * For example use the symbolic name of a bundle to obtain a data area specific + * This method can be used to obtain a private area within the given location. + * For example use the symbolic name of a bundle to obtain a data area specific * to that bundle. * </p> * <p> @@ -218,7 +218,7 @@ public interface Location { * this method is called and the location URL has not been set and there is * no default value for this location. * </p> - * + * * @param path the name of the path to get from this location * @return the URL to the data area with the specified path. * @throws IOException if the location URL is not already set diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptions.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptions.java index 2ff4026bf..46d10ca33 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptions.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptions.java @@ -19,29 +19,29 @@ import java.util.Map; /** * Used to get debug options settings and creating a new {@link DebugTrace} instance for * a bundle to use for dynamic tracing. - * + * * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. * @since 3.1 */ public interface DebugOptions { /** - * The service property (named "listener.symbolic.name") which specifies + * The service property (named "listener.symbolic.name") which specifies * the bundle symbolic name of a {@link DebugOptionsListener} service. - * + * * @since 3.5 */ public static String LISTENER_SYMBOLICNAME = "listener.symbolic.name"; //$NON-NLS-1$ /** * Returns the identified option as a boolean value. The specified - * defaultValue is returned if no such option is found or if debug is not enabled. - * + * defaultValue is returned if no such option is found or if debug is not enabled. + * * <p> - * Options are specified in the general form <i><Bundle-SymbolicName>/<option-path></i>. + * Options are specified in the general form <i><Bundle-SymbolicName>/<option-path></i>. * For example, <code>org.eclipse.core.runtime/debug</code> * </p> - * + * * @param option the name of the option to lookup * @param defaultValue the value to return if no such option is found * @return the value of the requested debug option or the @@ -52,28 +52,28 @@ public interface DebugOptions { /** * Returns the identified option. A <code>null</code> value * is returned if no such option is found or if debug is not enabled. - * + * * <p> * Options are specified - * in the general form <i><Bundle-SymbolicName>/<option-path></i>. + * in the general form <i><Bundle-SymbolicName>/<option-path></i>. * For example, <code>org.eclipse.core.runtime/debug</code> *</p> - * + * * @param option the name of the option to lookup * @return the value of the requested debug option or <code>null</code> */ public abstract String getOption(String option); /** - * Returns the identified option. The specified defaultValue is + * Returns the identified option. The specified defaultValue is * returned if no such option is found or if debug is not enabled. - * + * * <p> * Options are specified - * in the general form <i><Bundle-SymbolicName>/<option-path></i>. + * in the general form <i><Bundle-SymbolicName>/<option-path></i>. * For example, <code>org.eclipse.core.runtime/debug</code> * </p> - * + * * @param option the name of the option to lookup * @param defaultValue the value to return if no such option is found * @return the value of the requested debug option or the @@ -83,16 +83,16 @@ public interface DebugOptions { /** * Returns the identified option as an int value. The specified - * defaultValue is returned if no such option is found or if a - * NumberFormatException is thrown while converting the option value + * defaultValue is returned if no such option is found or if a + * NumberFormatException is thrown while converting the option value * to an integer or if debug is not enabled. - * + * * <p> * Options are specified - * in the general form <i><Bundle-SymbolicName>/<option-path></i>. + * in the general form <i><Bundle-SymbolicName>/<option-path></i>. * For example, <code>org.eclipse.core.runtime/debug</code> * </p> - * + * * @param option the name of the option to lookup * @param defaultValue the value to return if no such option is found * @return the value of the requested debug option or the @@ -101,11 +101,11 @@ public interface DebugOptions { public abstract int getIntegerOption(String option, int defaultValue); /** - * Returns a snapshot of the current options. All + * Returns a snapshot of the current options. All * keys and values are of type <code>String</code>. If no * options are set then an empty map is returned. * <p> - * If debug is not enabled then the snapshot of the current disabled + * If debug is not enabled then the snapshot of the current disabled * values is returned. See {@link DebugOptions#setDebugEnabled(boolean)}. * </p> * @return a snapshot of the current options. @@ -114,7 +114,7 @@ public interface DebugOptions { public Map<String, String> getOptions(); /** - * Sets the identified option to the identified value. If debug is + * Sets the identified option to the identified value. If debug is * not enabled then the specified option is not changed. * @param option the name of the option to set * @param value the value of the option to set @@ -124,13 +124,13 @@ public interface DebugOptions { /** * Sets the current option key/value pairs to the specified options. * The specified map replaces all keys and values of the current debug options. - * An <code>IllegalArgumentException</code> is thrown if any key or value + * An <code>IllegalArgumentException</code> is thrown if any key or value * in the specified map is not of type <code>String</code>. * <p> * If debug is not enabled then the specified options are saved as - * the disabled values and no notifications will be sent. + * the disabled values and no notifications will be sent. * See {@link DebugOptions#setDebugEnabled(boolean)}. - * If debug is enabled then notifications will be sent to the + * If debug is enabled then notifications will be sent to the * listeners which have options that have been changed, added or removed. * </p> @@ -160,8 +160,8 @@ public interface DebugOptions { * When debug is disabled all debug options are unset. * When disabling debug the current debug option values are * stored in memory as disabled values. If debug is re-enabled the - * disabled values will be set back and enabled. The disabled values - * are only stored in memory and if the framework is restarted then + * disabled values will be set back and enabled. The disabled values + * are only stored in memory and if the framework is restarted then * the disabled option values will be lost. * </p> * @param value If <code>true</code>, debug is enabled, otherwise @@ -170,12 +170,12 @@ public interface DebugOptions { */ public abstract void setDebugEnabled(boolean value); - /** + /** * Sets the current file used to trace messages to. * A <code>null</code> value is allowed which indicates * that <code>System.out</code> will be used * for trace messages. - * + * * @param newFile The file to be used for tracing messages. * A <code>null</code> value is allowed. * @since 3.5 @@ -186,7 +186,7 @@ public interface DebugOptions { * Returns the trace file if it is set, otherwise <code>null</code> is returned. * A <code>null</code> value indicates that <code>System.out</code> is used * for trace messages. - * + * * @return the trace file if it is set, otherwise <code>null</code> is returned. * @since 3.5 */ @@ -196,13 +196,13 @@ public interface DebugOptions { * Creates a new <code>DebugTrace</code> instance for the specified bundle symbolic name. * If a <code>DebugTrace</code> object has already been created for the specified symbolic * name then the existing <code>DebugTrace</code> object will be returned. - * + * * The class name, method name, and line number of any callers to the <code>DebugTrace</code> * API will automatically be determined by parsing the stack trace of the executing thread. - * These attributes will be set based on the first caller of this API. - * + * These attributes will be set based on the first caller of this API. + * * @param bundleSymbolicName The symbolic name of the bundle that is requesting a - * new instance of a <code>DebugTrace</code>. + * new instance of a <code>DebugTrace</code>. * @return A new or existing <code>DebugTrace</code> object for the specified plug-in ID * @since 3.5 */ @@ -220,7 +220,7 @@ public interface DebugOptions { * * @param bundleSymbolicName The symbolic name of the bundle that is requesting a * new instance of a <code>DebugTrace</code>. - * @param traceEntryClass The class that is being used to abstract tracing calls for a bundle. + * @param traceEntryClass The class that is being used to abstract tracing calls for a bundle. * @return A new or existing <code>DebugTrace</code> object for the specified plug-in ID * @since 3.5 */ diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptionsListener.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptionsListener.java index b67952345..c6262985c 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptionsListener.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugOptionsListener.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,14 +16,14 @@ package org.eclipse.osgi.service.debug; import java.util.EventListener; /** - * A debug options listener is notified whenever one of its plug-in option-path entries is + * A debug options listener is notified whenever one of its plug-in option-path entries is * changed. A listener is registered as an OSGi service using the {@link DebugOptions#LISTENER_SYMBOLICNAME} * service property to specify the symbolic name of the debug options listener. * <p> - * The {@link DebugOptionsListener#optionsChanged(DebugOptions)} method will automatically - * be called upon registration of the debug options listener service. This allows the - * listener to obtain the initial debug options. This initial call to the listener - * will happen even if debug is not enabled at the time of registration + * The {@link DebugOptionsListener#optionsChanged(DebugOptions)} method will automatically + * be called upon registration of the debug options listener service. This allows the + * listener to obtain the initial debug options. This initial call to the listener + * will happen even if debug is not enabled at the time of registration * ({@link DebugOptions#isDebugEnabled()} will return false in this case). * </p> * A debug options listener allows a bundle to cache trace option values in boolean fields for performance @@ -32,25 +32,25 @@ import java.util.EventListener; * public class Activator implements BundleActivator, DebugOptionsListener { * public static boolean DEBUG = false; * public static DebugTrace trace; - * + * * public void start(BundleContext context) { * Hashtable props = new Hashtable(4); * props.put(DebugOptions.LISTENER_SYMBOLICNAME, "com.mycompany.mybundle"); * context.registerService(DebugOptionsListener.class.getName(), this, props); * } - * + * * public void optionsChanged(DebugOptions options) { * if (trace == null) * trace = options.newDebugTrace("com.mycompany.mybundle"); * DEBUG = options.getBooleanOption("com.mycompany.mybundle/debug", false); * } - * + * * public void doSomeWork() { * if (DEBUG) * trace.trace(null, "Doing some work"); * } * ... - * } + * } * </pre> * @since 3.5 */ @@ -58,9 +58,9 @@ public interface DebugOptionsListener extends EventListener { /** * Notifies this listener that an option-path for its plug-in has changed. - * This method is also called initially by the DebugOptions implementation + * This method is also called initially by the DebugOptions implementation * when the listener is registered as a service. This allows the listener - * to obtain the initial set of debug options without the need to + * to obtain the initial set of debug options without the need to * acquire the debug options service. * @param options a reference to the DebugOptions */ diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugTrace.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugTrace.java index fc51616fe..35b4137d4 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugTrace.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/DebugTrace.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.service.debug; /** * A DebugTrace is used to record debug trace statements, based on the current * option settings in a corresponding {@link DebugOptions} class. The trace implementation - * will automatically insert additional contextual information such as the bundle, class, - * and method performing the tracing. + * will automatically insert additional contextual information such as the bundle, class, + * and method performing the tracing. * <p> - * Trace statements may be written to a file, or onto standard output, depending on + * Trace statements may be written to a file, or onto standard output, depending on * how the {@link DebugOptions} is configured (See {@link DebugOptions#setFile(java.io.File)}). * </p> * <p> @@ -32,11 +32,11 @@ package org.eclipse.osgi.service.debug; * has a value of "true". * </p> * <p> - * Note that the pipe character ("|") is reserved for internal use. If this character + * Note that the pipe character ("|") is reserved for internal use. If this character * happens to occur in any of the thread name, the option, the message or an Exception - * message, it will be escaped to the corresponding HTML representation ("&#124;"). + * message, it will be escaped to the corresponding HTML representation ("&#124;"). * </p> - * + * * @since 3.5 * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. @@ -45,7 +45,7 @@ public interface DebugTrace { /** * Traces a message for the specified option. - * + * * @param option The name of the boolean option that will control whether the * trace statement is printed (e.g., "/debug/myComponent"), or <code>null</code> * @param message The trace message to display @@ -54,7 +54,7 @@ public interface DebugTrace { /** * Traces a message and exception for the specified option. - * + * * @param option The name of the boolean option that will control whether the * trace statement is printed (e.g., "/debug/myComponent"), or <code>null</code> * @param message The trace message to display @@ -63,7 +63,7 @@ public interface DebugTrace { public void trace(final String option, final String message, final Throwable error); /** - * Adds a trace message showing a thread stack dump for the current class and + * Adds a trace message showing a thread stack dump for the current class and * method being executed for the specified option. * * @param option The name of the boolean option that will control whether the @@ -73,17 +73,17 @@ public interface DebugTrace { /** * Add a trace message level stating that a method is being executed for the specified option. - * + * * @param option The name of the boolean option that will control whether the * trace statement is printed (e.g., "/debug/myComponent"), or <code>null</code> */ public void traceEntry(final String option); /** - * Add a trace message level stating that a method with the specified argument - * values is being executed for the specified option. The result of {@link String#valueOf(Object)} + * Add a trace message level stating that a method with the specified argument + * values is being executed for the specified option. The result of {@link String#valueOf(Object)} * on the methodArgument will be written to the trace file. - * + * * @param option The name of the boolean option that will control whether the * trace statement is printed (e.g., "/debug/myComponent"), or <code>null</code> * @param methodArgument @@ -92,10 +92,10 @@ public interface DebugTrace { public void traceEntry(final String option, final Object methodArgument); /** - * Add a trace message level stating that a method with the specified arguments - * values is being executed for the specified option. The result of {@link String#valueOf(Object)} + * Add a trace message level stating that a method with the specified arguments + * values is being executed for the specified option. The result of {@link String#valueOf(Object)} * on each argument will be written to the trace file. - * + * * @param option The name of the boolean option that will control whether the * trace statement is printed (e.g., "/debug/myComponent"), or <code>null</code> * @param methodArguments @@ -105,17 +105,17 @@ public interface DebugTrace { /** * Add a trace message level stating that a method has completed execution for the specified option. - * + * * @param option The name of the boolean option that will control whether the * trace statement is printed (e.g., "/debug/myComponent"), or <code>null</code> */ public void traceExit(final String option); /** - * Add a trace message level stating that a method with the specified result value - * has completed execution for the specified option. The result of {@link String#valueOf(Object)} + * Add a trace message level stating that a method with the specified result value + * has completed execution for the specified option. The result of {@link String#valueOf(Object)} * on the result object will be written to the trace file. - * + * * @param option The name of the boolean option that will control whether the * trace statement is printed (e.g., "/debug/myComponent"), or <code>null</code> * @param result The result being returned from the method that was executed diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/Constants.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/Constants.java index ba7496301..090284a28 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/Constants.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/Constants.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 *******************************************************************************/ @@ -142,7 +142,7 @@ public interface Constants { /** * Constant string (value "x86_64") indicating the platform is running on an * x86 64bit-based architecture. - * + * * @since 3.1 */ public static final String ARCH_X86_64 = "x86_64";//$NON-NLS-1$ @@ -150,7 +150,7 @@ public interface Constants { /** * Constant string (value "amd64") indicating the platform is running on an * AMD64-based architecture. - * + * * @deprecated use <code>ARCH_X86_64</code> instead. Note the values * has been changed to be the value of the <code>ARCH_X86_64</code> constant. */ @@ -165,7 +165,7 @@ public interface Constants { /** * Constant string (value "ia64_32") indicating the platform is running on an * IA64 32bit-based architecture. - * + * * @since 3.1 */ public static final String ARCH_IA64_32 = "ia64_32";//$NON-NLS-1$ diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/EnvironmentInfo.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/EnvironmentInfo.java index 68835a8c5..6e3277af0 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/EnvironmentInfo.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/EnvironmentInfo.java @@ -16,12 +16,12 @@ package org.eclipse.osgi.service.environment; /** * A Framework service which gives access to the command line used to start * this running framework as well as information about the environment - * such as the current operating system, machine architecture, locale and + * such as the current operating system, machine architecture, locale and * windowing system. * <p> * This interface is not intended to be implemented by clients. * </p> - * + * * @since 3.0 * @noimplement This interface is not intended to be implemented by clients. */ @@ -31,7 +31,7 @@ public interface EnvironmentInfo { /** * Returns all command line arguments specified when the running framework was started. - * + * * @return the array of command line arguments. */ public String[] getCommandLineArgs(); @@ -39,7 +39,7 @@ public interface EnvironmentInfo { /** * Returns the arguments consumed by the framework implementation itself. Which * arguments are consumed is implementation specific. - * + * * @return the array of command line arguments consumed by the framework. */ public String[] getFrameworkArgs(); @@ -47,17 +47,17 @@ public interface EnvironmentInfo { /** * Returns the arguments not consumed by the framework implementation itself. Which * arguments are consumed is implementation specific. - * + * * @return the array of command line arguments not consumed by the framework. */ public String[] getNonFrameworkArgs(); /** - * Returns the string name of the current system architecture. - * The value is a user-defined string if the architecture is - * specified on the command line, otherwise it is the value + * Returns the string name of the current system architecture. + * The value is a user-defined string if the architecture is + * specified on the command line, otherwise it is the value * returned by <code>java.lang.System.getProperty("os.arch")</code>. - * + * * @return the string name of the current system architecture */ public String getOSArch(); @@ -72,11 +72,11 @@ public interface EnvironmentInfo { /** * Returns the string name of the current operating system for use in finding - * files whose path starts with <code>$os$</code>. Return {@link Constants#OS_UNKNOWN} + * files whose path starts with <code>$os$</code>. Return {@link Constants#OS_UNKNOWN} * if the operating system cannot be determined. - * <p> + * <p> * The value may indicate one of the operating systems known to the platform - * (as specified in <code>org.eclipse.core.runtime.Platform#knownOSValues</code>) + * (as specified in <code>org.eclipse.core.runtime.Platform#knownOSValues</code>) * or a user-defined string if the operating system name is specified on the command line. * </p> * @@ -96,7 +96,7 @@ public interface EnvironmentInfo { /** * Returns <code>true</code> if the framework is in debug mode and * <code>false</code> otherwise. - * + * * @return whether or not the framework is in debug mode */ public boolean inDebugMode(); @@ -104,15 +104,15 @@ public interface EnvironmentInfo { /** * Returns <code>true</code> if the framework is in development mode * and <code>false</code> otherwise. - * + * * @return whether or not the framework is in development mode */ public boolean inDevelopmentMode(); /** - * Returns the value for the specified property. Environment Properties are + * Returns the value for the specified property. Environment Properties are * backed by the Java system properties. When the option - * <code>osgi.framework.useSystemProperties</code> is used then + * <code>osgi.framework.useSystemProperties</code> is used then * the environment properties are specific for each instance of the framework. * <p> * This method should be used instead of the <code>System.getProperty(String)</code> @@ -125,9 +125,9 @@ public interface EnvironmentInfo { public String getProperty(String key); /** - * Sets the value for the specified property. Environment Properties are + * Sets the value for the specified property. Environment Properties are * backed by the Java system properties. When the option - * <code>osgi.framework.useSystemProperties</code> is used then + * <code>osgi.framework.useSystemProperties</code> is used then * the environment properties are specific for each instance of the framework. * <p> * This method should be used instead of the <code>System.setProperty(String, String)</code> diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/BundleLocalization.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/BundleLocalization.java index 11c285a3f..e0d1492e8 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/BundleLocalization.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/BundleLocalization.java @@ -17,8 +17,8 @@ import java.util.ResourceBundle; import org.osgi.framework.Bundle; /** - * The interface of the service that gets {@link ResourceBundle} objects from a given - * bundle with a given locale. + * The interface of the service that gets {@link ResourceBundle} objects from a given + * bundle with a given locale. * <p> * This interface is not intended to be implemented by clients. * </p> @@ -32,7 +32,7 @@ public interface BundleLocalization { * @param bundle the bundle to get localization for * @param locale the name of the locale to get, or <code>null</code> if * the default locale is to be used - * + * * @return A <code>ResourceBundle</code> object for the given bundle and locale, * or <code>null</code> is returned if no ResourceBundle object can * be loaded. diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/LocaleProvider.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/LocaleProvider.java index 464395151..562cac9ad 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/LocaleProvider.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/LocaleProvider.java @@ -16,16 +16,16 @@ package org.eclipse.osgi.service.localization; import java.util.Locale; /** - * A service that is used to determine what the current locale is for a - * particular context or session. If no <code>LocaleProvider</code> - * service is available then the locale must be determined by other + * A service that is used to determine what the current locale is for a + * particular context or session. If no <code>LocaleProvider</code> + * service is available then the locale must be determined by other * means, for example, by calling {@link Locale#getDefault()}. * <p> - * More advanced environments can support multiple locales within a - * single system. For example, a server may support multiple users, - * each needing a different locale. In such an environment a - * <code>LocaleProvider</code> service must be registered that can - * determine the current locale for the context of the call to the + * More advanced environments can support multiple locales within a + * single system. For example, a server may support multiple users, + * each needing a different locale. In such an environment a + * <code>LocaleProvider</code> service must be registered that can + * determine the current locale for the context of the call to the * {@link #getLocale()} method. * </p> * @since 1.1 @@ -33,12 +33,12 @@ import java.util.Locale; public interface LocaleProvider { /** - * Determines the current locale for the context of the call to - * this method. For environments that support a single system wide + * Determines the current locale for the context of the call to + * this method. For environments that support a single system wide * locale, this is equivalent to calling {@link Locale#getDefault()}. * <p> - * The result of this method should not be retained or passed to other - * threads. The current locale can change any time and may be + * The result of this method should not be retained or passed to other + * threads. The current locale can change any time and may be * different for each thread. * </p> * @return The current locale. diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ApplicationLauncher.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ApplicationLauncher.java index fc9a60274..e03613148 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ApplicationLauncher.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ApplicationLauncher.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.runnable; /** - * An ApplicationLauncher is used to launch ParameterizedRunnable objects using + * An ApplicationLauncher is used to launch ParameterizedRunnable objects using * the main thread. * <p> * This interface is not intended to be implemented by clients. @@ -24,7 +24,7 @@ package org.eclipse.osgi.service.runnable; * This class is for internal use by the platform-related plug-ins. * Clients outside of the base platform should not reference or subclass this class. * </p> - * + * * @since 3.2 * @noimplement This interface is not intended to be implemented by clients. */ @@ -37,11 +37,11 @@ public interface ApplicationLauncher { void launch(ParameterizedRunnable runnable, Object context); /** - * Forces the current runnable which is running to be stopped. + * Forces the current runnable which is running to be stopped. * This method will return after the currently running ParameterizedRunnable * has completely stopped. * <p> - * After this method returns this ApplicationLauncher will no longer allow + * After this method returns this ApplicationLauncher will no longer allow * applications to be launched. */ void shutdown(); diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ParameterizedRunnable.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ParameterizedRunnable.java index 7d99a8b91..8b0ec51fd 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ParameterizedRunnable.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ParameterizedRunnable.java @@ -7,16 +7,16 @@ * 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.runnable; /** - * Like a {@link java.lang.Runnable}, an object which captures a block of code which can - * be passed around and executed. Unlike standard runnables, paramaterized - * runnables allow an arbitrary {@link java.lang.Object} to be passed in when the + * Like a {@link java.lang.Runnable}, an object which captures a block of code which can + * be passed around and executed. Unlike standard runnables, paramaterized + * runnables allow an arbitrary {@link java.lang.Object} to be passed in when the * block is evaluated. * <p> * Clients may implement this interface. @@ -32,7 +32,7 @@ public interface ParameterizedRunnable { /** * Executes the block of code encapsulated by this runnable in the context of * the given object and returns the result. The result may be <code>null</code>. - * + * * @param context the context for evaluating the runnable * @return the result of evaluating the runnable in the given context * @throws Exception if there is a problem running this runnable diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/StartupMonitor.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/StartupMonitor.java index 73af2f475..d6ef39431 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/StartupMonitor.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/StartupMonitor.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 *******************************************************************************/ @@ -15,40 +15,40 @@ package org.eclipse.osgi.service.runnable; /** * Service interface used to monitor the startup process. - * - * Bundles can register a monitor in order to be given processing time on the + * + * Bundles can register a monitor in order to be given processing time on the * primary thread during the startup process. Clients with threading restrictions can * use this interface to process events that may have been collected from another thread. - * <p> - * Monitors share time on the primary thread. The primary thread used to run the application - * will not proceed until monitors return from any operation. Because of this, monitors should + * <p> + * Monitors share time on the primary thread. The primary thread used to run the application + * will not proceed until monitors return from any operation. Because of this, monitors should * not perform long running operations. * </p> * <p> - * Clients may implement this interface but should not invoke it. The platform + * Clients may implement this interface but should not invoke it. The platform * is responsible for invoking the monitor at the appropriate times. - * </p> + * </p> * @since 3.3 */ public interface StartupMonitor { - /** - * Update the monitor. This method is periodically called by the platform from the primary thread during + /** + * Update the monitor. This method is periodically called by the platform from the primary thread during * periods where the primary thread is waiting on another thread (ie start level increasing, refreshing packages) * <p> - * If multiple monitors are registered then the platform will only call the monitor with the highest service - * ranking. In case of a service ranking tie the service with the lowest service id is selected (i.e. the + * If multiple monitors are registered then the platform will only call the monitor with the highest service + * ranking. In case of a service ranking tie the service with the lowest service id is selected (i.e. the * first monitor registered). * </p> */ public void update(); /** - * This method is called by the platform from the primary thread once the application is completely - * initialized and running. This method should perform certain operations that are needed once an + * This method is called by the platform from the primary thread once the application is completely + * initialized and running. This method should perform certain operations that are needed once an * application is running. One example is bringing down a splash screen if it exists. * <p> * If multiple monitors are registered then the platform will call all monitors. The monitors are called - * according to service ranking; monitors with higher service rankings are called first. In case of a + * according to service ranking; monitors with higher service rankings are called first. In case of a * service ranking tie the service with the lowest service id is called first (i.e. the first monitor registered). * </p> */ diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/urlconversion/URLConverter.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/urlconversion/URLConverter.java index 326b3757e..0bc04d90f 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/urlconversion/URLConverter.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/urlconversion/URLConverter.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 java.net.URL; * <p> * Clients may implement this interface. * </p> - * + * * @since 3.1 */ public interface URLConverter { @@ -30,13 +30,13 @@ public interface URLConverter { /** * Converts a URL that uses a user-defined protocol into a URL that uses the file * protocol. The contents of the URL may be extracted into a cache on the file-system - * in order to get a file URL. + * in order to get a file URL. * <p> * If the protocol for the given URL is not recognized by this converter, the original * URL is returned as-is. * </p> * @param url the original URL - * @return the converted file URL or the original URL passed in if it is + * @return the converted file URL or the original URL passed in if it is * not recognized by this converter * @throws IOException if an error occurs during the conversion * @since 3.2 diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/storagemanager/ManagedOutputStream.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/storagemanager/ManagedOutputStream.java index c4454e6be..53b3b98e2 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/storagemanager/ManagedOutputStream.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/storagemanager/ManagedOutputStream.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,11 +43,11 @@ public final class ManagedOutputStream extends FilterOutputStream { this.state = ST_OPEN; } - /** - * Instructs this output stream to be closed and storage manager to - * be updated as appropriate. If this managed output stream is part of + /** + * Instructs this output stream to be closed and storage manager to + * be updated as appropriate. If this managed output stream is part of * a set returned by {@link StorageManager#getOutputStreamSet(String[])} then - * the storage manager will only be updated with the new content after all + * the storage manager will only be updated with the new content after all * of the managed output streams in the set are closed successfully. * @see FilterOutputStream#close() */ @@ -58,8 +58,8 @@ public final class ManagedOutputStream extends FilterOutputStream { /** * Instructs this output stream to be closed and the contents discarded. - * If this managed output stream is part of a set returned by - * {@link StorageManager#getOutputStreamSet(String[])} then the new + * If this managed output stream is part of a set returned by + * {@link StorageManager#getOutputStreamSet(String[])} then the new * content of all managed output streams in the set will be discarded. */ public void abort() { diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/storagemanager/StorageManager.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/storagemanager/StorageManager.java index 2cadd889b..9721822d7 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/storagemanager/StorageManager.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/storagemanager/StorageManager.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,8 +33,8 @@ import org.eclipse.osgi.internal.location.Locker; import org.eclipse.osgi.internal.messages.Msg; /** - * Storage managers provide a facility for tracking the state of a group of files having - * relationship with each others and being updated by several entities at the same time. + * Storage managers provide a facility for tracking the state of a group of files having + * relationship with each others and being updated by several entities at the same time. * The typical usecase is in shared configuration data areas. * <p> * The facilities provided here are cooperative. That is, all participants must @@ -55,13 +55,13 @@ import org.eclipse.osgi.internal.messages.Msg; * // Ignore the exception. The registry will be rebuilt from source. * } * - * //To read from a file + * //To read from a file * java.io.File fileA = cacheStorageManager.lookup("fileA", false)); * java.io.File fileB = cacheStorageManager.lookup("fileB", false)); - * //Do the reading code + * //Do the reading code * new java.io.FileOutputStream(fileA); * - * //To write in files + * //To write in files * cacheStorageManager.add("fileC"); //add the file to the filemanager (in this case we assume it is not already here) * cacheStorageManager.add("fileD"); * @@ -71,7 +71,7 @@ import org.eclipse.osgi.internal.messages.Msg; * * //Do the actual writing here... * - * //Finally update the storagemanager with the actual file to manage. + * //Finally update the storagemanager with the actual file to manage. * cacheStorageManager.update(new String[] {"fileC", "fileD"}, new String[] {fileC.getName(), fileD.getName()}; * * //Close the file manager at the end @@ -79,22 +79,22 @@ import org.eclipse.osgi.internal.messages.Msg; * </pre> * <p> * Implementation details <br> - * The following implementation details are provided to help with understanding the + * The following implementation details are provided to help with understanding the * behavior of this class. * The general principle is to maintain a table which maps user-level file names - * onto an actual disk files. If a file needs to be modified, + * onto an actual disk files. If a file needs to be modified, * it is stored into a new file. The old content is not removed from disk until all entities * have closed there instance of the storage manager. * Once the instance has been created, open() must be called before performing any other operation. * On open the storage manager obtains a snapshot of the current managed files contents. If an - * entity updates a managed file, the storage manager will save the content for that instance of the - * storage manager, all other storage manager instances will still have access to that managed file's + * entity updates a managed file, the storage manager will save the content for that instance of the + * storage manager, all other storage manager instances will still have access to that managed file's * content as it was when the instance was first opened. * </p> * @since 3.2 */ -// Note the implementation of this class originated from the following deprecated classes: +// Note the implementation of this class originated from the following deprecated classes: // /org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/core/runtime/adaptor/FileManager.java // /org.eclipse.osgi/eclipseAdaptor/src/org/eclipse/core/runtime/adaptor/StreamManager.java public final class StorageManager { @@ -103,7 +103,7 @@ public final class StorageManager { private static final String MANAGER_FOLDER = ".manager"; //$NON-NLS-1$ private static final String TABLE_FILE = ".fileTable"; //$NON-NLS-1$ private static final String LOCK_FILE = ".fileTableLock"; //$NON-NLS-1$ - private static final int MAX_LOCK_WAIT = 5000; // 5 seconds + private static final int MAX_LOCK_WAIT = 5000; // 5 seconds // these should be static but the tests expect to be able to create new managers after changing this setting dynamically private final boolean useReliableFiles = Boolean.valueOf(System.getProperty("osgi.useReliableFiles")).booleanValue(); //$NON-NLS-1$ private final boolean tempCleanup = Boolean.valueOf(System.getProperty("osgi.embedded.cleanTempFiles")).booleanValue(); //$NON-NLS-1$ @@ -167,10 +167,10 @@ public final class StorageManager { /** * Returns a new storage manager for the area identified by the given base * directory. - * + * * @param base the directory holding the files to be managed - * @param lockMode the lockMode to use for the storage manager. It can have one the 3 values: none, java.io, java.nio - * and also supports null in which case the lock strategy will be the global one. + * @param lockMode the lockMode to use for the storage manager. It can have one the 3 values: none, java.io, java.nio + * and also supports null in which case the lock strategy will be the global one. */ public StorageManager(File base, String lockMode) { this(base, lockMode, false); @@ -179,10 +179,10 @@ public final class StorageManager { /** * Returns a new storage manager for the area identified by the given base * directory. - * + * * @param base the directory holding the files to be managed - * @param lockMode the lockMode to use for the storage manager. It can have one the 3 values: none, java.io, java.nio - * and also supports null in which case the lock strategy will be the global one. + * @param lockMode the lockMode to use for the storage manager. It can have one the 3 values: none, java.io, java.nio + * and also supports null in which case the lock strategy will be the global one. * @param readOnly true if the managed files are read-only */ public StorageManager(File base, String lockMode, boolean readOnly) { @@ -210,7 +210,7 @@ public final class StorageManager { /** * Add the given managed file name to the list of files managed by this manager. - * + * * @param managedFile name of the file to manage * @throws IOException if there are any problems adding the given file name to the manager */ @@ -220,9 +220,9 @@ public final class StorageManager { /* (non-Javadoc * Add the given file name to the list of files managed by this manager. - * + * * @param managedFile name of the file to manage. - * @param fileType the file type. + * @param fileType the file type. * @throws IOException if there are any problems adding the given file to the manager */ private void add(String managedFile, int fileType) throws IOException { @@ -258,10 +258,10 @@ public final class StorageManager { } /* (non-Javadoc) - * Find the oldest generation of a file still available on disk + * Find the oldest generation of a file still available on disk * @param file the file from which to obtain the oldest generation. * @return the oldest generation of the file or 0 if the file does - * not exist. + * not exist. */ private int findOldestGeneration(String managedFile) { String[] files = base.list(); @@ -287,12 +287,12 @@ public final class StorageManager { /** * Update the given managed files with the content in the given source files. - * The managedFiles is a list of managed file names which are currently managed. - * If a managed file name is not currently managed it will be added as a + * The managedFiles is a list of managed file names which are currently managed. + * If a managed file name is not currently managed it will be added as a * managed file for this storage manager. - * The sources are absolute (or relative to the current working directory) + * The sources are absolute (or relative to the current working directory) * file paths containing the new content for the corresponding managed files. - * + * * @param managedFiles the managed files to update * @param sources the new content for the managed files * @throws IOException if there are any problems updating the given managed files @@ -329,7 +329,7 @@ public final class StorageManager { /** * Returns a list of all the managed files currently being managed. - * + * * @return the names of the managed files */ public String[] getManagedFiles() { @@ -347,7 +347,7 @@ public final class StorageManager { /** * Returns the directory containing the files being managed by this storage * manager. - * + * * @return the directory containing the managed files */ public File getBase() { @@ -356,9 +356,9 @@ public final class StorageManager { /** * Returns the current numeric id (appendage) of the given managed file. - * <code>managedFile + "." + getId(target)</code>. A value of -1 is returned + * <code>managedFile + "." + getId(target)</code>. A value of -1 is returned * if the given name is not managed. - * + * * @param managedFile the name of the managed file * @return the id of the managed file */ @@ -373,7 +373,7 @@ public final class StorageManager { /** * Returns if readOnly state this storage manager is using. - * + * * @return if this storage manager update state is read-only. */ public boolean isReadOnly() { @@ -387,7 +387,7 @@ public final class StorageManager { * Locking a manager is advisory only. That is, it does not prevent other * applications from modifying the files managed by this manager. * </p> - * + * * @exception IOException * if there was an unexpected problem while acquiring the * lock. @@ -421,15 +421,15 @@ public final class StorageManager { } /** - * Returns the actual file location to use when reading the given managed file. - * A value of <code>null</code> can be returned if the given managed file name is not - * managed and add is set to false. + * Returns the actual file location to use when reading the given managed file. + * A value of <code>null</code> can be returned if the given managed file name is not + * managed and add is set to false. * <p> * The returned file should be considered read-only. Any updates to the content of this * file should be done using {@link #update(String[], String[])}. - * + * * @param managedFile the managed file to lookup - * @param add indicate whether the managed file name should be added to the manager if + * @param add indicate whether the managed file name should be added to the manager if * it is not already managed. * @throws IOException if the add flag is set to true and the addition of the managed file failed * @return the absolute file location to use for the given managed file or @@ -471,7 +471,7 @@ public final class StorageManager { /** * Removes the given managed file from management by this storage manager. - * + * * @param managedFile the managed file to remove * @throws IOException if an error occured removing the managed file */ @@ -480,7 +480,7 @@ public final class StorageManager { throw new IOException(Msg.fileManager_notOpen); if (readOnly) throw new IOException(Msg.fileManager_illegalInReadOnlyMode); - // The removal needs to be done eagerly, so the value is effectively removed from the disktable. + // The removal needs to be done eagerly, so the value is effectively removed from the disktable. // Otherwise, an updateTable() caused by an update(,) could cause the file to readded to the local table. if (!lock(true)) throw new IOException(Msg.fileManager_cannotLock); @@ -701,7 +701,7 @@ public final class StorageManager { } /** - * This methods opens the storage manager. + * This methods opens the storage manager. * This method must be called before any operation on the storage manager. * @param wait indicates if the open operation must wait in case of contention on the lock file. * @throws IOException if an error occurred opening the storage manager @@ -748,11 +748,11 @@ public final class StorageManager { } /** - * Returns a managed <code>InputStream</code> for a managed file. - * <code>null</code> can be returned if the given name is not managed. - * + * Returns a managed <code>InputStream</code> for a managed file. + * <code>null</code> can be returned if the given name is not managed. + * * @param managedFile the name of the managed file to open. - * @return an input stream to the managed file or + * @return an input stream to the managed file or * <code>null</code> if the given name is not managed. * @throws IOException if the content is missing, corrupt or an error occurs. */ @@ -761,11 +761,11 @@ public final class StorageManager { } /** - * Returns a managed input stream set for the managed file names. + * Returns a managed input stream set for the managed file names. * Elements of the returned set may be <code>null</code> if a given name is not managed. - * This method should be used for managed file sets which use the output streams returned + * This method should be used for managed file sets which use the output streams returned * by the {@link #getOutputStreamSet(String[])} to save data. - * + * * @param managedFiles the names of the managed files to open. * @return a set input streams to the given managed files. * @throws IOException if the content of one of the managed files is missing, corrupt or an error occurs. @@ -791,10 +791,10 @@ public final class StorageManager { } /** - * Returns a <code>ManagedOutputStream</code> for a managed file. - * Closing the ouput stream will update the storage manager with the + * Returns a <code>ManagedOutputStream</code> for a managed file. + * Closing the ouput stream will update the storage manager with the * new content of the managed file. - * + * * @param managedFile the name of the managed file to write. * @return a managed output stream for the managed file. * @throws IOException if an error occurs opening the managed file. @@ -811,10 +811,10 @@ public final class StorageManager { /** * Returns an array of <code>ManagedOutputStream</code> for a set of managed files. * When all managed output streams in the set have been closed, the storage manager - * will be updated with the new content of the managed files. - * Aborting any one of the streams will cause the entire content of the set to abort + * will be updated with the new content of the managed files. + * Aborting any one of the streams will cause the entire content of the set to abort * and be discarded. - * + * * @param managedFiles list of names of the managed file to write. * @return an array of managed output streams respectively of managed files. * @throws IOException if an error occurs opening the managed files. @@ -876,10 +876,10 @@ public final class StorageManager { } /* (non-Javadoc) - * Close the managed output stream and update the new content to + * Close the managed output stream and update the new content to * this manager. If this managed output stream is part of a set, only after closing * all managed output streams in the set will storage manager be updated. - * + * * @param smos the output stream. * @throws IOException if an errors occur. * @see #getOutputStream(String) @@ -934,7 +934,7 @@ public final class StorageManager { targets[idx] = smos.getTarget(); File outputFile = smos.getOutputFile(); if (outputFile == null) { - // this is a ReliableFile + // this is a ReliableFile add(smos.getTarget(), StorageManager.FILETYPE_RELIABLEFILE); ReliableFileOutputStream rfos = (ReliableFileOutputStream) smos.getOutputStream(); File file = rfos.closeIntermediateFile(); //multiple calls to close() ok diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/ManifestElement.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/ManifestElement.java index 33a2cbf2b..439efc4f6 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/ManifestElement.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/ManifestElement.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,18 +33,18 @@ import org.osgi.framework.BundleException; /** * This class represents a single manifest element. A manifest element must consist of a single * {@link String} value. The {@link String} value may be split up into component values each - * separated by a semi-colon (';'). A manifest element may optionally have a set of + * separated by a semi-colon (';'). A manifest element may optionally have a set of * attribute and directive values associated with it. The general syntax of a manifest element is as follows: * <pre> * ManifestElement ::= component (';' component)* (';' parameter)* * component ::= ([^;,:="\#x0D#x0A#x00])+ | quoted-string * quoted-string::= '"' ( [^"\#x0D#x0A#x00] | '\"'| '\\')* '"' - * parameter ::= directive | attribute + * parameter ::= directive | attribute * directive ::= token ':=' argument * attribute ::= token '=' argument * argument ::= extended | quoted-string - * token ::= ( alphanum | '_' | '-' )+ - * extended ::= ( alphanum | '_' | '-' | '.' )+ + * token ::= ( alphanum | '_' | '-' )+ + * extended ::= ( alphanum | '_' | '-' | '.' )+ * </pre> * <p> * For example, the following is an example of a manifest element to the <code>Export-Package</code> header: @@ -53,37 +53,37 @@ import org.osgi.framework.BundleException; * org.osgi.framework; specification-version="1.2"; another-attr="examplevalue" * </pre> * <p> - * This manifest element has a value of <code>org.osgi.framework</code> and it has two attributes, - * <code>specification-version</code> and <code>another-attr</code>. + * This manifest element has a value of <code>org.osgi.framework</code> and it has two attributes, + * <code>specification-version</code> and <code>another-attr</code>. * </p> * <p> * The following manifest element is an example of a manifest element that has multiple - * components to its value: + * components to its value: * </p> * <pre> * code1.jar;code2.jar;code3.jar;attr1=value1;attr2=value2;attr3=value3 * </pre> * <p> - * This manifest element has a value of <code>code1.jar;code2.jar;code3.jar</code>. + * This manifest element has a value of <code>code1.jar;code2.jar;code3.jar</code>. * This is an example of a multiple component value. This value has three * components: <code>code1.jar</code>, <code>code2.jar</code>, and <code>code3.jar</code>. * </p> * <p> * If components contain delimiter characters (e.g ';', ',' ':' "=") then it must be - * a quoted string. For example, the following is an example of a manifest element + * a quoted string. For example, the following is an example of a manifest element * that has multiple components containing delimiter characters: * </p> * <pre> * "component ; 1"; "component , 2"; "component : 3"; attr1=value1; attr2=value2; attr3=value3 * </pre> * <p> - * This manifest element has a value of <code>"component ; 1"; "component , 2"; "component : 3"</code>. + * This manifest element has a value of <code>"component ; 1"; "component , 2"; "component : 3"</code>. * This value has three components: <code>"component ; 1"</code>, <code>"component , 2"</code>, <code>"component : 3"</code>. * </p> * <p> * This class is not intended to be subclassed by clients. * </p> - * + * * @since 3.0 * @noextend This class is not intended to be subclassed by clients. */ @@ -119,15 +119,15 @@ public class ManifestElement { /** * Returns the value of the manifest element. The value returned is the - * complete value up to the first attribute or directive. For example, the - * following manifest element: + * complete value up to the first attribute or directive. For example, the + * following manifest element: * <pre> * test1.jar;test2.jar;test3.jar;selection-filter="(os.name=Windows XP)" * </pre> * <p> * This manifest element has a value of <code>test1.jar;test2.jar;test3.jar</code> * </p> - * + * * @return the value of the manifest element. */ public String getValue() { @@ -136,18 +136,18 @@ public class ManifestElement { /** * Returns the value components of the manifest element. The value - * components returned are the complete list of value components up to - * the first attribute or directive. - * For example, the following manifest element: + * components returned are the complete list of value components up to + * the first attribute or directive. + * For example, the following manifest element: * <pre> * test1.jar;test2.jar;test3.jar;selection-filter="(os.name=Windows XP)" * </pre> * <p> - * This manifest element has the value components array + * This manifest element has the value components array * <code>{ "test1.jar", "test2.jar", "test3.jar" }</code> * Each value component is delemited by a semi-colon (<code>';'</code>). * </p> - * + * * @return the String[] of value components */ public String[] getValueComponents() { @@ -155,9 +155,9 @@ public class ManifestElement { } /** - * Returns the value for the specified attribute or <code>null</code> if it does - * not exist. If the attribute has multiple values specified then the last value - * specified is returned. For example the following manifest element: + * Returns the value for the specified attribute or <code>null</code> if it does + * not exist. If the attribute has multiple values specified then the last value + * specified is returned. For example the following manifest element: * <pre> * elementvalue; myattr="value1"; myattr="value2" * </pre> @@ -166,7 +166,7 @@ public class ManifestElement { * will be returned because it is the last value specified for the attribute * <code>myattr</code>. * </p> - * + * * @param key the attribute key to return the value for * @return the attribute value or <code>null</code> */ @@ -175,11 +175,11 @@ public class ManifestElement { } /** - * Returns an array of values for the specified attribute or + * Returns an array of values for the specified attribute or * <code>null</code> if the attribute does not exist. - * + * * @param key the attribute key to return the values for - * @return the array of attribute values or <code>null</code> + * @return the array of attribute values or <code>null</code> * @see #getAttribute(String) */ public String[] getAttributes(String key) { @@ -189,7 +189,7 @@ public class ManifestElement { /** * Returns an enumeration of attribute keys for this manifest element or * <code>null</code> if none exist. - * + * * @return the enumeration of attribute keys or null if none exist. */ public Enumeration<String> getKeys() { @@ -198,7 +198,7 @@ public class ManifestElement { /** * Add an attribute to this manifest element. - * + * * @param key the key of the attribute * @param value the value of the attribute */ @@ -207,9 +207,9 @@ public class ManifestElement { } /** - * Returns the value for the specified directive or <code>null</code> if it - * does not exist. If the directive has multiple values specified then the - * last value specified is returned. For example the following manifest element: + * Returns the value for the specified directive or <code>null</code> if it + * does not exist. If the directive has multiple values specified then the + * last value specified is returned. For example the following manifest element: * <pre> * elementvalue; mydir:="value1"; mydir:="value2" * </pre> @@ -217,7 +217,7 @@ public class ManifestElement { * specifies two values for the directive key <code>mydir</code>. In this case <code>value2</code> * will be returned because it is the last value specified for the directive <code>mydir</code>. * </p> - * + * * @param key the directive key to return the value for * @return the directive value or <code>null</code> */ @@ -226,9 +226,9 @@ public class ManifestElement { } /** - * Returns an array of string values for the specified directives or + * Returns an array of string values for the specified directives or * <code>null</code> if it does not exist. - * + * * @param key the directive key to return the values for * @return the array of directive values or <code>null</code> * @see #getDirective(String) @@ -240,7 +240,7 @@ public class ManifestElement { /** * Return an enumeration of directive keys for this manifest element or * <code>null</code> if there are none. - * + * * @return the enumeration of directive keys or <code>null</code> */ public Enumeration<String> getDirectiveKeys() { @@ -249,7 +249,7 @@ public class ManifestElement { /** * Add a directive to this manifest element. - * + * * @param key the key of the attribute * @param value the value of the attribute */ @@ -296,7 +296,7 @@ public class ManifestElement { } /* - * Return an enumeration of table keys for the specified table. + * Return an enumeration of table keys for the specified table. */ private Enumeration<String> getTableKeys(HashMap<String, Object> table) { if (table == null) @@ -335,7 +335,7 @@ public class ManifestElement { /** * Parses a manifest header value into an array of ManifestElements. Each * ManifestElement returned will have a non-null value returned by getValue(). - * + * * @param header the header name to parse. This is only specified to provide error messages * when the header value is invalid. * @param value the header value to parse. @@ -453,7 +453,7 @@ public class ManifestElement { /** * Returns the result of converting a list of comma-separated tokens into an array. - * + * * @return the array of string tokens or <code>null</code> if there are none * @param stringList the initial comma-separated string */ @@ -465,7 +465,7 @@ public class ManifestElement { /** * Returns the result of converting a list of tokens into an array. The tokens * are split using the specified separator. - * + * * @return the array of string tokens. If there are none then an empty array * is returned. * @param stringList the initial string list @@ -488,7 +488,7 @@ public class ManifestElement { /** * Parses a bundle manifest and puts the header/value pairs into the supplied Map. * Only the main section of the manifest is parsed (up to the first blank line). All - * other sections are ignored. If a header is duplicated then only the last + * other sections are ignored. If a header is duplicated then only the last * value is stored in the map. * <p> * The supplied input stream is consumed by this method and will be closed. @@ -547,7 +547,7 @@ public class ManifestElement { // This method reads all the line continuations into a single string. // Care must be taken for cases where double byte UTF characters are split // across line continuations. - // This is why BufferedReader.readLine is not used here. We must process the + // This is why BufferedReader.readLine is not used here. We must process the // CR LF chars ourselves lineLoop: while (true) { int c = input.read(); diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/NLS.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/NLS.java index 7d64991d1..a0c62b1d9 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/NLS.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/NLS.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM - Initial API and implementation *******************************************************************************/ @@ -35,7 +35,7 @@ import org.eclipse.osgi.internal.util.SupplementDebug; * <p> * The <code>#bind</code> methods perform string substitution and should be considered a * convenience and <em>not</em> a full substitute replacement for <code>MessageFormat#format</code> - * method calls. + * method calls. * </p> * <p> * Text appearing within curly braces in the given message, will be interpreted @@ -54,7 +54,7 @@ import org.eclipse.osgi.internal.util.SupplementDebug; * <p> * Clients may subclass this type. * </p> - * + * * @since 3.1 */ public abstract class NLS { @@ -93,11 +93,11 @@ public abstract class NLS { /** * Bind the given message's substitution locations with the given string value. - * + * * @param message the message to be manipulated * @param binding the object to be inserted into the message * @return the manipulated String - * @throws IllegalArgumentException if the text appearing within curly braces in the given message does not map to an integer + * @throws IllegalArgumentException if the text appearing within curly braces in the given message does not map to an integer */ public static String bind(String message, Object binding) { return internalBind(message, null, String.valueOf(binding), null); @@ -105,7 +105,7 @@ public abstract class NLS { /** * Bind the given message's substitution locations with the given string values. - * + * * @param message the message to be manipulated * @param binding1 An object to be inserted into the message * @param binding2 A second object to be inserted into the message @@ -118,7 +118,7 @@ public abstract class NLS { /** * Bind the given message's substitution locations with the given string values. - * + * * @param message the message to be manipulated * @param bindings An array of objects to be inserted into the message * @return the manipulated String @@ -131,7 +131,7 @@ public abstract class NLS { /** * Initialize the given class with the values from the message properties specified by the * base name. The base name specifies a fully qualified base name to a message properties file, - * including the package where the message properties file is located. The class loader of the + * including the package where the message properties file is located. The class loader of the * specified class will be used to load the message properties resources. * <p> * For example, if the locale is set to en_US and <code>org.eclipse.example.nls.messages</code> @@ -143,7 +143,7 @@ public abstract class NLS { * org/eclipse/example/nls/messages_en.properties * org/eclipse/example/nls/messages.properties * </pre> - * + * * @param baseName the base name of a fully qualified message properties file. * @param clazz the class where the constants will exist */ @@ -352,13 +352,13 @@ public abstract class NLS { } /* - * The method adds a log entry based on the error message and exception. + * The method adds a log entry based on the error message and exception. * The output is written to the System.err. - * + * * This method is only expected to be called if there is a problem in - * the NLS mechanism. As a result, translation facility is not available + * the NLS mechanism. As a result, translation facility is not available * here and messages coming out of this log are generally not translated. - * + * * @param severity - severity of the message (SEVERITY_ERROR or SEVERITY_WARNING) * @param message - message to log * @param e - exception to log @@ -434,7 +434,7 @@ public abstract class NLS { if ((field.getModifiers() & MOD_MASK) != MOD_EXPECTED) return null; try { - // Check to see if we are allowed to modify the field. If we aren't (for instance + // Check to see if we are allowed to modify the field. If we aren't (for instance // if the class is not public) then change the accessible attribute of the field // before trying to set the value. if (!isAccessible) |