diff options
| author | Andrey Loskutov | 2015-08-02 17:57:30 +0000 |
|---|---|---|
| committer | Andrey Loskutov | 2015-08-09 17:28:00 +0000 |
| commit | 25f14592d844a6c505615805313436f01f5d0c81 (patch) | |
| tree | a14b3f2bed0767587c800a1cf180276db2b999ed /bundles/org.eclipse.equinox.preferences/src | |
| parent | 70c1bbc97cbddfe017e595a53f53e1dcfef7fca1 (diff) | |
| download | rt.equinox.bundles-25f14592d844a6c505615805313436f01f5d0c81.tar.gz rt.equinox.bundles-25f14592d844a6c505615805313436f01f5d0c81.tar.xz rt.equinox.bundles-25f14592d844a6c505615805313436f01f5d0c81.zip | |
Code cleanup: removed trailing white space
Bug: 470699
Change-Id: I3e948abf8292da30abc894d8bef1b306c269a2d4
Signed-off-by: Andrey Loskutov <loskutov@gmx.de>
Diffstat (limited to 'bundles/org.eclipse.equinox.preferences/src')
42 files changed, 446 insertions, 445 deletions
diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/AbstractScope.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/AbstractScope.java index 29297f403..640de8a96 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/AbstractScope.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/AbstractScope.java @@ -17,7 +17,7 @@ import org.eclipse.core.runtime.preferences.IScopeContext; /** * Abstract super-class for scope context object contributed * by the Platform. - * + * * @since 3.0 */ public abstract class AbstractScope implements IScopeContext { @@ -30,7 +30,7 @@ public abstract class AbstractScope implements IScopeContext { /* * Default path hierarchy for nodes is /<scope>/<qualifier>. - * + * * @see org.eclipse.core.runtime.preferences.IScopeContext#getNode(java.lang.String) */ @Override diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/Activator.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/Activator.java index 78f4db61c..a0019a344 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/Activator.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/Activator.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -36,7 +36,7 @@ public class Activator implements BundleActivator, ServiceTrackerCustomizer { private static final String PROP_CUSTOMIZATION = "eclipse.pluginCustomization"; //$NON-NLS-1$ /** - * Track the registry service - only register preference service if the registry is + * Track the registry service - only register preference service if the registry is * available */ private ServiceTracker registryServiceTracker; diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/Base64.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/Base64.java index 1cf55d3bb..ed8d06d4b 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/Base64.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/Base64.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2005 IBM Corporation and others. + * Copyright (c) 2004, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -23,7 +23,7 @@ public class Base64 { * This method decodes the byte array in base 64 encoding into a char array * Base 64 encoding has to be according to the specification given by the * RFC 1521 (5.2). - * + * * @param data the encoded byte array * @return the decoded byte array */ @@ -107,7 +107,7 @@ public class Base64 { /** * This method converts a Base 64 digit to its numeric value. - * + * * @param data digit (character) to convert * @return value for the digit */ @@ -132,7 +132,7 @@ public class Base64 { /** * This method encodes the byte array into a char array in base 64 according * to the specification given by the RFC 1521 (5.2). - * + * * @param data the encoded char array * @return the byte array that needs to be encoded */ diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/BundleDefaultPreferences.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/BundleDefaultPreferences.java index 2da2a6ceb..a5a21217e 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/BundleDefaultPreferences.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/BundleDefaultPreferences.java @@ -1,10 +1,10 @@ /******************************************************************************* * Copyright (c) 2009, 2015 IBM Corporation and others. - * All rights reserved. This program and the accompanying materials + * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -18,11 +18,11 @@ import org.eclipse.core.runtime.preferences.*; /** * This class represents a preference node in the "bundle_defaults" scope. This scope is * used to represent default values which are set by the bundle in either its preference - * initializer or in a file included with the bundle. - * + * initializer or in a file included with the bundle. + * * This differs from the regular default scope because it does not contain values set * by the product preference customization or the command-line. - * + * * @since 3.3 */ public class BundleDefaultPreferences extends EclipsePreferences { @@ -97,7 +97,7 @@ public class BundleDefaultPreferences extends EclipsePreferences { */ @Override protected void load() { - // ensure that the same node in the "default" scope is loaded so this one is + // ensure that the same node in the "default" scope is loaded so this one is // initialized properly String relativePath = DefaultPreferences.getScopeRelativePath(absolutePath()); if (relativePath != null) { diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/DefaultPreferences.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/DefaultPreferences.java index 24df47824..8795fc62e 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/DefaultPreferences.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/DefaultPreferences.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation * Gunnar Wagenknecht - Bug 179695 - [prefs] NPE when using Preferences API without a product @@ -82,7 +82,7 @@ public class DefaultPreferences extends EclipsePreferences { /* * Apply the values set in the bundle's install directory. - * + * * In Eclipse 2.1 this is equivalent to: * /eclipse/plugins/<pluginID>/prefs.ini */ @@ -210,11 +210,11 @@ public class DefaultPreferences extends EclipsePreferences { } /* - * Runtime defaults are the ones which are specified in code at runtime. - * + * Runtime defaults are the ones which are specified in code at runtime. + * * In the Eclipse 2.1 world they were the ones which were specified in the * over-ridden Plugin#initializeDefaultPluginPreferences() method. - * + * * In Eclipse 3.0 they are set in the code which is indicated by the * extension to the plug-in default customizer extension point. */ @@ -227,7 +227,7 @@ public class DefaultPreferences extends EclipsePreferences { /* * Apply the default values as specified by the file * in the product extension. - * + * * In Eclipse 2.1 this is equivalent to the plugin_customization.ini * file in the primary feature's plug-in directory. */ @@ -334,7 +334,7 @@ public class DefaultPreferences extends EclipsePreferences { } /* - * Are we in the middle of initializing defaults from the bundle + * Are we in the middle of initializing defaults from the bundle * initializer or found in the bundle itself? Look on the load level in * case we are in a sub-node. */ @@ -348,7 +348,7 @@ public class DefaultPreferences extends EclipsePreferences { } /* - * Return a path which is relative to the scope of this node. + * Return a path which is relative to the scope of this node. * e.g. com.example.foo for /instance/com.example.foo */ protected static String getScopeRelativePath(String absolutePath) { diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/EclipsePreferences.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/EclipsePreferences.java index 2c6061cfd..96fd2c211 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/EclipsePreferences.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/EclipsePreferences.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation * Julian Chen - fix for bug #92572, jclRM @@ -24,13 +24,13 @@ import org.osgi.service.prefs.Preferences; * Represents a node in the Eclipse preference node hierarchy. This class * is used as a default implementation/super class for those nodes which * belong to scopes which are contributed by the Platform. - * + * * Implementation notes: - * + * * - For thread safety, we always synchronize on <tt>writeLock</tt> when writing * the children or properties fields. Must ensure we don't synchronize when calling * client code such as listeners. - * + * * @since 3.0 */ public class EclipsePreferences implements IEclipsePreferences, IScope { @@ -311,7 +311,7 @@ public class EclipsePreferences implements IEclipsePreferences, IScope { /* * Helper method to persist a Properties object to the filesystem. We use this - * helper so we can remove the date/timestamp that Properties#store always + * helper so we can remove the date/timestamp that Properties#store always * puts in the file. */ protected static void write(Properties properties, IPath location) throws BackingStoreException { @@ -353,7 +353,7 @@ public class EclipsePreferences implements IEclipsePreferences, IScope { return string.substring(string.indexOf(separator) + separator.length()); } - /* + /* * Helper method to convert this node to a Properties file suitable * for persistence. */ @@ -446,9 +446,9 @@ public class EclipsePreferences implements IEclipsePreferences, IScope { } /* - * Do the real flushing in a non-synchronized internal method so sub-classes + * Do the real flushing in a non-synchronized internal method so sub-classes * (mainly ProjectPreferences and ProfilePreferences) don't cause deadlocks. - * + * * If this node is not responsible for persistence (a load level), then this method * returns the node that should be flushed. Returns null if this method performed * the flush. @@ -475,7 +475,7 @@ public class EclipsePreferences implements IEclipsePreferences, IScope { // any work to do? if (!dirty) return null; - //remove dirty bit before saving, to ensure that concurrent + //remove dirty bit before saving, to ensure that concurrent //changes during save mark the store as dirty dirty = false; try { @@ -540,7 +540,7 @@ public class EclipsePreferences implements IEclipsePreferences, IScope { return null; if (value instanceof IEclipsePreferences) return (IEclipsePreferences) value; - // if we aren't supposed to create this node, then + // if we aren't supposed to create this node, then // just return null if (!create) return null; @@ -674,7 +674,7 @@ public class EclipsePreferences implements IEclipsePreferences, IScope { if (path.length() == 0) return this; - // if we have an absolute path use the root relative to + // if we have an absolute path use the root relative to // this node instead of the global root // in case we have a different hierarchy. (e.g. export) if (path.charAt(0) == IPath.SEPARATOR) @@ -735,7 +735,7 @@ public class EclipsePreferences implements IEclipsePreferences, IScope { /** * Loads the preference node. This method returns silently if the node does not exist * in the backing store (for example non-existent project). - * + * * @throws BackingStoreException if the node exists in the backing store but it * could not be loaded */ @@ -1056,12 +1056,12 @@ public class EclipsePreferences implements IEclipsePreferences, IScope { public void removeNode() throws BackingStoreException { // illegal state if this node has been removed checkRemoved(); - // clear all the property values. do it "the long way" so + // clear all the property values. do it "the long way" so // everyone gets notification String[] keys = keys(); for (int i = 0; i < keys.length; i++) remove(keys[i]); - // don't remove the global root or the scope root from the + // don't remove the global root or the scope root from the // parent but remove all its children if (parent != null && !(parent instanceof RootPreferences)) { // remove the node from the parent's collection and notify listeners @@ -1140,7 +1140,7 @@ public class EclipsePreferences implements IEclipsePreferences, IScope { /** * Saves the preference node. This method returns silently if the node does not exist * in the backing store (for example non-existent project) - * + * * @throws BackingStoreException if the node exists in the backing store but it * could not be saved */ @@ -1178,11 +1178,11 @@ public class EclipsePreferences implements IEclipsePreferences, IScope { * all preference key and value strings to the provided pool. If an added * string was already in the pool, all references will be replaced with the * canonical copy of the string. - * + * * @param pool The pool to share strings in */ public void shareStrings(StringPool pool) { - //thread safety: copy reference in case of concurrent change + //thread safety: copy reference in case of concurrent change ImmutableMap temp; synchronized (childAndPropertyLock) { temp = properties; @@ -1197,7 +1197,7 @@ public class EclipsePreferences implements IEclipsePreferences, IScope { /* * Encode the given path and key combo to a form which is suitable for * persisting or using when searching. If the key contains a slash character - * then we must use a double-slash to indicate the end of the + * then we must use a double-slash to indicate the end of the * path/the beginning of the key. */ public static String encodePath(String path, String key) { @@ -1268,7 +1268,7 @@ public class EclipsePreferences implements IEclipsePreferences, IScope { // check to see if we have an indicator which tells us where the path ends int index = fullPath.indexOf(DOUBLE_SLASH); if (index == -1) { - // we don't have a double-slash telling us where the path ends + // we don't have a double-slash telling us where the path ends // so the path is up to the last slash character int lastIndex = fullPath.lastIndexOf(IPath.SEPARATOR); if (lastIndex == -1) { diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ExportedPreferences.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ExportedPreferences.java index 0cce12fbc..4cf1db753 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ExportedPreferences.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ExportedPreferences.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -65,7 +65,7 @@ public class ExportedPreferences extends EclipsePreferences implements IExported } /* - * Return a string representation of this object. To be used for + * Return a string representation of this object. To be used for * debugging purposes only. */ @Override diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/IPreferencesConstants.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/IPreferencesConstants.java index dfd4868eb..c4cedc0e0 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/IPreferencesConstants.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/IPreferencesConstants.java @@ -1,17 +1,17 @@ /******************************************************************************* - * Copyright (c) 2005, 2006 IBM Corporation and others. + * Copyright (c) 2005, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.core.internal.preferences; /** - * Container for the constants used by this plugin. + * Container for the constants used by this plugin. * @since org.eclipse.equinox.preferences 1.0 */ public interface IPreferencesConstants { @@ -47,7 +47,7 @@ public interface IPreferencesConstants { */ public static final String PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME = PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME + ".ini"; //$NON-NLS-1$ - /** + /** * The simple identifier constant (value "<code>preferences</code>") of * the extension point of the Core Runtime plug-in where plug-ins declare * extensions to the preference facility. A plug-in may define any number diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ImmutableMap.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ImmutableMap.java index 3b460ccfb..963ac900a 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ImmutableMap.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ImmutableMap.java @@ -13,7 +13,7 @@ package org.eclipse.core.internal.preferences; /** * Hash table of {String --> String}. - * + * * This map handles collisions using linear probing. When elements are * removed, the entire table is rehashed. Thus this map has good space * characteristics, good insertion and iteration performance, but slower @@ -220,7 +220,7 @@ public abstract class ImmutableMap implements Cloneable { protected static final String[] EMPTY_STRING_ARRAY = new String[0]; /** - * Returns the value associated with this key in the map, or + * Returns the value associated with this key in the map, or * <code>null</code> if the key is not present in the map. * @param key * @return The value associated with this key, or <code>null</code> @@ -236,7 +236,7 @@ public abstract class ImmutableMap implements Cloneable { /** * Destructively adds a key/value pair to this map. The caller must ensure * there is enough room in this map to proceed. - * + * * @param key * @param value */ @@ -250,7 +250,7 @@ public abstract class ImmutableMap implements Cloneable { /** * Returns a new map that is equal to this one, except with the given * key/value pair added. - * + * * @param key * @param value * @return The map containing the given key/value pair diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/InstancePreferences.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/InstancePreferences.java index 341751fe3..485cb071c 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/InstancePreferences.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/InstancePreferences.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -159,7 +159,7 @@ public class InstancePreferences extends EclipsePreferences { } } - // Delete the old file so we don't try and load it next time. + // Delete the old file so we don't try and load it next time. if (!prefFile.delete()) //Only print out message in failure case if we are debugging. if (EclipsePreferences.DEBUG_PREFERENCE_GENERAL) diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ListenerRegistry.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ListenerRegistry.java index 73570e935..747857e20 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ListenerRegistry.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ListenerRegistry.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2004, 2005 IBM Corporation and others. + * Copyright (c) 2004, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -15,13 +15,13 @@ import org.eclipse.core.runtime.ListenerList; /** * A class which holds onto a listener list object for a given path. * Typically the path is the absolute path of a preference node. - * + * * @since 3.1 */ public class ListenerRegistry { /** - * Specialized map-like data structure for storing change listeners. + * Specialized map-like data structure for storing change listeners. */ private static class ListenerMap { private static final int GROW_SIZE = 10; @@ -97,7 +97,7 @@ public class ListenerRegistry { /** * Remove the association specified by the given key. * Do nothing if none exists. - * + * * Note: Should consider shrinking the array. Hold off for now * as we don't expect #remove to be a common code path. */ @@ -137,7 +137,7 @@ public class ListenerRegistry { } /** - * Remove the given listener from this path's collection of + * Remove the given listener from this path's collection of * listeners. If it is not associated with this path, then do nothing. */ public synchronized void remove(String path, Object listener) { diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/LookupOrder.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/LookupOrder.java index 4d879913c..f1b1719fc 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/LookupOrder.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/LookupOrder.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2005 IBM Corporation and others. + * Copyright (c) 2004, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -13,7 +13,7 @@ package org.eclipse.core.internal.preferences; /** * Object used to store the look-up order for preference * scope searching. - * + * * @since 3.0 */ public class LookupOrder { diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/OSGiPreferencesServiceImpl.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/OSGiPreferencesServiceImpl.java index 4effc2255..c8fc343f7 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/OSGiPreferencesServiceImpl.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/OSGiPreferencesServiceImpl.java @@ -4,21 +4,22 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.core.internal.preferences; import org.eclipse.core.runtime.preferences.IEclipsePreferences; -import org.osgi.service.prefs.*; +import org.osgi.service.prefs.BackingStoreException; +import org.osgi.service.prefs.Preferences; import org.osgi.service.prefs.PreferencesService; /** * <p> * Implements OSGi PreferencesService using the Eclipse preference system. * </p> - * + * * <p> * Note: Eclipse preferences are accessible through the OSGi Preferences API and vice * versa. @@ -65,8 +66,8 @@ public class OSGiPreferencesServiceImpl implements PreferencesService { } /** - * Override node(String pathName) to be more strict about forbidden names - - * EclipsePreferences implementation does a best-effort instead of throwing + * Override node(String pathName) to be more strict about forbidden names - + * EclipsePreferences implementation does a best-effort instead of throwing * {@link IllegalArgumentException}. */ @Override @@ -74,7 +75,7 @@ public class OSGiPreferencesServiceImpl implements PreferencesService { pathName = fixPath(pathName); if ((pathName.length() > 1 && pathName.endsWith("/")) //$NON-NLS-1$ - || pathName.indexOf("//") != -1) { //$NON-NLS-1$ + || pathName.indexOf("//") != -1) { //$NON-NLS-1$ throw new IllegalArgumentException(); } return new OSGiLocalRootPreferences(wrapped.node(pathName), root); @@ -84,11 +85,11 @@ public class OSGiPreferencesServiceImpl implements PreferencesService { * <p> * Override getByteArray(String key, byte [] defaultValue) to be more strict when * decoding byte values. EclipsePreferences implementation pads bytes if they are not 4 - * bytes long, but the OSGi TCK expects this function to return null if the length of - * the byte array is not an even multiple of 4. + * bytes long, but the OSGi TCK expects this function to return null if the length of + * the byte array is not an even multiple of 4. * </p> * <p> - * Also catches any decoding exceptions and returns the default value instead of + * Also catches any decoding exceptions and returns the default value instead of * propagating the exception. * </p> */ diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/OSGiPreferencesServiceManager.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/OSGiPreferencesServiceManager.java index fbf27f7fb..6bbfca02f 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/OSGiPreferencesServiceManager.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/OSGiPreferencesServiceManager.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation * Danail Nachev (ProSyst) - bug 188070 @@ -21,7 +21,7 @@ import org.osgi.service.prefs.Preferences; /** * <p> * Class used to manage OSGi Preferences Service. Creates a new OSGiPreferencesServiceImpl - * object for every bundle that gets the Preferences Service. When a bundle ungets the + * object for every bundle that gets the Preferences Service. When a bundle ungets the * Preference Service, it's preferences are flushed to disk. * </p> * <p> @@ -89,7 +89,7 @@ public class OSGiPreferencesServiceManager implements ServiceFactory, BundleList * Store preferences per bundle id */ private String getQualifier(Bundle bundle) { - String qualifier = "org.eclipse.core.runtime.preferences.OSGiPreferences." + bundle.getBundleId(); //$NON-NLS-1$ + String qualifier = "org.eclipse.core.runtime.preferences.OSGiPreferences." + bundle.getBundleId(); //$NON-NLS-1$ return qualifier; } diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PreferenceServiceRegistryHelper.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PreferenceServiceRegistryHelper.java index 8427b3f4f..65a835760 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PreferenceServiceRegistryHelper.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PreferenceServiceRegistryHelper.java @@ -1,10 +1,10 @@ /******************************************************************************* * Copyright (c) 2006, 2015 IBM Corporation and others. - * All rights reserved. This program and the accompanying materials + * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -101,7 +101,7 @@ public class PreferenceServiceRegistryHelper implements IRegistryChangeListener /* * Apply the runtime defaults for the bundle with the given name. Check - * to see if there is a preference initializer registered and if so, then run it. + * to see if there is a preference initializer registered and if so, then run it. * Otherwise call the legacy Plugin preference initialization code. */ public WeakReference applyRuntimeDefaults(String name, WeakReference pluginReference) { @@ -313,7 +313,7 @@ public class PreferenceServiceRegistryHelper implements IRegistryChangeListener } /* - * A preference scope defined by the given element was added to the extension + * A preference scope defined by the given element was added to the extension * registry. Add it to our registry and make it a child of the root. */ private void scopeAdded(IConfigurationElement element) { diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PreferencesOSGiUtils.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PreferencesOSGiUtils.java index c42d5af33..c754dbb05 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PreferencesOSGiUtils.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PreferencesOSGiUtils.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2005, 2006 IBM Corporation and others. + * Copyright (c) 2005, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -19,8 +19,8 @@ import org.osgi.util.tracker.ServiceTracker; /** * This class contains a set of helper OSGI methods for the Preferences plugin. - * The closeServices() method should be called before the plugin is stopped. - * + * The closeServices() method should be called before the plugin is stopped. + * * @since org.eclipse.equinox.preferences 3.2 */ public class PreferencesOSGiUtils { diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PreferencesService.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PreferencesService.java index 7ab8f7c6c..6f712f966 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PreferencesService.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PreferencesService.java @@ -4,10 +4,10 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation - * Semion Chichelnitsky (semion@il.ibm.com) - bug 208564 + * Semion Chichelnitsky (semion@il.ibm.com) - bug 208564 *******************************************************************************/ package org.eclipse.core.internal.preferences; @@ -133,7 +133,7 @@ public class PreferencesService implements IPreferencesService { globalNode = (IEclipsePreferences) root.node(node.absolutePath()); ExportedPreferences epNode = (ExportedPreferences) node; - // if this node is an export root then we need to remove + // if this node is an export root then we need to remove // it from the global preferences before continuing. boolean removed = false; if (epNode.isExportRoot()) { @@ -231,9 +231,9 @@ public class PreferencesService implements IPreferencesService { } /* - * Convert the given properties file from legacy format to - * one which is Eclipse 3.0 compliant. - * + * Convert the given properties file from legacy format to + * one which is Eclipse 3.0 compliant. + * * Convert the plug-in version indicator entries to export roots. */ private Properties convertFromLegacy(Properties properties) { @@ -346,11 +346,11 @@ public class PreferencesService implements IPreferencesService { /** * Copy key/value pairs from the source to the destination. If the key list is null - * then copy all associations. - * + * then copy all associations. + * * If the depth is 0, then this operation is performed only on the source node. Otherwise * it is performed on the source node's subtree. - * + * * @param depth one of 0 or -1 */ void copyFromTo(Preferences source, Preferences destination, String[] keys, int depth) throws BackingStoreException { @@ -437,7 +437,7 @@ public class PreferencesService implements IPreferencesService { } /* - * Give clients a chance to modify the tree before it is applied globally + * Give clients a chance to modify the tree before it is applied globally */ private IEclipsePreferences firePreApplyEvent(IEclipsePreferences tree) { if (registryHelper == null) @@ -847,7 +847,7 @@ public class PreferencesService implements IPreferencesService { /* * Returns a boolean value indicating whether or not the given Properties * object is the result of a preference export previous to Eclipse 3.0. - * + * * Check the contents of the file. In Eclipse 3.0 we printed out a file * version key. */ @@ -1060,9 +1060,9 @@ public class PreferencesService implements IPreferencesService { /** * Compares two plugin version identifiers to see if their preferences - * are compatible. If they are not compatible, a warning message is + * are compatible. If they are not compatible, a warning message is * added to the given multi-status, according to the following rules: - * + * * - plugins that differ in service number: no status * - plugins that differ in minor version: WARNING status * - plugins that differ in major version: diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PrefsMessages.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PrefsMessages.java index f3fc8dfac..f81e547d6 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PrefsMessages.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/PrefsMessages.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2005, 2012 IBM Corporation and others. + * Copyright (c) 2005, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -62,7 +62,7 @@ public class PrefsMessages extends NLS { } /** - * Print a debug message to the console. + * Print a debug message to the console. * Pre-pend the message with the current date and the name of the current thread. */ public static void message(String message) { diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/SafeFileInputStream.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/SafeFileInputStream.java index e7a382397..fe8a298cc 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/SafeFileInputStream.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/SafeFileInputStream.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2011 IBM Corporation and others. + * Copyright (c) 2000, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -19,7 +19,7 @@ import java.io.*; * This class handles buffering of output stream contents. * * Copied from org.eclipse.core.internal.localstore.SafeFileOutputStream - * + * * @see SafeFileOutputStream */ public class SafeFileInputStream extends FilterInputStream { diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ScopeDescriptor.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ScopeDescriptor.java index 45c511fa0..cbac9f538 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ScopeDescriptor.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/ScopeDescriptor.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/StringPool.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/StringPool.java index 5d361aa9f..e22478a08 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/StringPool.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/StringPool.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2005 IBM Corporation and others. + * Copyright (c) 2005, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM - Initial API and implementation *******************************************************************************/ @@ -20,9 +20,9 @@ import java.util.HashMap; * <p> * This class is not intended to be subclassed by clients. * </p> - * + * * Note: This class is copied from org.eclipse.core.resources - * + * * @since 3.1 */ public final class StringPool { @@ -49,16 +49,16 @@ public final class StringPool { } /** - * Returns an estimate of the size in bytes that was saved by sharing strings in + * Returns an estimate of the size in bytes that was saved by sharing strings in * the pool. In particular, this returns the size of all strings that were added to the * pool after an equal string had already been added. This value can be used - * to estimate the effectiveness of a string sharing operation, in order to + * to estimate the effectiveness of a string sharing operation, in order to * determine if or when it should be performed again. - * - * In some cases this does not precisely represent the number of bytes that - * were saved. For example, say the pool already contains string S1. Now - * string S2, which is equal to S1 but not identical, is added to the pool five - * times. This method will return the size of string S2 multiplied by the + * + * In some cases this does not precisely represent the number of bytes that + * were saved. For example, say the pool already contains string S1. Now + * string S2, which is equal to S1 but not identical, is added to the pool five + * times. This method will return the size of string S2 multiplied by the * number of times it was added, even though the actual savings in this case * is only the size of a single copy of S2. */ diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/TestHelper.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/TestHelper.java index 1dff4a444..d14e3408c 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/TestHelper.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/TestHelper.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2011, 2012 IBM Corporation and others. + * Copyright (c) 2011, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/exchange/ILegacyPreferences.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/exchange/ILegacyPreferences.java index 14679a1dd..d20d1bff2 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/exchange/ILegacyPreferences.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/exchange/ILegacyPreferences.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2005, 2007 IBM Corporation and others. + * Copyright (c) 2005, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -13,14 +13,14 @@ package org.eclipse.core.internal.preferences.exchange; /** * Provides initialization of the legacy preferences as described in * the Plugin class. - * + * * @deprecated */ public interface ILegacyPreferences { /** - * The method tries to initialize the preferences using the legacy + * The method tries to initialize the preferences using the legacy * Plugin#initializeDefaultPluginPreferences method. - * + * * @param object - plugin to initialize * @param name - ID of the plugin to be initialized */ diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/exchange/IProductPreferencesService.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/exchange/IProductPreferencesService.java index e4b20d9e9..b2d6b2268 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/exchange/IProductPreferencesService.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/internal/preferences/exchange/IProductPreferencesService.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2005, 2006 IBM Corporation and others. + * Copyright (c) 2005, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -14,24 +14,24 @@ import java.util.Properties; /** * A product can customize preferences by implementing this service. - * + * * This interface is likely going to change as the application model is introduced * in which point it might be kept for backward compatibility or removed entirely. - * + * * @since org.eclipse.equinox.common 3.2 */ public interface IProductPreferencesService { /** * Returns properties specified in the product customization file. - * - * @return default preferences specified by the product. + * + * @return default preferences specified by the product. */ public Properties getProductCustomization(); /** * Returns translations for the customized properties. - * + * * @return translation table for default preferences */ public Properties getProductTranslation(); diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/AbstractPreferenceInitializer.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/AbstractPreferenceInitializer.java index 98cd27813..67f6b6072 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/AbstractPreferenceInitializer.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/AbstractPreferenceInitializer.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2004, 2014 IBM Corporation and others. + * Copyright (c) 2004, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -13,10 +13,10 @@ package org.eclipse.core.runtime.preferences; /** * Abstract class used to aid in default preference value initialization. * Clients who extend the <code>org.eclipse.equinox.preferences.preferences</code> - * or the <code>org.eclipse.core.runtime.preferences</code> + * or the <code>org.eclipse.core.runtime.preferences</code> * extension point are able to specify a class within an <code>initializer</code> - * element. - * + * element. + * * @since 3.0 */ public abstract class AbstractPreferenceInitializer { @@ -30,7 +30,7 @@ public abstract class AbstractPreferenceInitializer { /** * This method is called by the preference initializer to initialize default - * preference values. Clients should get the correct node for their + * preference values. Clients should get the correct node for their * bundle and then set the default values on it. For example: * <pre> * public void initializeDefaultPreferences() { diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/AbstractPreferenceStorage.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/AbstractPreferenceStorage.java index 9d44265e0..607462646 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/AbstractPreferenceStorage.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/AbstractPreferenceStorage.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2011, 2012 IBM Corporation and others. + * Copyright (c) 2011, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -19,14 +19,14 @@ import org.osgi.service.prefs.BackingStoreException; * Abstract class which can be used to help provide an alternate storage mechanism * for Eclipse preferences. Clients can over-ride this class and implement the appropriate * methods to read/persist preferences. - * + * * @since 3.5 */ public abstract class AbstractPreferenceStorage { /** * Return a <code>java.util.Properties</code> object containing the preference - * key/value pairs for the preference node with the specified path, and its children. + * key/value pairs for the preference node with the specified path, and its children. * <p> * The table keys consist of an optional child node path and separator, followed by * the property key. The table values are the values of the properties. @@ -46,14 +46,14 @@ public abstract class AbstractPreferenceStorage { /** * Save the given <code>java.util.Properties</code> object which represents - * preference key/value pairs for the preference node represented by the given + * preference key/value pairs for the preference node represented by the given * path. * <p> * Clients are reminded that if the given properties object is empty then * the preference node has been removed and they should react * accordingly (e.g. for instance by removing the file on disk) * </p> - * + * * @param nodePath the absolute path of the preference node * @param properties the <code>java.util.Properties</code> object to store * @throws BackingStoreException if there was a problem saving the properties @@ -61,9 +61,9 @@ public abstract class AbstractPreferenceStorage { public abstract void save(String nodePath, Properties properties) throws BackingStoreException; /** - * Helper method to load a <code>java.util.Properties</code> file from the given + * Helper method to load a <code>java.util.Properties</code> file from the given * input stream. The stream will be closed on completion of the operation. - * + * * @param input the stream to load from * @return the <code>java.util.Properties</code> object loaded from the stream * @throws BackingStoreException if there was a problem loading the file @@ -89,7 +89,7 @@ public abstract class AbstractPreferenceStorage { /** * Helper method to save the given <code>java.util.Properties</code> object * to the given output stream. The stream will be closed at the end of the operation. - * + * * @param output the stream to store the object to * @param properties the object to store * @throws BackingStoreException if there was a problem saving the object @@ -114,9 +114,9 @@ public abstract class AbstractPreferenceStorage { /** * Return a string array containing the names of the children for the node * with the given path. If there are no children then an empty array is returned. - * One example where this method is commonly called, is at the scope root + * One example where this method is commonly called, is at the scope root * when discovering the initial children. - * + * * @param nodePath the path for the preference node * @return the array of children names * @throws BackingStoreException if there was a problem retrieving the child names @@ -126,9 +126,9 @@ public abstract class AbstractPreferenceStorage { /** * Callback to inform the client that the preference node with the specified * path has been deleted and the client should react accordingly and make - * the appropriate changes to the storage. (e.g. delete the file/information + * the appropriate changes to the storage. (e.g. delete the file/information * associated with that node) - * + * * @param nodePath the absolute path of the preference node */ public abstract void removed(String nodePath); diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/BundleDefaultsScope.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/BundleDefaultsScope.java index 251c13b77..a2a2fccc4 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/BundleDefaultsScope.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/BundleDefaultsScope.java @@ -16,7 +16,7 @@ import org.eclipse.core.runtime.IPath; /** * Object representing the bundle defaults scope in the Eclipse preferences * hierarchy. Can be used as a context for searching for preference - * values (in the IPreferencesService APIs) or for determining the + * values (in the IPreferencesService APIs) or for determining the * correct preference node to set values in the store. * <p> * The bundle defaults are the defaults are default values which have @@ -37,7 +37,7 @@ import org.eclipse.core.runtime.IPath; public final class BundleDefaultsScope extends AbstractScope { /** - * String constant (value of <code>"default"</code>) used for the + * String constant (value of <code>"default"</code>) used for the * scope name for the default preference scope. */ public static final String SCOPE = "bundle_defaults"; //$NON-NLS-1$ @@ -45,7 +45,7 @@ public final class BundleDefaultsScope extends AbstractScope { /** * Singleton instance of a Bundle Defaults Scope object. Typical usage is: * <code>BundleDefaultsScope.INSTANCE.getNode(...);</code> - * + * * @since 3.4 */ public static final IScopeContext INSTANCE = new BundleDefaultsScope(); diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/ConfigurationScope.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/ConfigurationScope.java index d9e2d511a..b170caa47 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/ConfigurationScope.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/ConfigurationScope.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -20,7 +20,7 @@ import org.eclipse.osgi.service.datalocation.Location; /** * Object representing the configuration scope in the Eclipse preferences * hierarchy. Can be used as a context for searching for preference - * values (in the IPreferencesService APIs) or for determining the + * values (in the IPreferencesService APIs) or for determining the * correct preference node to set values in the store. * <p> * Configuration preferences are stored on a per configuration basis in the @@ -42,7 +42,7 @@ import org.eclipse.osgi.service.datalocation.Location; public final class ConfigurationScope extends AbstractScope { /** - * String constant (value of <code>"configuration"</code>) used for the + * String constant (value of <code>"configuration"</code>) used for the * scope name for the configuration preference scope. */ public static final String SCOPE = "configuration"; //$NON-NLS-1$ @@ -50,7 +50,7 @@ public final class ConfigurationScope extends AbstractScope { /** * Singleton instance of a Configuration Scope object. Typical usage is: * <code>ConfigurationScope.INSTANCE.getNode(...);</code> - * + * * @since 3.4 */ public static final IScopeContext INSTANCE = new ConfigurationScope(); diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/DefaultScope.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/DefaultScope.java index 88811f6f4..cc82bedf1 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/DefaultScope.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/DefaultScope.java @@ -16,7 +16,7 @@ import org.eclipse.core.runtime.IPath; /** * Object representing the default scope in the Eclipse preferences * hierarchy. Can be used as a context for searching for preference - * values (in the IPreferencesService APIs) or for determining the + * values (in the IPreferencesService APIs) or for determining the * correct preference node to set values in the store. * <p> * Default preferences are not persisted to disk. @@ -27,11 +27,11 @@ import org.eclipse.core.runtime.IPath; * </p> * <p> * Note about product preference customization: - * Clients who define their own org.eclipse.core.runtime.IProduct + * Clients who define their own org.eclipse.core.runtime.IProduct * are able to specify a product key of "<code>preferenceCustomization</code>". * (defined as a constant in org.eclipse.ui.branding.IProductConstants) - * Its value is either a {@link java.net.URL} or a file-system path to a - * file whose contents are used to customize default preferences. + * Its value is either a {@link java.net.URL} or a file-system path to a + * file whose contents are used to customize default preferences. * </p> * <p> * This class is not intended to be subclassed. This class may be instantiated. @@ -41,7 +41,7 @@ import org.eclipse.core.runtime.IPath; public final class DefaultScope extends AbstractScope { /** - * String constant (value of <code>"default"</code>) used for the + * String constant (value of <code>"default"</code>) used for the * scope name for the default preference scope. */ public static final String SCOPE = "default"; //$NON-NLS-1$ @@ -49,7 +49,7 @@ public final class DefaultScope extends AbstractScope { /** * Singleton instance of a Default Scope object. Typical usage is: * <code>DefaultScope.INSTANCE.getNode(...);</code> - * + * * @since 3.4 */ public static final IScopeContext INSTANCE = new DefaultScope(); diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java index 12f8a59de..f5f494b70 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java @@ -21,17 +21,17 @@ import org.osgi.service.prefs.Preferences; * <p> * Clients may implement this interface. * </p> - * + * * @see org.osgi.service.prefs.Preferences * @since 3.0 */ public interface IEclipsePreferences extends Preferences { /** - * An event object which describes the details of a change in the - * preference node hierarchy. The child node is the one which + * An event object which describes the details of a change in the + * preference node hierarchy. The child node is the one which * was added or removed. - * + * * @see IEclipsePreferences.INodeChangeListener * @since 3.0 */ @@ -45,7 +45,7 @@ public interface IEclipsePreferences extends Preferences { /** * Constructor for a new node change event object. - * + * * @param parent the parent node * @param child the child node */ @@ -57,7 +57,7 @@ public interface IEclipsePreferences extends Preferences { /** * Return the parent node for this event. This is the parent * of the node which was added or removed. - * + * * @return the parent node */ public Preferences getParent() { @@ -84,7 +84,7 @@ public interface IEclipsePreferences extends Preferences { * <p> * Clients may implement this interface. * </p> - * + * * @since 3.0 */ public interface INodeChangeListener { @@ -92,7 +92,7 @@ public interface IEclipsePreferences extends Preferences { /** * Notification that a child node was added to the preference hierarchy. * The given event must not be <code>null</code>. - * + * * @param event an event specifying the details about the new node * @see IEclipsePreferences.NodeChangeEvent * @see IEclipsePreferences#addNodeChangeListener(IEclipsePreferences.INodeChangeListener) @@ -103,7 +103,7 @@ public interface IEclipsePreferences extends Preferences { /** * Notification that a child node was removed from the preference hierarchy. * The given event must not be <code>null</code>. - * + * * @param event an event specifying the details about the removed node * @see IEclipsePreferences.NodeChangeEvent * @see IEclipsePreferences#addNodeChangeListener(IEclipsePreferences.INodeChangeListener) @@ -115,7 +115,7 @@ public interface IEclipsePreferences extends Preferences { /** * An event object describing the details of a change to a preference * in the preference store. - * + * * @see IEclipsePreferences.IPreferenceChangeListener * @since 3.0 */ @@ -133,10 +133,10 @@ public interface IEclipsePreferences extends Preferences { * Constructor for a new preference change event. The node and the * key must not be <code>null</code>. The old and new preference * values must be either a <code>String</code> or <code>null</code>. - * + * * @param node the node on which the change occurred * @param key the preference key - * @param oldValue the old preference value, as a <code>String</code> + * @param oldValue the old preference value, as a <code>String</code> * or <code>null</code> * @param newValue the new preference value, as a <code>String</code> * or <code>null</code> @@ -153,7 +153,7 @@ public interface IEclipsePreferences extends Preferences { /** * Return the preference node on which the change occurred. * Must not be <code>null</code>. - * + * * @return the node */ public Preferences getNode() { @@ -163,7 +163,7 @@ public interface IEclipsePreferences extends Preferences { /** * Return the key of the preference which was changed. * Must not be <code>null</code>. - * + * * @return the preference key */ public String getKey() { @@ -171,10 +171,10 @@ public interface IEclipsePreferences extends Preferences { } /** - * Return the new value for the preference encoded as a - * <code>String</code>, or <code>null</code> if the + * Return the new value for the preference encoded as a + * <code>String</code>, or <code>null</code> if the * preference was removed. - * + * * @return the new value or <code>null</code> */ public Object getNewValue() { @@ -182,10 +182,10 @@ public interface IEclipsePreferences extends Preferences { } /** - * Return the old value for the preference encoded as a - * <code>String</code>, or <code>null</code> if the + * Return the old value for the preference encoded as a + * <code>String</code>, or <code>null</code> if the * preference was removed or if it cannot be determined. - * + * * @return the old value or <code>null</code> */ public Object getOldValue() { @@ -198,7 +198,7 @@ public interface IEclipsePreferences extends Preferences { * <p> * Clients may implement this interface. * </p> - * + * * @since 3.0 */ public interface IPreferenceChangeListener { @@ -207,7 +207,7 @@ public interface IEclipsePreferences extends Preferences { * Notification that a preference value has changed in the preference store. * The given event object describes the change details and must not * be <code>null</code>. - * + * * @param event the event details * @see IEclipsePreferences.PreferenceChangeEvent * @see IEclipsePreferences#addPreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener) @@ -220,7 +220,7 @@ public interface IEclipsePreferences extends Preferences { * Register the given listener for changes to this node. Duplicate calls * to this method with the same listener will have no effect. The given * listener argument must not be <code>null</code>. - * + * * @param listener the node change listener to add * @throws IllegalStateException if this node or an ancestor has been removed * @see #removeNodeChangeListener(IEclipsePreferences.INodeChangeListener) @@ -232,7 +232,7 @@ public interface IEclipsePreferences extends Preferences { * De-register the given listener from receiving event change notifications * for this node. Calling this method with a listener which is not registered * has no effect. The given listener argument must not be <code>null</code>. - * + * * @param listener the node change listener to remove * @throws IllegalStateException if this node or an ancestor has been removed * @see #addNodeChangeListener(IEclipsePreferences.INodeChangeListener) @@ -244,7 +244,7 @@ public interface IEclipsePreferences extends Preferences { * Register the given listener for notification of preference changes to this node. * Calling this method multiple times with the same listener has no effect. The * given listener argument must not be <code>null</code>. - * + * * @param listener the preference change listener to register * @throws IllegalStateException if this node or an ancestor has been removed * @see #removePreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener) @@ -256,7 +256,7 @@ public interface IEclipsePreferences extends Preferences { * De-register the given listener from receiving notification of preference changes * to this node. Calling this method multiple times with the same listener has no * effect. The given listener argument must not be <code>null</code>. - * + * * @param listener the preference change listener to remove * @throws IllegalStateException if this node or an ancestor has been removed * @see #addPreferenceChangeListener(IEclipsePreferences.IPreferenceChangeListener) @@ -268,15 +268,15 @@ public interface IEclipsePreferences extends Preferences { * Remove this node from the preference hierarchy. If this node is the scope * root, then do not remove this node, only remove this node's children. * <p> - * Functionally equivalent to calling {@link Preferences#removeNode()}. - * See the spec of {@link Preferences#removeNode()} for more details. + * Functionally equivalent to calling {@link Preferences#removeNode()}. + * See the spec of {@link Preferences#removeNode()} for more details. * </p> * <p> * Implementors must send the appropriate {@link NodeChangeEvent} * to listeners who are registered on this node's parent. * </p> * <p> - * When this node is removed, its associated preference and node change + * When this node is removed, its associated preference and node change * listeners should be removed as well. * </p> * @throws BackingStoreException if there was a problem removing this node @@ -290,7 +290,7 @@ public interface IEclipsePreferences extends Preferences { * Return the preferences node with the given path. The given path must * not be <code>null</code>. * <p> - * See the spec of {@link Preferences#node(String)} for more details. + * See the spec of {@link Preferences#node(String)} for more details. * </p> * <p> * Note that if the node does not yet exist and is created, then the appropriate @@ -306,8 +306,8 @@ public interface IEclipsePreferences extends Preferences { public Preferences node(String path); /** - * Accepts the given visitor. The visitor's <code>visit</code> method - * is called with this node. If the visitor returns <code>true</code>, + * Accepts the given visitor. The visitor's <code>visit</code> method + * is called with this node. If the visitor returns <code>true</code>, * this method visits this node's children. * * @param visitor the visitor diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IExportedPreferences.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IExportedPreferences.java index 3abb5103b..9a164b71f 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IExportedPreferences.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IExportedPreferences.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2008 IBM Corporation and others. + * Copyright (c) 2004, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -27,7 +27,7 @@ public interface IExportedPreferences extends IEclipsePreferences { * when the preferences were exported, and <code>false</code> * otherwise. This information is used during the import to clear * nodes when importing a node's (and its children's) preferences. - * + * * @return <code>true</code> if this node is an export root * and <code>false</code> otherwise */ diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceFilter.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceFilter.java index ff44b1c31..6ca8fc5a9 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceFilter.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceFilter.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2005 IBM Corporation and others. + * Copyright (c) 2005, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -24,7 +24,7 @@ import java.util.Map; * <p> * Clients may implement this interface. * </p> - * + * * @since 3.1 */ public interface IPreferenceFilter { @@ -33,26 +33,26 @@ public interface IPreferenceFilter { * Return an array of scopes that this preference filter is applicable for. The list * of scopes must not be <code>null</code>. * <p> - * For example: + * For example: * <code>new String[] {InstanceScope.SCOPE, ConfigurationScope.SCOPE};</code> * </p> - * + * * @return the array of scopes */ public String[] getScopes(); /** * Return a mapping which defines the nodes and keys that this filter - * applies to. + * applies to. * <p> * If the map is <code>null</code> then this filter is applicable for all - * nodes within the scope. The map can also be <code>null</code> if + * nodes within the scope. The map can also be <code>null</code> if * the given scope is not known to this filter. * </p> * <p> - * The keys in the table are Strings and describe the node path. The values are - * an optional array of {@link PreferenceFilterEntry} objects describing the list of - * applicable keys in that node. If the value is null then the whole node is + * The keys in the table are Strings and describe the node path. The values are + * an optional array of {@link PreferenceFilterEntry} objects describing the list of + * applicable keys in that node. If the value is null then the whole node is * considered applicable. * </p> * <p> @@ -64,11 +64,11 @@ public interface IPreferenceFilter { * <pre> * "org.eclipse.core.resources" -> null * "org.eclipse.ui" -> new PreferenceFilterEntry[] { - * new PreferenceFilterEntry("DEFAULT_PERSPECTIVE_LOCATION"), + * new PreferenceFilterEntry("DEFAULT_PERSPECTIVE_LOCATION"), * new PreferenceFilterEntry("SHOW_INTRO_ON_STARTUP")} * </pre> * </p> - * + * * @return the mapping table * @see PreferenceFilterEntry */ diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceNodeVisitor.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceNodeVisitor.java index 28733cc67..ac112af81 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceNodeVisitor.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceNodeVisitor.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2005 IBM Corporation and others. + * Copyright (c) 2004, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -12,9 +12,9 @@ package org.eclipse.core.runtime.preferences; import org.osgi.service.prefs.BackingStoreException; -/** +/** * This interface is implemented by objects that visit preference nodes. - * <p> + * <p> * Usage: * <pre> * class Visitor implements IPreferenceNodeVisitor { @@ -35,7 +35,7 @@ import org.osgi.service.prefs.BackingStoreException; */ public interface IPreferenceNodeVisitor { - /** + /** * Visits the given preference node. * * @param node the node to visit diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferencesService.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferencesService.java index 55e17afcd..96b610119 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferencesService.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferencesService.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2004, 2010 IBM Corporation and others. + * Copyright (c) 2004, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -45,25 +45,25 @@ public interface IPreferencesService { * @param key the preference key * @param defaultValue the default value * @param nodes the list of nodes to search, or <code>null</code> - * @return the stored preference value or the specified default value + * @return the stored preference value or the specified default value * @see org.osgi.service.prefs.Preferences */ public String get(String key, String defaultValue, Preferences[] nodes); /** - * Return the value stored in the preference store for the given key. - * If the key is not defined then return the specified default value. - * Use the canonical scope lookup order for finding the preference value. + * Return the value stored in the preference store for the given key. + * If the key is not defined then return the specified default value. + * Use the canonical scope lookup order for finding the preference value. * <p> - * The semantics of this method are to calculate the appropriate + * The semantics of this method are to calculate the appropriate * {@link Preferences} nodes in the preference hierarchy to use - * and then call the {@link #get(String, String, Preferences[])} - * method. The order of the nodes is calculated by consulting the default + * and then call the {@link #get(String, String, Preferences[])} + * method. The order of the nodes is calculated by consulting the default * scope lookup order as set by {@link #setDefaultLookupOrder(String, String, String[])}. * </p><p> - * The specified key may either refer to a simple key or be the concatenation of the - * path of a child node and key. If the key contains a slash ("/") character, then a - * double-slash must be used to denote the end of they child path and the beginning + * The specified key may either refer to a simple key or be the concatenation of the + * path of a child node and key. If the key contains a slash ("/") character, then a + * double-slash must be used to denote the end of they child path and the beginning * of the key. Otherwise it is assumed that the key is the last segment of the path. * The following are some examples of keys and their meanings: * <ul> @@ -79,16 +79,16 @@ public interface IPreferencesService { * <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d" * </ul> * </p><p> - * The scope look-up order is determined by the preference service default + * The scope look-up order is determined by the preference service default * lookup order, not by the order of the scope contexts that are being passed in. - * The context objects are only consulted to help determine which nodes to + * The context objects are only consulted to help determine which nodes to * look in, not the order of the nodes. * </p><p> - * Callers may specify an array of scope context objects to aid in the - * determination of the correct nodes. For each entry in the lookup - * order, the array of contexts is consulted and if one matching the + * Callers may specify an array of scope context objects to aid in the + * determination of the correct nodes. For each entry in the lookup + * order, the array of contexts is consulted and if one matching the * scope exists, then it is used to calculate the node. Otherwise a - * default calculation algorithm is used. + * default calculation algorithm is used. * </p><p> * An example of a qualifier for an Eclipse 2.1 preference is the * plug-in identifier. (e.g. "org.eclipse.core.resources" for "description.autobuild") @@ -106,19 +106,19 @@ public interface IPreferencesService { public boolean getBoolean(String qualifier, String key, boolean defaultValue, IScopeContext[] contexts); /** - * Return the value stored in the preference store for the given key. - * If the key is not defined then return the specified default value. - * Use the canonical scope lookup order for finding the preference value. + * Return the value stored in the preference store for the given key. + * If the key is not defined then return the specified default value. + * Use the canonical scope lookup order for finding the preference value. * <p> - * The semantics of this method are to calculate the appropriate + * The semantics of this method are to calculate the appropriate * {@link Preferences} nodes in the preference hierarchy to use - * and then call the {@link #get(String, String, Preferences[])} - * method. The order of the nodes is calculated by consulting the default + * and then call the {@link #get(String, String, Preferences[])} + * method. The order of the nodes is calculated by consulting the default * scope lookup order as set by {@link #setDefaultLookupOrder(String, String, String[])}. * </p><p> - * The specified key may either refer to a simple key or be the concatenation of the - * path of a child node and key. If the key contains a slash ("/") character, then a - * double-slash must be used to denote the end of they child path and the beginning + * The specified key may either refer to a simple key or be the concatenation of the + * path of a child node and key. If the key contains a slash ("/") character, then a + * double-slash must be used to denote the end of they child path and the beginning * of the key. Otherwise it is assumed that the key is the last segment of the path. * The following are some examples of keys and their meanings: * <ul> @@ -134,16 +134,16 @@ public interface IPreferencesService { * <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d" * </ul> * </p><p> - * The scope look-up order is determined by the preference service default + * The scope look-up order is determined by the preference service default * lookup order, not by the order of the scope contexts that are being passed in. - * The context objects are only consulted to help determine which nodes to + * The context objects are only consulted to help determine which nodes to * look in, not the order of the nodes. * </p><p> - * Callers may specify an array of scope context objects to aid in the - * determination of the correct nodes. For each entry in the lookup - * order, the array of contexts is consulted and if one matching the + * Callers may specify an array of scope context objects to aid in the + * determination of the correct nodes. For each entry in the lookup + * order, the array of contexts is consulted and if one matching the * scope exists, then it is used to calculate the node. Otherwise a - * default calculation algorithm is used. + * default calculation algorithm is used. * </p><p> * An example of a qualifier for an Eclipse 2.1 preference is the * plug-in identifier. (e.g. "org.eclipse.core.resources" for "description.autobuild") @@ -161,19 +161,19 @@ public interface IPreferencesService { public byte[] getByteArray(String qualifier, String key, byte[] defaultValue, IScopeContext[] contexts); /** - * Return the value stored in the preference store for the given key. - * If the key is not defined then return the specified default value. - * Use the canonical scope lookup order for finding the preference value. + * Return the value stored in the preference store for the given key. + * If the key is not defined then return the specified default value. + * Use the canonical scope lookup order for finding the preference value. * <p> - * The semantics of this method are to calculate the appropriate + * The semantics of this method are to calculate the appropriate * {@link Preferences} nodes in the preference hierarchy to use - * and then call the {@link #get(String, String, Preferences[])} - * method. The order of the nodes is calculated by consulting the default + * and then call the {@link #get(String, String, Preferences[])} + * method. The order of the nodes is calculated by consulting the default * scope lookup order as set by {@link #setDefaultLookupOrder(String, String, String[])}. * </p><p> - * The specified key may either refer to a simple key or be the concatenation of the - * path of a child node and key. If the key contains a slash ("/") character, then a - * double-slash must be used to denote the end of they child path and the beginning + * The specified key may either refer to a simple key or be the concatenation of the + * path of a child node and key. If the key contains a slash ("/") character, then a + * double-slash must be used to denote the end of they child path and the beginning * of the key. Otherwise it is assumed that the key is the last segment of the path. * The following are some examples of keys and their meanings: * <ul> @@ -189,16 +189,16 @@ public interface IPreferencesService { * <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d" * </ul> * </p><p> - * The scope look-up order is determined by the preference service default + * The scope look-up order is determined by the preference service default * lookup order, not by the order of the scope contexts that are being passed in. - * The context objects are only consulted to help determine which nodes to + * The context objects are only consulted to help determine which nodes to * look in, not the order of the nodes. * </p><p> - * Callers may specify an array of scope context objects to aid in the - * determination of the correct nodes. For each entry in the lookup - * order, the array of contexts is consulted and if one matching the + * Callers may specify an array of scope context objects to aid in the + * determination of the correct nodes. For each entry in the lookup + * order, the array of contexts is consulted and if one matching the * scope exists, then it is used to calculate the node. Otherwise a - * default calculation algorithm is used. + * default calculation algorithm is used. * </p><p> * An example of a qualifier for an Eclipse 2.1 preference is the * plug-in identifier. (e.g. "org.eclipse.core.resources" for "description.autobuild") @@ -216,19 +216,19 @@ public interface IPreferencesService { public double getDouble(String qualifier, String key, double defaultValue, IScopeContext[] contexts); /** - * Return the value stored in the preference store for the given key. - * If the key is not defined then return the specified default value. - * Use the canonical scope lookup order for finding the preference value. + * Return the value stored in the preference store for the given key. + * If the key is not defined then return the specified default value. + * Use the canonical scope lookup order for finding the preference value. * <p> - * The semantics of this method are to calculate the appropriate + * The semantics of this method are to calculate the appropriate * {@link Preferences} nodes in the preference hierarchy to use - * and then call the {@link #get(String, String, Preferences[])} - * method. The order of the nodes is calculated by consulting the default + * and then call the {@link #get(String, String, Preferences[])} + * method. The order of the nodes is calculated by consulting the default * scope lookup order as set by {@link #setDefaultLookupOrder(String, String, String[])}. * </p><p> - * The specified key may either refer to a simple key or be the concatenation of the - * path of a child node and key. If the key contains a slash ("/") character, then a - * double-slash must be used to denote the end of they child path and the beginning + * The specified key may either refer to a simple key or be the concatenation of the + * path of a child node and key. If the key contains a slash ("/") character, then a + * double-slash must be used to denote the end of they child path and the beginning * of the key. Otherwise it is assumed that the key is the last segment of the path. * The following are some examples of keys and their meanings: * <ul> @@ -244,16 +244,16 @@ public interface IPreferencesService { * <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d" * </ul> * </p><p> - * The scope look-up order is determined by the preference service default + * The scope look-up order is determined by the preference service default * lookup order, not by the order of the scope contexts that are being passed in. - * The context objects are only consulted to help determine which nodes to + * The context objects are only consulted to help determine which nodes to * look in, not the order of the nodes. * </p><p> - * Callers may specify an array of scope context objects to aid in the - * determination of the correct nodes. For each entry in the lookup - * order, the array of contexts is consulted and if one matching the + * Callers may specify an array of scope context objects to aid in the + * determination of the correct nodes. For each entry in the lookup + * order, the array of contexts is consulted and if one matching the * scope exists, then it is used to calculate the node. Otherwise a - * default calculation algorithm is used. + * default calculation algorithm is used. * </p><p> * An example of a qualifier for an Eclipse 2.1 preference is the * plug-in identifier. (e.g. "org.eclipse.core.resources" for "description.autobuild") @@ -271,19 +271,19 @@ public interface IPreferencesService { public float getFloat(String qualifier, String key, float defaultValue, IScopeContext[] contexts); /** - * Return the value stored in the preference store for the given key. - * If the key is not defined then return the specified default value. - * Use the canonical scope lookup order for finding the preference value. + * Return the value stored in the preference store for the given key. + * If the key is not defined then return the specified default value. + * Use the canonical scope lookup order for finding the preference value. * <p> - * The semantics of this method are to calculate the appropriate + * The semantics of this method are to calculate the appropriate * {@link Preferences} nodes in the preference hierarchy to use - * and then call the {@link #get(String, String, Preferences[])} - * method. The order of the nodes is calculated by consulting the default + * and then call the {@link #get(String, String, Preferences[])} + * method. The order of the nodes is calculated by consulting the default * scope lookup order as set by {@link #setDefaultLookupOrder(String, String, String[])}. * </p><p> - * The specified key may either refer to a simple key or be the concatenation of the - * path of a child node and key. If the key contains a slash ("/") character, then a - * double-slash must be used to denote the end of they child path and the beginning + * The specified key may either refer to a simple key or be the concatenation of the + * path of a child node and key. If the key contains a slash ("/") character, then a + * double-slash must be used to denote the end of they child path and the beginning * of the key. Otherwise it is assumed that the key is the last segment of the path. * The following are some examples of keys and their meanings: * <ul> @@ -299,16 +299,16 @@ public interface IPreferencesService { * <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d" * </ul> * </p><p> - * The scope look-up order is determined by the preference service default + * The scope look-up order is determined by the preference service default * lookup order, not by the order of the scope contexts that are being passed in. - * The context objects are only consulted to help determine which nodes to + * The context objects are only consulted to help determine which nodes to * look in, not the order of the nodes. * </p><p> - * Callers may specify an array of scope context objects to aid in the - * determination of the correct nodes. For each entry in the lookup - * order, the array of contexts is consulted and if one matching the + * Callers may specify an array of scope context objects to aid in the + * determination of the correct nodes. For each entry in the lookup + * order, the array of contexts is consulted and if one matching the * scope exists, then it is used to calculate the node. Otherwise a - * default calculation algorithm is used. + * default calculation algorithm is used. * </p><p> * An example of a qualifier for an Eclipse 2.1 preference is the * plug-in identifier. (e.g. "org.eclipse.core.resources" for "description.autobuild") @@ -326,19 +326,19 @@ public interface IPreferencesService { public int getInt(String qualifier, String key, int defaultValue, IScopeContext[] contexts); /** - * Return the value stored in the preference store for the given key. - * If the key is not defined then return the specified default value. - * Use the canonical scope lookup order for finding the preference value. + * Return the value stored in the preference store for the given key. + * If the key is not defined then return the specified default value. + * Use the canonical scope lookup order for finding the preference value. * <p> - * The semantics of this method are to calculate the appropriate + * The semantics of this method are to calculate the appropriate * {@link Preferences} nodes in the preference hierarchy to use - * and then call the {@link #get(String, String, Preferences[])} - * method. The order of the nodes is calculated by consulting the default + * and then call the {@link #get(String, String, Preferences[])} + * method. The order of the nodes is calculated by consulting the default * scope lookup order as set by {@link #setDefaultLookupOrder(String, String, String[])}. * </p><p> - * The specified key may either refer to a simple key or be the concatenation of the - * path of a child node and key. If the key contains a slash ("/") character, then a - * double-slash must be used to denote the end of they child path and the beginning + * The specified key may either refer to a simple key or be the concatenation of the + * path of a child node and key. If the key contains a slash ("/") character, then a + * double-slash must be used to denote the end of they child path and the beginning * of the key. Otherwise it is assumed that the key is the last segment of the path. * The following are some examples of keys and their meanings: * <ul> @@ -354,16 +354,16 @@ public interface IPreferencesService { * <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d" * </ul> * </p><p> - * The scope look-up order is determined by the preference service default + * The scope look-up order is determined by the preference service default * lookup order, not by the order of the scope contexts that are being passed in. - * The context objects are only consulted to help determine which nodes to + * The context objects are only consulted to help determine which nodes to * look in, not the order of the nodes. * </p><p> - * Callers may specify an array of scope context objects to aid in the - * determination of the correct nodes. For each entry in the lookup - * order, the array of contexts is consulted and if one matching the + * Callers may specify an array of scope context objects to aid in the + * determination of the correct nodes. For each entry in the lookup + * order, the array of contexts is consulted and if one matching the * scope exists, then it is used to calculate the node. Otherwise a - * default calculation algorithm is used. + * default calculation algorithm is used. * </p><p> * An example of a qualifier for an Eclipse 2.1 preference is the * plug-in identifier. (e.g. "org.eclipse.core.resources" for "description.autobuild") @@ -381,19 +381,19 @@ public interface IPreferencesService { public long getLong(String qualifier, String key, long defaultValue, IScopeContext[] contexts); /** - * Return the value stored in the preference store for the given key. - * If the key is not defined then return the specified default value. - * Use the canonical scope lookup order for finding the preference value. + * Return the value stored in the preference store for the given key. + * If the key is not defined then return the specified default value. + * Use the canonical scope lookup order for finding the preference value. * <p> - * The semantics of this method are to calculate the appropriate + * The semantics of this method are to calculate the appropriate * {@link Preferences} nodes in the preference hierarchy to use - * and then call the {@link #get(String, String, Preferences[])} - * method. The order of the nodes is calculated by consulting the default + * and then call the {@link #get(String, String, Preferences[])} + * method. The order of the nodes is calculated by consulting the default * scope lookup order as set by {@link #setDefaultLookupOrder(String, String, String[])}. * </p><p> - * The specified key may either refer to a simple key or be the concatenation of the - * path of a child node and key. If the key contains a slash ("/") character, then a - * double-slash must be used to denote the end of they child path and the beginning + * The specified key may either refer to a simple key or be the concatenation of the + * path of a child node and key. If the key contains a slash ("/") character, then a + * double-slash must be used to denote the end of they child path and the beginning * of the key. Otherwise it is assumed that the key is the last segment of the path. * The following are some examples of keys and their meanings: * <ul> @@ -409,16 +409,16 @@ public interface IPreferencesService { * <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d" * </ul> * </p><p> - * The scope look-up order is determined by the preference service default + * The scope look-up order is determined by the preference service default * lookup order, not by the order of the scope contexts that are being passed in. - * The context objects are only consulted to help determine which nodes to + * The context objects are only consulted to help determine which nodes to * look in, not the order of the nodes. * </p><p> - * Callers may specify an array of scope context objects to aid in the - * determination of the correct nodes. For each entry in the lookup - * order, the array of contexts is consulted and if one matching the + * Callers may specify an array of scope context objects to aid in the + * determination of the correct nodes. For each entry in the lookup + * order, the array of contexts is consulted and if one matching the * scope exists, then it is used to calculate the node. Otherwise a - * default calculation algorithm is used. + * default calculation algorithm is used. * </p><p> * An example of a qualifier for an Eclipse 2.1 preference is the * plug-in identifier. (e.g. "org.eclipse.core.resources" for "description.autobuild") @@ -437,7 +437,7 @@ public interface IPreferencesService { /** * Return the root node of the Eclipse preference hierarchy. - * + * * @return the root of the hierarchy */ public IEclipsePreferences getRootNode(); @@ -449,7 +449,7 @@ public interface IPreferencesService { * If the given export list is <code>null</code> then all preferences for all sub-nodes * of the given node are exported to the given stream. Otherwise the export list is * consulted before exporting each preference value. If there is a string match then - * the preference is not exported. The exclusion can also occur at a per-node level. + * the preference is not exported. The exclusion can also occur at a per-node level. * Wild cards are <em>not</em> accepted in the excludes list as a basic String compare * is done. The basic algorithm is similar to the following: * <pre> @@ -478,8 +478,8 @@ public interface IPreferencesService { * Existing values are over-ridden by those from the stream. The stream must not be * <code>null</code> and is closed upon return from this method. * <p> - * This file must have been written by the - * {@link #exportPreferences(IEclipsePreferences, OutputStream, String[])} + * This file must have been written by the + * {@link #exportPreferences(IEclipsePreferences, OutputStream, String[])} * method. * </p> * <p> @@ -495,11 +495,11 @@ public interface IPreferencesService { /** * Take the given preference tree and apply it to the Eclipse - * global preference hierarchy. If a node is an export root, then - * treat the operation for that node as an overwrite rather than a merge. + * global preference hierarchy. If a node is an export root, then + * treat the operation for that node as an overwrite rather than a merge. * That is, remove the node from the global tree before adding any preferences - * contained in it or its children. - * <p> + * contained in it or its children. + * <p> * The given preferences object must not be <code>null</code>. * </p> * <p> @@ -507,7 +507,7 @@ public interface IPreferencesService { * the registered <code>PreferenceModifyListener</code> objects * are called and given the opportunity to modify the tree. * </p> - * + * * @param preferences the preferences to apply globally * @return status object indicating success or failure * @throws IllegalArgumentException if the preferences are <code>null</code> @@ -554,16 +554,16 @@ public interface IPreferencesService { /** * Return an array with the lookup order for the preference keyed by the given - * qualifier and simple name. + * qualifier and simple name. * <p> * First do an exact match lookup with the given qualifier and simple name. If a match * is found then return it. Otherwise if the key is non-<code>null</code> then - * do a lookup based on only the qualifier and return the set value. + * do a lookup based on only the qualifier and return the set value. * Return the default-default order as defined by the platform if no order has been set. * </p> * @param qualifier the namespace qualifier for the preference * @param key the preference name or <code>null</code> - * @return the scope order + * @return the scope order * @throws IllegalArgumentException if the qualifier is <code>null</code> * @see #getDefaultLookupOrder(String, String) * @see #setDefaultLookupOrder(String, String, String[]) @@ -578,7 +578,7 @@ public interface IPreferencesService { * If the given simple name is <code>null</code> then set the given lookup * order to be used for all keys with the given qualifier. * </p><p> - * Note that the default lookup order is not persisted across platform invocations. + * Note that the default lookup order is not persisted across platform invocations. * </p> * @param qualifier the namespace qualifier for the preference * @param key the preference name or <code>null</code> @@ -586,7 +586,7 @@ public interface IPreferencesService { * @throws IllegalArgumentException * <ul> * <li>if the qualifier is <code>null</code></li> - * <li>if an entry in the order array is <code>null</code> (the array itself is + * <li>if an entry in the order array is <code>null</code> (the array itself is * allowed to be <code>null</code></li> * </ul> * @see #getDefaultLookupOrder(String, String) @@ -604,7 +604,7 @@ public interface IPreferencesService { * <p> * It is the responsibility of the client to close the given output stream. * </p> - * + * * @param node the tree to export * @param filters the list of filters to export * @param output the stream to export to @@ -620,9 +620,9 @@ public interface IPreferencesService { /** * Return a list of filters which match the given tree and is a subset of the given - * filter list. If the specified list of filters is <code>null</code>, empty, or there + * filter list. If the specified list of filters is <code>null</code>, empty, or there * are no matches, then return an empty list. - * + * * @param node the tree to match against * @param filters the list of filters to match against * @return the array of matching transfers @@ -644,7 +644,7 @@ public interface IPreferencesService { * the registered <code>PreferenceModifyListener</code> objects * are called and given the opportunity to modify the tree. * </p> - * + * * @param node the tree to consider applying * @param filters the filters to use * @throws CoreException diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IScope.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IScope.java index 07a56d665..ced8931d8 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IScope.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IScope.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2005 IBM Corporation and others. + * Copyright (c) 2004, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -11,7 +11,7 @@ package org.eclipse.core.runtime.preferences; /** - * Clients contributing a scope to the Eclipse preference system must + * Clients contributing a scope to the Eclipse preference system must * implement this interface to aid Eclipse in creating a new node for the * hierarchy. * <p> @@ -29,7 +29,7 @@ public interface IScope { * <p> * Implementors should note that the node might not have been added to the * child list of the parent yet, and therefore might not be able to be referenced - * through navigation from the root node. + * through navigation from the root node. * </p> * @param parent the node's parent * @param name the name of the node diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IScopeContext.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IScopeContext.java index 9e9021ba0..740119f43 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IScopeContext.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IScopeContext.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2005 IBM Corporation and others. + * Copyright (c) 2004, 2015 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -13,23 +13,23 @@ package org.eclipse.core.runtime.preferences; import org.eclipse.core.runtime.IPath; /** - * Clients implement this interface to provide context to a - * particular scope. Instances of implementations of this interface are - * passed to the {@link IPreferencesService} for use in + * Clients implement this interface to provide context to a + * particular scope. Instances of implementations of this interface are + * passed to the {@link IPreferencesService} for use in * preference searching. * <p> * Clients may implement this interface. * </p> - * + * * @see IPreferencesService * @since 3.0 */ public interface IScopeContext { /** - * Return the name of the scope that this context is associated with. + * Return the name of the scope that this context is associated with. * Must not be <code>null</code>. - * + * * @return the name of the scope */ public String getName(); @@ -37,15 +37,15 @@ public interface IScopeContext { /** * Return the preferences node that contains the preferences for the * given qualifier or <code>null</code> if the node cannot be determined. - * The given qualifier must not be <code>null</code> but may be a path + * The given qualifier must not be <code>null</code> but may be a path * to a sub-node within the scope. * <p> - * An example of a qualifier in Eclipse 2.1 would be the plug-in identifier that - * the preference is associated with (e.g. the "org.eclipse.core.resources" + * An example of a qualifier in Eclipse 2.1 would be the plug-in identifier that + * the preference is associated with (e.g. the "org.eclipse.core.resources" * plug-in defines the "description.autobuild" preference). * </p><p> * This method can be used to determine the appropriate preferences node - * to aid in setting key/value pairs. For instance: + * to aid in setting key/value pairs. For instance: * <code>new InstanceScope().getNode("org.eclipse.core.resources");</code> * returns the preference node in the instance scope where the preferences * for "org.eclipse.core.resources" are stored. diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/InstanceScope.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/InstanceScope.java index e181e6987..f085b72dd 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/InstanceScope.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/InstanceScope.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -17,7 +17,7 @@ import org.eclipse.osgi.service.datalocation.Location; /** * Object representing the instance scope in the Eclipse preferences * hierarchy. Can be used as a context for searching for preference - * values (in the IPreferencesService APIs) or for determining the + * values (in the IPreferencesService APIs) or for determining the * correct preference node to set values in the store. * <p> * Instance preferences are stored on a per instance basis in the @@ -36,7 +36,7 @@ import org.eclipse.osgi.service.datalocation.Location; public final class InstanceScope extends AbstractScope { /** - * String constant (value of <code>"instance"</code>) used for the + * String constant (value of <code>"instance"</code>) used for the * scope name for the instance preference scope. */ public static final String SCOPE = "instance"; //$NON-NLS-1$ @@ -44,7 +44,7 @@ public final class InstanceScope extends AbstractScope { /** * Singleton instance of an Instance Scope object. Typical usage is: * <code>InstanceScope.INSTANCE.getNode(...);</code> - * + * * @since 3.4 */ public static final IScopeContext INSTANCE = new InstanceScope(); diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/PreferenceFilterEntry.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/PreferenceFilterEntry.java index 169b87b7e..1d731416b 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/PreferenceFilterEntry.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/PreferenceFilterEntry.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2005, 2010 IBM Corporation and others. - * All rights reserved. This program and the accompanying materials + * Copyright (c) 2005, 2015 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation * Semion Chichelnitsky (semion@il.ibm.com) - bug 208564 @@ -14,7 +14,7 @@ package org.eclipse.core.runtime.preferences; /** * Class which represents and preference filter entry to be used during preference * import/export (for example). - * + * * @since 3.1 * @see org.eclipse.core.runtime.preferences.IPreferenceFilter */ @@ -24,9 +24,9 @@ public final class PreferenceFilterEntry { private String matchType; /** - * Constructor for the class. Create a new preference filter entry with the given - * key. The key must <em>not</em> be <code>null</code> or empty. - * + * Constructor for the class. Create a new preference filter entry with the given + * key. The key must <em>not</em> be <code>null</code> or empty. + * * @param key the name of the preference key */ public PreferenceFilterEntry(String key) { @@ -37,17 +37,17 @@ public final class PreferenceFilterEntry { } /** - * Constructor for the class. Create a new preference filter entry with the given + * Constructor for the class. Create a new preference filter entry with the given * key and match type. The key must <em>not</em> be <code>null</code> or empty. * <p> * Setting matchType to "prefix" treats the key as if it were a regular expression - * with an asterisk at the end. If matchType is <code>null</code>, the key must be + * with an asterisk at the end. If matchType is <code>null</code>, the key must be * an exact match. - * </p> + * </p> * @param key the name of the preference key * @param matchType specifies key match type, may be <code>null</null> to indicate - * that exact match is required - * @since 3.3 + * that exact match is required + * @since 3.3 */ public PreferenceFilterEntry(String key, String matchType) { this(key); @@ -58,7 +58,7 @@ public final class PreferenceFilterEntry { * Return the name of the preference key for this filter entry. * It will <em>not</em> return <code>null</code> or the * empty string. - * + * * @return the name of the preference key */ public String getKey() { diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/PreferenceModifyListener.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/PreferenceModifyListener.java index 7236c959f..d605e4f91 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/PreferenceModifyListener.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/PreferenceModifyListener.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2005, 2014 IBM Corporation and others. - * All rights reserved. This program and the accompanying materials + * Copyright (c) 2005, 2015 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -12,24 +12,24 @@ package org.eclipse.core.runtime.preferences; /** * This class provides a hook into the preference service before particular operations - * on the global preference tree. Preference modify listeners are registered with + * on the global preference tree. Preference modify listeners are registered with * the preference service via XML and the <code>org.eclipse.equinox.preferences.preferences</code> * or the <code>org.eclipse.core.runtime.preferences</code> extension point. * <p> * Clients may subclass this type. * </p> - * + * * @since 3.1 */ public abstract class PreferenceModifyListener { /** - * Clients are given the opportunity to modify the given tree before it is applied + * Clients are given the opportunity to modify the given tree before it is applied * to the global preference tree. Clients should return the tree which should be * applied globally. The tree passed in will not be <code>null</code> and clients * <em>must not</em> return a <code>null</code> tree. * <p> - * This method is called by the preference service from within calls to + * This method is called by the preference service from within calls to * {@link IPreferencesService#applyPreferences(IExportedPreferences)} or * {@link IPreferencesService#applyPreferences(IEclipsePreferences, IPreferenceFilter[])}. * </p> @@ -37,7 +37,7 @@ public abstract class PreferenceModifyListener { * A typical action for clients to perform would be to intercept the incoming preference tree, * migrate old preference values to new ones, and then return the new tree. * </p> - * + * * @param node the tree to modify * @return the tree to apply to the global preferences */ diff --git a/bundles/org.eclipse.equinox.preferences/src/org/osgi/service/prefs/BackingStoreException.java b/bundles/org.eclipse.equinox.preferences/src/org/osgi/service/prefs/BackingStoreException.java index 9e593c4fc..57352a14a 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/osgi/service/prefs/BackingStoreException.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/osgi/service/prefs/BackingStoreException.java @@ -1,6 +1,6 @@ /* * Copyright (c) OSGi Alliance (2001, 2015). All Rights Reserved. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -18,7 +18,7 @@ package org.osgi.service.prefs; /** * Thrown to indicate that a preferences operation could not complete because of * a failure in the backing store, or a failure to contact the backing store. - * + * * @version $Id$ */ public class BackingStoreException extends Exception { @@ -27,20 +27,20 @@ public class BackingStoreException extends Exception { /** * Constructs a {@code BackingStoreException} with the specified detail * message. - * + * * @param message The detail message. */ public BackingStoreException(String message) { super(message); } - + /** * Constructs a {@code BackingStoreException} with the specified detail * message. - * + * * @param message The detail message. * @param cause The cause of the exception. May be {@code null}. - * @since 1.1 + * @since 1.1 */ public BackingStoreException(String message, Throwable cause) { super(message, cause); @@ -49,7 +49,7 @@ public class BackingStoreException extends Exception { /** * Returns the cause of this exception or {@code null} if no cause was * set. - * + * * @return The cause of this exception or {@code null} if no cause was * set. * @since 1.1 @@ -61,7 +61,7 @@ public class BackingStoreException extends Exception { /** * Initializes the cause of this exception to the specified value. - * + * * @param cause The cause of this exception. * @return This exception. * @throws IllegalArgumentException If the specified cause is this diff --git a/bundles/org.eclipse.equinox.preferences/src/org/osgi/service/prefs/Preferences.java b/bundles/org.eclipse.equinox.preferences/src/org/osgi/service/prefs/Preferences.java index 481de91d7..9d0579ab4 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/osgi/service/prefs/Preferences.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/osgi/service/prefs/Preferences.java @@ -1,6 +1,6 @@ /* - * Copyright (c) OSGi Alliance (2001, 2010). All Rights Reserved. - * + * Copyright (c) OSGi Alliance (2001, 2015). All Rights Reserved. + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -17,13 +17,13 @@ package org.osgi.service.prefs; /** * A node in a hierarchical collection of preference data. - * + * * <p> * This interface allows applications to store and retrieve user and system * preference data. This data is stored persistently in an * implementation-dependent backing store. Typical implementations include flat * files, OS-specific registries, directory servers and SQL databases. - * + * * <p> * For each bundle, there is a separate tree of nodes for each user, and one for * system preferences. The precise description of "user" and "system" will vary @@ -32,26 +32,26 @@ package org.osgi.service.prefs; * with the user via a servlet. Typical information stored in the system * preference tree might include installation data, or things like high score * information for a game program. - * + * * <p> * Nodes in a preference tree are named in a similar fashion to directories in a * hierarchical file system. Every node in a preference tree has a <i>node name * </i> (which is not necessarily unique), a unique <i>absolute path name </i>, * and a path name <i>relative </i> to each ancestor including itself. - * + * * <p> * The root node has a node name of the empty {@code String} object (""). * Every other node has an arbitrary node name, specified at the time it is * created. The only restrictions on this name are that it cannot be the empty * string, and it cannot contain the slash character ('/'). - * + * * <p> * The root node has an absolute path name of {@code "/"}. Children of the * root node have absolute path names of {@code "/" + } <i><node name> * </i>. All other nodes have absolute path names of <i><parent's absolute * path name> </i> {@code + "/" + } <i><node name> </i>. Note that * all absolute path names begin with the slash character. - * + * * <p> * A node <i>n </i>'s path name relative to its ancestor <i>a </i> is simply the * string that must be appended to <i>a </i>'s absolute path name in order to @@ -65,7 +65,7 @@ package org.osgi.service.prefs; * <li>Every node's path name relative to the root is its absolute path name * with the initial slash character removed. * </ul> - * + * * <p> * Note finally that: * <ul> @@ -74,7 +74,7 @@ package org.osgi.service.prefs; * the slash character. * <li>Any string that conforms to these two rules is a valid path name. * </ul> - * + * * <p> * Each {@code Preference} node has zero or more properties associated with * it, where a property consists of a name and a value. The bundle writer is @@ -82,22 +82,22 @@ package org.osgi.service.prefs; * type {@code String},{@code long},{@code int},{@code boolean}, * {@code byte[]},{@code float}, or {@code double} but they can * always be accessed as if they were {@code String} objects. - * + * * <p> * All node name and property name comparisons are case-sensitive. - * + * * <p> * All of the methods that modify preference data are permitted to operate * asynchronously; they may return immediately, and changes will eventually * propagate to the persistent backing store, with an implementation-dependent * delay. The {@code flush} method may be used to synchronously force updates * to the backing store. - * + * * <p> * Implementations must automatically attempt to flush to the backing store any * pending updates for a bundle's preferences when the bundle is stopped or * otherwise ungets the Preferences Service. - * + * * <p> * The methods in this class may be invoked concurrently by multiple threads in * a single Java Virtual Machine (JVM) without the need for external @@ -106,14 +106,14 @@ package org.osgi.service.prefs; * preference data in the same backing store, the data store will not be * corrupted, but no other guarantees are made concerning the consistency of the * preference data. - * + * * @noimplement * @version $Id$ */ public interface Preferences { /** * Associates the specified value with the specified key in this node. - * + * * @param key key with which the specified value is to be associated. * @param value value to be associated with the specified key. * @throws NullPointerException if {@code key} or {@code value} is @@ -127,7 +127,7 @@ public interface Preferences { * Returns the value associated with the specified {@code key} in this * node. Returns the specified default if there is no value associated with * the {@code key}, or the backing store is inaccessible. - * + * * @param key key whose associated value is to be returned. * @param def the value to be returned in the event that this node has no * value associated with {@code key} or the backing store is @@ -144,7 +144,7 @@ public interface Preferences { /** * Removes the value associated with the specified {@code key} in this * node, if any. - * + * * @param key key whose mapping is to be removed from this node. * @see #get(String,String) * @throws IllegalStateException if this node (or an ancestor) has been @@ -155,7 +155,7 @@ public interface Preferences { /** * Removes all of the properties (key-value associations) in this node. This * call has no effect on any descendants of this node. - * + * * @throws BackingStoreException if this operation cannot be completed due * to a failure in the backing store, or inability to communicate * with it. @@ -171,7 +171,7 @@ public interface Preferences { * associated string is the one that would be returned if the {@code int} * value were passed to {@code Integer.toString(int)}. This method is * intended for use in conjunction with {@link #getInt} method. - * + * * <p> * Implementor's note: it is <i>not </i> necessary that the property value * be represented by a {@code String} object in the backing store. If the @@ -180,7 +180,7 @@ public interface Preferences { * {@code Preferences} API, which allows the value to be read as an * {@code int} (with {@code getInt} or a {@code String} (with * {@code get}) type. - * + * * @param key key with which the string form of value is to be associated. * @param value {@code value} whose string form is to be associated with * {@code key}. @@ -201,7 +201,7 @@ public interface Preferences { * {@code NumberFormatException} if the associated {@code value} were * passed. This method is intended for use in conjunction with the * {@link #putInt} method. - * + * * @param key key whose associated value is to be returned as an * {@code int}. * @param def the value to be returned in the event that this node has no @@ -227,16 +227,16 @@ public interface Preferences { * the {@code long} value were passed to {@code Long.toString(long)}. * This method is intended for use in conjunction with the {@link #getLong} * method. - * + * * <p> * Implementor's note: it is <i>not </i> necessary that the {@code value} * be represented by a {@code String} type in the backing store. If the * backing store supports {@code long} values, it is not unreasonable to - * use them. This implementation detail is not visible through the {@code + * use them. This implementation detail is not visible through the {@code * Preferences} API, which allows the value to be read as a * {@code long} (with {@code getLong} or a {@code String} (with * {@code get}) type. - * + * * @param key {@code key} with which the string form of {@code value} * is to be associated. * @param value {@code value} whose string form is to be associated with @@ -258,7 +258,7 @@ public interface Preferences { * {@code NumberFormatException} if the associated {@code value} were * passed. This method is intended for use in conjunction with the * {@link #putLong} method. - * + * * @param key {@code key} whose associated value is to be returned as a * {@code long} value. * @param def the value to be returned in the event that this node has no @@ -283,7 +283,7 @@ public interface Preferences { * associated string is "true" if the value is {@code true}, and "false" * if it is {@code false}. This method is intended for use in * conjunction with the {@link #getBoolean} method. - * + * * <p> * Implementor's note: it is <i>not </i> necessary that the value be * represented by a string in the backing store. If the backing store @@ -292,7 +292,7 @@ public interface Preferences { * } API, which allows the value to be read as a {@code boolean} * (with {@code getBoolean}) or a {@code String} (with {@code get}) * type. - * + * * @param key {@code key} with which the string form of value is to be * associated. * @param value value whose string form is to be associated with @@ -312,12 +312,12 @@ public interface Preferences { * represents {@code false}. Case is ignored, so, for example, "TRUE" * and "False" are also valid. This method is intended for use in * conjunction with the {@link #putBoolean} method. - * + * * <p> * Returns the specified default if there is no value associated with the * {@code key}, the backing store is inaccessible, or if the associated * value is something other than "true" or "false", ignoring case. - * + * * @param key {@code key} whose associated value is to be returned as a * {@code boolean}. * @param def the value to be returned in the event that this node has no @@ -343,7 +343,7 @@ public interface Preferences { * if the {@code float} value were passed to * {@code Float.toString(float)}. This method is intended for use in * conjunction with the {@link #getFloat} method. - * + * * <p> * Implementor's note: it is <i>not </i> necessary that the value be * represented by a string in the backing store. If the backing store @@ -351,7 +351,7 @@ public interface Preferences { * This implementation detail is not visible through the {@code Preferences * } API, which allows the value to be read as a {@code float} (with * {@code getFloat}) or a {@code String} (with {@code get}) type. - * + * * @param key {@code key} with which the string form of value is to be * associated. * @param value value whose string form is to be associated with @@ -373,7 +373,7 @@ public interface Preferences { * {@code NumberFormatException} if the associated value were passed. * This method is intended for use in conjunction with the {@link #putFloat} * method. - * + * * @param key {@code key} whose associated value is to be returned as a * {@code float} value. * @param def the value to be returned in the event that this node has no @@ -399,7 +399,7 @@ public interface Preferences { * if the {@code double} value were passed to * {@code Double.toString(double)}. This method is intended for use in * conjunction with the {@link #getDouble} method - * + * * <p> * Implementor's note: it is <i>not </i> necessary that the value be * represented by a string in the backing store. If the backing store @@ -408,7 +408,7 @@ public interface Preferences { * } API, which allows the value to be read as a {@code double} (with * {@code getDouble}) or a {@code String} (with {@code get}) * type. - * + * * @param key {@code key} with which the string form of value is to be * associated. * @param value value whose string form is to be associated with @@ -430,7 +430,7 @@ public interface Preferences { * a {@code NumberFormatException} if the associated value were passed. * This method is intended for use in conjunction with the * {@link #putDouble} method. - * + * * @param key {@code key} whose associated value is to be returned as a * {@code double} value. * @param def the value to be returned in the event that this node has no @@ -459,16 +459,16 @@ public interface Preferences { * the <i>Base64 Alphabet </i>; it will not contain any newline characters. * This method is intended for use in conjunction with the * {@link #getByteArray} method. - * + * * <p> * Implementor's note: it is <i>not </i> necessary that the value be * represented by a {@code String} type in the backing store. If the * backing store supports {@code byte[]} values, it is not unreasonable - * to use them. This implementation detail is not visible through the {@code + * to use them. This implementation detail is not visible through the {@code * Preferences} API, which allows the value to be read as an a * {@code byte[]} object (with {@code getByteArray}) or a * {@code String} object (with {@code get}). - * + * * @param key {@code key} with which the string form of {@code value} * is to be associated. * @param value {@code value} whose string form is to be associated with @@ -491,12 +491,12 @@ public interface Preferences { * characters from the <i>Base64 Alphabet </i>; no newline characters or * extraneous characters are permitted. This method is intended for use in * conjunction with the {@link #putByteArray} method. - * + * * <p> * Returns the specified default if there is no value associated with the * {@code key}, the backing store is inaccessible, or if the associated * value is not a valid Base64 encoded byte array (as defined above). - * + * * @param key {@code key} whose associated value is to be returned as a * {@code byte[]} object. * @param def the value to be returned in the event that this node has no @@ -520,7 +520,7 @@ public interface Preferences { * Returns all of the keys that have an associated value in this node. (The * returned array will be of size zero if this node has no preferences and * not {@code null}!) - * + * * @return an array of the keys that have an associated value in this node. * @throws BackingStoreException if this operation cannot be completed due * to a failure in the backing store, or inability to communicate @@ -533,7 +533,7 @@ public interface Preferences { /** * Returns the names of the children of this node. (The returned array will * be of size zero if this node has no children and not {@code null}!) - * + * * @return the names of the children of this node. * @throws BackingStoreException if this operation cannot be completed due * to a failure in the backing store, or inability to communicate @@ -545,7 +545,7 @@ public interface Preferences { /** * Returns the parent of this node, or {@code null} if this is the root. - * + * * @return the parent of this node. * @throws IllegalStateException if this node (or an ancestor) has been * removed with the {@link #removeNode()} method. @@ -560,13 +560,13 @@ public interface Preferences { * (which begin with any character other than {@code '/'}) are * interpreted relative to this node itself. The empty string ({@code ""}) * is a valid relative pathname, referring to this node itself. - * + * * <p> * If the returned node did not exist prior to this call, this node and any * ancestors that were created by this call are not guaranteed to become * persistent until the {@code flush} method is called on the returned * node (or one of its descendants). - * + * * @param pathName the path name of the {@code Preferences} object to * return. * @return the specified {@code Preferences} object. @@ -585,14 +585,14 @@ public interface Preferences { * begin with any character other than {@code '/'}) are interpreted * relative to this node itself. The pathname {@code ""} is valid, and * refers to this node itself. - * + * * <p> * If this node (or an ancestor) has already been removed with the * {@link #removeNode()} method, it <i>is </i> legal to invoke this method, * but only with the pathname {@code ""}; the invocation will return * {@code false}. Thus, the idiom {@code p.nodeExists("")} may be * used to test whether {@code p} has been removed. - * + * * @param pathName the path name of the node whose existence is to be * checked. * @return true if the specified node exists. @@ -617,11 +617,11 @@ public interface Preferences { * instance will fail with an {@code IllegalStateException}. (The * methods defined on {@code Object} can still be invoked on a node after * it has been removed; they will not throw {@code IllegalStateException}.) - * + * * <p> * The removal is not guaranteed to be persistent until the {@code flush} * method is called on the parent of this node. - * + * * @throws IllegalStateException if this node (or an ancestor) has already * been removed with the {@link #removeNode()} method. * @throws BackingStoreException if this operation cannot be completed due @@ -633,7 +633,7 @@ public interface Preferences { /** * Returns this node's name, relative to its parent. - * + * * @return this node's name, relative to its parent. */ public String name(); @@ -649,7 +649,7 @@ public interface Preferences { * <li>Illegal names - The only illegal path names are those that contain * multiple consecutive slashes, or that end in slash and are not the root. * </ul> - * + * * @return this node's absolute path name. */ public String absolutePath(); @@ -657,22 +657,22 @@ public interface Preferences { /** * Forces any changes in the contents of this node and its descendants to * the persistent store. - * + * * <p> * Once this method returns successfully, it is safe to assume that all * changes made in the subtree rooted at this node prior to the method * invocation have become permanent. - * + * * <p> * Implementations are free to flush changes into the persistent store at * any time. They do not need to wait for this method to be called. - * + * * <p> * When a flush occurs on a newly created node, it is made persistent, as * are any ancestors (and descendants) that have yet to be made persistent. * Note however that any properties value changes in ancestors are <i>not * </i> guaranteed to be made persistent. - * + * * @throws BackingStoreException if this operation cannot be completed due * to a failure in the backing store, or inability to communicate * with it. @@ -688,7 +688,7 @@ public interface Preferences { * to the {@code sync} invocation. As a side-effect, forces any changes * in the contents of this node and its descendants to the persistent store, * as if the {@code flush} method had been invoked on this node. - * + * * @throws BackingStoreException if this operation cannot be completed due * to a failure in the backing store, or inability to communicate * with it. diff --git a/bundles/org.eclipse.equinox.preferences/src/org/osgi/service/prefs/PreferencesService.java b/bundles/org.eclipse.equinox.preferences/src/org/osgi/service/prefs/PreferencesService.java index bcb430ac7..27bd5651e 100644 --- a/bundles/org.eclipse.equinox.preferences/src/org/osgi/service/prefs/PreferencesService.java +++ b/bundles/org.eclipse.equinox.preferences/src/org/osgi/service/prefs/PreferencesService.java @@ -1,6 +1,6 @@ /* - * Copyright (c) OSGi Alliance (2001, 2010). All Rights Reserved. - * + * Copyright (c) OSGi Alliance (2001, 2015). All Rights Reserved. + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -17,39 +17,39 @@ package org.osgi.service.prefs; /** * The Preferences Service. - * + * * <p> * Each bundle using this service has its own set of preference trees: one for * system preferences, and one for each user. - * + * * <p> * A {@code PreferencesService} object is specific to the bundle which * obtained it from the service registry. If a bundle wishes to allow another * bundle to access its preferences, it should pass its * {@code PreferencesService} object to that bundle. - * + * * @noimplement * @version $Id$ */ public interface PreferencesService { /** * Returns the root system node for the calling bundle. - * + * * @return The root system node for the calling bundle. */ public Preferences getSystemPreferences(); /** * Returns the root node for the specified user and the calling bundle. - * - * @param name The user for which to return the preference root node. + * + * @param name The user for which to return the preference root node. * @return The root node for the specified user and the calling bundle. */ public Preferences getUserPreferences(String name); /** * Returns the names of users for which node trees exist. - * + * * @return The names of users for which node trees exist. */ public String[] getUsers(); |