diff options
author | Lars Vogel | 2020-02-11 15:04:23 +0000 |
---|---|---|
committer | Lars Vogel | 2020-02-11 15:04:23 +0000 |
commit | 42b804904465ef4643803f869379dd275da0d470 (patch) | |
tree | e13502cda489c38322258cf4a044e193dfe0e1f7 | |
parent | 010c2043b85ac5b287862b1c50e851c9c244b832 (diff) | |
download | rt.equinox.p2-42b804904465ef4643803f869379dd275da0d470.tar.gz rt.equinox.p2-42b804904465ef4643803f869379dd275da0d470.tar.xz rt.equinox.p2-42b804904465ef4643803f869379dd275da0d470.zip |
Removes unnecessary whitespace from core and directory bundles
Change-Id: I8c0d6a979b24b9d4c0413815df69226cc3d5421c
Signed-off-by: Lars Vogel <Lars.Vogel@vogella.com>
43 files changed, 160 insertions, 160 deletions
diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/Activator.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/Activator.java index adee2c562..d1fa2c7bf 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/Activator.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/Activator.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation * Ericsson AB (Pascal Rapicault) - reading preferences from base in shared install @@ -70,7 +70,7 @@ public class Activator implements BundleActivator { * Builds a URL with the given specification * NOTE: This method is copied from LocationHelper in org.eclipse.osgi * due to access restrictions. - * + * * @param spec the URL specification * @param trailingSlash flag to indicate a trailing slash on the spec * @return a URL @@ -126,7 +126,7 @@ public class Activator implements BundleActivator { private IAgentLocation buildLocation(String property, URI defaultLocation, boolean readOnlyDefault, boolean addTrailingSlash) { String location = Activator.context.getProperty(property); - // if the instance location is not set, predict where the workspace will be and + // if the instance location is not set, predict where the workspace will be and // put the instance area inside the workspace meta area. if (location == null) return new AgentLocation(defaultLocation); @@ -197,7 +197,7 @@ public class Activator implements BundleActivator { //This figures out if we are running in shared mode and computes the location of the p2 folder in the base. //Note that this logic only works for the case where the p2 location is colocated with the configuration area //(configuration and p2 are sibling of each others). - //To make that work for other scenarios, the config.ini of the base would have to be read and interpreted. + //To make that work for other scenarios, the config.ini of the base would have to be read and interpreted. URI location = null; String sharedConfigArea = null; try { diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/EventBusComponent.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/EventBusComponent.java index 9a024ea73..a2cc92e17 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/EventBusComponent.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/EventBusComponent.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/LogHelper.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/LogHelper.java index eb23efb7a..b3650931d 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/LogHelper.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/LogHelper.java @@ -45,7 +45,7 @@ public class LogHelper { ArrayList<FrameworkLogEntry> childlist = new ArrayList<>(); int stackCode = t instanceof CoreException ? 1 : 0; - // ensure a substatus inside a CoreException is properly logged + // ensure a substatus inside a CoreException is properly logged if (stackCode == 1) { IStatus coreStatus = ((CoreException) t).getStatus(); if (coreStatus != null) { diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/Messages.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/Messages.java index a8f30ed06..9e5939cbd 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/Messages.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/Messages.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/ServiceHelper.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/ServiceHelper.java index 3e1433ce0..60a6a029e 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/ServiceHelper.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/ServiceHelper.java @@ -8,7 +8,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: IBM Corporation - initial API and implementation ******************************************************************************/ package org.eclipse.equinox.internal.p2.core.helpers; @@ -20,8 +20,8 @@ public class ServiceHelper { /** * Returns the service described by the given arguments. Note that this is a helper class * that <b>immediately</b> ungets the service reference. This results in a window where the - * system thinks the service is not in use but indeed the caller is about to use the returned - * service object. + * system thinks the service is not in use but indeed the caller is about to use the returned + * service object. * @param context * @param clazz the service class * @return The requested service @@ -56,8 +56,8 @@ public class ServiceHelper { /** * Returns the service described by the given arguments. Note that this is a helper class * that <b>immediately</b> ungets the service reference. This results in a window where the - * system thinks the service is not in use but indeed the caller is about to use the returned - * service object. + * system thinks the service is not in use but indeed the caller is about to use the returned + * service object. * @param context * @param name * @return The requested service diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/StringHelper.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/StringHelper.java index 5dcbab1a2..58ddb4d36 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/StringHelper.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/StringHelper.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/TarEntry.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/TarEntry.java index d96f966c2..77d9105e9 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/TarEntry.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/TarEntry.java @@ -1,13 +1,13 @@ /******************************************************************************* * Copyright (c) 2008 IBM Corporation and others. * - * This program and the accompanying materials + * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 * which accompanies this distribution, and is available at * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -35,7 +35,7 @@ public class TarEntry implements Cloneable { /** * Create a new TarEntry for a file of the given name at the * given position in the file. - * + * * @param name filename * @param pos position in the file in bytes */ @@ -50,7 +50,7 @@ public class TarEntry implements Cloneable { /** * Returns the type of this file, one of FILE, LINK, SYM_LINK, * CHAR_DEVICE, BLOCK_DEVICE, DIRECTORY or FIFO. - * + * * @return file type */ public int getFileType() { @@ -59,7 +59,7 @@ public class TarEntry implements Cloneable { /** * Returns the mode of the file in UNIX permissions format. - * + * * @return file mode */ public long getMode() { @@ -68,7 +68,7 @@ public class TarEntry implements Cloneable { /** * Returns the name of the file. - * + * * @return filename */ public String getName() { @@ -77,7 +77,7 @@ public class TarEntry implements Cloneable { /** * Returns the size of the file in bytes. - * + * * @return filesize */ public long getSize() { @@ -87,7 +87,7 @@ public class TarEntry implements Cloneable { /** * Returns the modification time of the file in seconds since January * 1st 1970. - * + * * @return time */ public long getTime() { @@ -97,7 +97,7 @@ public class TarEntry implements Cloneable { /** * Sets the type of the file, one of FILE, LINK, SYMLINK, CHAR_DEVICE, * BLOCK_DEVICE, or DIRECTORY. - * + * * @param type */ public void setFileType(int type) { @@ -106,7 +106,7 @@ public class TarEntry implements Cloneable { /** * Sets the mode of the file in UNIX permissions format. - * + * * @param mode */ public void setMode(long mode) { @@ -115,7 +115,7 @@ public class TarEntry implements Cloneable { /** * Sets the size of the file in bytes. - * + * * @param size */ public void setSize(long size) { @@ -125,7 +125,7 @@ public class TarEntry implements Cloneable { /** * Sets the modification time of the file in seconds since January * 1st 1970. - * + * * @param time */ public void setTime(long time) { diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/TarException.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/TarException.java index 4cccb4b7b..9573bb063 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/TarException.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/TarException.java @@ -1,13 +1,13 @@ /******************************************************************************* * Copyright (c) 2008 IBM Corporation and others. * - * This program and the accompanying materials + * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 * which accompanies this distribution, and is available at * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/TarFile.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/TarFile.java index ff9732f0a..f53ebff02 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/TarFile.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/p2/core/helpers/TarFile.java @@ -1,13 +1,13 @@ /******************************************************************************* * Copyright (c) 2008, 2018 IBM Corporation and others. * - * This program and the accompanying materials + * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 * which accompanies this distribution, and is available at * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -30,7 +30,7 @@ public class TarFile implements Closeable { /** * Create a new TarFile for the given file. - * + * * @param file * @throws TarException * @throws IOException @@ -59,7 +59,7 @@ public class TarFile implements Closeable { /** * Close the tar file input stream. - * + * * @throws IOException if the file cannot be successfully closed */ @Override @@ -71,7 +71,7 @@ public class TarFile implements Closeable { /** * Returns an enumeration cataloguing the tar archive. - * + * * @return enumeration of all files in the archive */ public Enumeration<TarEntry> entries() { @@ -98,7 +98,7 @@ public class TarFile implements Closeable { /** * Returns a new InputStream for the given file in the tar archive. - * + * * @param entry * @return an input stream for the given file * @throws TarException @@ -131,7 +131,7 @@ public class TarFile implements Closeable { /** * Returns the path name of the file this archive represents. - * + * * @return path */ public String getName() { diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/provisional/p2/core/eventbus/IProvisioningEventBus.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/provisional/p2/core/eventbus/IProvisioningEventBus.java index ee88772ca..f4dd7638b 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/provisional/p2/core/eventbus/IProvisioningEventBus.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/internal/provisional/p2/core/eventbus/IProvisioningEventBus.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IAgentLocation.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IAgentLocation.java index 23457a028..363d6569e 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IAgentLocation.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IAgentLocation.java @@ -16,9 +16,9 @@ package org.eclipse.equinox.p2.core; import java.net.URI; /** - * An instance of this service represents the location of a provisioning agent's - * metadata. - * + * An instance of this service represents the location of a provisioning agent's + * metadata. + * * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. * @since 2.0 @@ -39,7 +39,7 @@ public interface IAgentLocation { /** * Returns the root {@link URI} of the agent metadata. - * + * * @return the location of the agent metadata */ public URI getRootLocation(); diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IPool.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IPool.java index 4ab95604e..50eec08b4 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IPool.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IPool.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -22,16 +22,16 @@ package org.eclipse.equinox.p2.core; * </p><p> * This interface is not intended to be implemented by clients. * </p> - * @noimplement This interface is not intended to be implemented by clients. + * @noimplement This interface is not intended to be implemented by clients. * @since 2.1 */ public interface IPool<T> { - /** - * Returns the first object from this pool which is equal to the given object. If the pool - * contains no such object then the object is added to the pool and returned. If the object is <code>null</code>, + /** + * Returns the first object from this pool which is equal to the given object. If the pool + * contains no such object then the object is added to the pool and returned. If the object is <code>null</code>, * <code>null</code> is returned. - * + * * @param newObject the object to add * @return a shared object that is equal to the given object or <code>null</code> */ diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IProvisioningAgent.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IProvisioningAgent.java index 694a40856..37f4bfbb9 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IProvisioningAgent.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IProvisioningAgent.java @@ -96,7 +96,7 @@ public interface IProvisioningAgent { public void registerService(String serviceName, Object service); /** - * Stops the provisioning agent. This causes services provided by this + * Stops the provisioning agent. This causes services provided by this * agent to be cleaned up and discarded. No services provided by the agent * should be referenced after the agent has been stopped, and subsequent * attempts to obtain services after the agent has stopped will fail. diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IProvisioningAgentProvider.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IProvisioningAgentProvider.java index 821bbebf0..c3eeda8a0 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IProvisioningAgentProvider.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/IProvisioningAgentProvider.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -29,7 +29,7 @@ public interface IProvisioningAgentProvider { /** * Creates a provisioning agent who metadata is stored at the given location. - * If a <code>null</code> location is provided, the provisioning agent for the + * If a <code>null</code> location is provided, the provisioning agent for the * currently running system is returned, if available. If a <code>null</code> * location is provided and the currently running system has not been provisioned * by any known agent, <code>null</code> is returned. diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/ProvisionException.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/ProvisionException.java index 6fd61efdf..463398023 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/ProvisionException.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/ProvisionException.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -19,7 +19,7 @@ import org.eclipse.equinox.internal.p2.core.Activator; /** * A checked exception indicating a recoverable error occurred while provisioning. * The status provides a further description of the problem. - * + * * @noextend This class is not intended to be subclassed by clients. * @since 2.0 */ @@ -34,48 +34,48 @@ public class ProvisionException extends CoreException { //Repository status codes [1000-1999] //General repository codes [1000-1099] - /** + /** * Status code constant (value 1000) indicating a repository * unexpectedly does not exist. */ public static final int REPOSITORY_NOT_FOUND = 1000; - /** + /** * Status code constant (value 1001) indicating a repository * unexpectedly exists. */ public static final int REPOSITORY_EXISTS = 1001; - /** + /** * Status code constant (value 1002) indicating a repository * could not be read */ public static final int REPOSITORY_FAILED_READ = 1002; - /** + /** * Status code constant (value 1003) indicating a failure occurred * while writing to a repository. */ public static final int REPOSITORY_FAILED_WRITE = 1003; - /** + /** * Status code constant (value 1004) indicating a repository * could not be written because it is a read-only repository. */ public static final int REPOSITORY_READ_ONLY = 1004; - /** + /** * Status code constant (value 1005) indicating an attempt was * made to create or access a repository of unknown type. */ public static final int REPOSITORY_UNKNOWN_TYPE = 1005; - /** + /** * Status code constant (value 1006) indicating that a specified * repository location is not valid. */ public static final int REPOSITORY_INVALID_LOCATION = 1006; - /** + /** * Status code constant (value 1007) indicating that there was * an authentication error while reading a repository */ @@ -85,13 +85,13 @@ public class ProvisionException extends CoreException { //Artifact repository codes [1200-1299] - /** + /** * Status code constant (value 1200) indicating an artifact unexpectedly * does not exist. */ public static final int ARTIFACT_NOT_FOUND = 1200; - /** + /** * Status code constant (value 1201) indicating an artifact unexpectedly * already exists. */ @@ -121,7 +121,7 @@ public class ProvisionException extends CoreException { } /** - * Creates a new exception with the given message and a severity of + * Creates a new exception with the given message and a severity of * {@link IStatus#ERROR}. * * @param message The human-readable problem message diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/StrongPool.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/StrongPool.java index 239462932..3b8b50ce9 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/StrongPool.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/StrongPool.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -18,9 +18,9 @@ import java.util.Map; /** * An object pool backed by strong references. Objects stored in this pool - * will not be garbage collected as they refer to themselves. The client is responsible for + * will not be garbage collected as they refer to themselves. The client is responsible for * nulling all references to the pool instance when it is no longer needed so that - * the contained objects can be garbage collected. + * the contained objects can be garbage collected. * <p> * If a long lived, memory managed pool is required use {@link org.eclipse.equinox.p2.core.WeakPool}. * </p> diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/UIServices.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/UIServices.java index 8826be6ea..2e6e2d97b 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/UIServices.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/UIServices.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation * Rapicorp, Inc. - add support for information dialog @@ -19,13 +19,13 @@ import java.security.cert.Certificate; /** * Service used for prompting for user information from within lower level code. * Implementors of this service are responsible for registering the service. - * + * * It is possible that the UIServices service is requested very early in the startup - * sequence for an application. For example, applications that check for updates + * sequence for an application. For example, applications that check for updates * during startup will trigger the service lookup if a server requiring authentication - * is detected. For this reason, implementors of UIServices should ensure that the + * is detected. For this reason, implementors of UIServices should ensure that the * bundle providing the service is partitioned appropriately. - * + * * @since 2.0 */ public abstract class UIServices { @@ -35,9 +35,9 @@ public abstract class UIServices { public static final String SERVICE_NAME = UIServices.class.getName(); /** - * This constant may be returned by the <code>getUsernamePassword</code> methods if the user + * This constant may be returned by the <code>getUsernamePassword</code> methods if the user * explicitly canceled the authentication prompt. - * + * * @since 2.2 */ public static final AuthenticationInfo AUTHENTICATION_PROMPT_CANCELED = new AuthenticationInfo("", "", false); //$NON-NLS-1$//$NON-NLS-2$ @@ -86,7 +86,7 @@ public abstract class UIServices { /** * Return an array of the certificates that should be trusted for the * requested operation. - * + * * @return the trusted certificates, or <code>null</code> if there are * no certificates that were verified as trusted. */ @@ -97,8 +97,8 @@ public abstract class UIServices { /** * Return a boolean indicating whether the trusted certificates should * be persisted for future operations. - * - * @return <code>true</code> if the trusted certificates should be persisted, <code>false</code> if + * + * @return <code>true</code> if the trusted certificates should be persisted, <code>false</code> if * the trust only applies for this request. */ public boolean persistTrust() { @@ -108,8 +108,8 @@ public abstract class UIServices { /** * Return a boolean indicating whether the unsigned content should be trusted * during this operation. - * - * @return <code>true</code> if the unsigned content should be trusted, or if there was no unsigned content, + * + * @return <code>true</code> if the unsigned content should be trusted, or if there was no unsigned content, * and <code>false</code> if there was unsigned content and should not be trusted. */ public boolean trustUnsignedContent() { @@ -119,7 +119,7 @@ public abstract class UIServices { /** * Opens a UI prompt for authentication details - * + * * @param location - the location requiring login details, may be <code>null</code>. * @return The authentication result, or <code>null</code>, or {@link #AUTHENTICATION_PROMPT_CANCELED} */ @@ -128,7 +128,7 @@ public abstract class UIServices { /** * Opens a UI prompt for authentication details when cached or remembered details * where not accepted. - * + * * @param location the location requiring login details * @param previousInfo - the previously used authentication details - may not be null. * @return The authentication result, or <code>null</code>, or {@link #AUTHENTICATION_PROMPT_CANCELED} @@ -137,13 +137,13 @@ public abstract class UIServices { /** * Opens a UI prompt to capture information about trusted content. - * + * * @param untrustedChain - an array of certificate chains for which there is no current trust anchor. May be * <code>null</code>, which means there are no untrusted certificate chains. * @param unsignedDetail - an array of strings, where each String describes content that is not signed. * May be <code>null</code>, which means there is no unsigned content * @return the TrustInfo that describes the user's choices for trusting certificates and - * unsigned content. + * unsigned content. */ public abstract TrustInfo getTrustInfo(Certificate[][] untrustedChain, String[] unsignedDetail); diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/WeakPool.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/WeakPool.java index 4b9dc398c..457b4f6b5 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/WeakPool.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/WeakPool.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/spi/Constants.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/spi/Constants.java index 3fa8d848b..c32cb8a9b 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/spi/Constants.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/spi/Constants.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * Pascal Rapicault - initial API and implementation *******************************************************************************/ @@ -16,7 +16,7 @@ package org.eclipse.equinox.p2.core.spi; public interface Constants { /* * This constant is used internally in p2 to represent the case of a bundled macos application (the case where all the files are contained in the .app folder. - * It is typically used as an environment property in a profile. + * It is typically used as an environment property in a profile. */ public final String MACOSX_BUNDLED = "macosx-bundled"; //$NON-NLS-1$ } diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/spi/IAgentService.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/spi/IAgentService.java index 38c679768..184edaf94 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/spi/IAgentService.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/spi/IAgentService.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/spi/IAgentServiceFactory.java b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/spi/IAgentServiceFactory.java index fcebea86a..a56ec642d 100644 --- a/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/spi/IAgentServiceFactory.java +++ b/bundles/org.eclipse.equinox.p2.core/src/org/eclipse/equinox/p2/core/spi/IAgentServiceFactory.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -34,7 +34,7 @@ public interface IAgentServiceFactory { /** * Instantiates a service instance for the given provisioning agent. - * + * * @param agent The agent this service will belong to * @return The created service */ diff --git a/bundles/org.eclipse.equinox.p2.director.app/src/org/eclipse/equinox/internal/p2/director/app/Activator.java b/bundles/org.eclipse.equinox.p2.director.app/src/org/eclipse/equinox/internal/p2/director/app/Activator.java index afb363cf3..a42b1ccfb 100644 --- a/bundles/org.eclipse.equinox.p2.director.app/src/org/eclipse/equinox/internal/p2/director/app/Activator.java +++ b/bundles/org.eclipse.equinox.p2.director.app/src/org/eclipse/equinox/internal/p2/director/app/Activator.java @@ -8,7 +8,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: IBM Corporation - initial API and implementation ******************************************************************************/ package org.eclipse.equinox.internal.p2.director.app; diff --git a/bundles/org.eclipse.equinox.p2.director.app/src/org/eclipse/equinox/internal/p2/director/app/ILog.java b/bundles/org.eclipse.equinox.p2.director.app/src/org/eclipse/equinox/internal/p2/director/app/ILog.java index edd4d5c13..fbf17a0fe 100644 --- a/bundles/org.eclipse.equinox.p2.director.app/src/org/eclipse/equinox/internal/p2/director/app/ILog.java +++ b/bundles/org.eclipse.equinox.p2.director.app/src/org/eclipse/equinox/internal/p2/director/app/ILog.java @@ -24,13 +24,13 @@ import org.eclipse.core.runtime.IStatus; public interface ILog { /** * Send status to the standard log - * + * * @param status */ void log(IStatus status); /** - * + * * @param message * @deprecated Use {@link ILog#printOut()} or {@link ILog#printErr()} */ @@ -46,9 +46,9 @@ public interface ILog { /** * Print status on stdout or stderr. - * + * * By default calls {@link #log} - * + * * @param status */ default void printOut(String line) { @@ -57,9 +57,9 @@ public interface ILog { /** * Send line to stdout - * + * * By default does nothing - * + * * @param message line */ default void printErr(String line) { diff --git a/bundles/org.eclipse.equinox.p2.director.app/src/org/eclipse/equinox/internal/p2/director/app/Messages.java b/bundles/org.eclipse.equinox.p2.director.app/src/org/eclipse/equinox/internal/p2/director/app/Messages.java index 3ccd7fe92..8f6cea191 100644 --- a/bundles/org.eclipse.equinox.p2.director.app/src/org/eclipse/equinox/internal/p2/director/app/Messages.java +++ b/bundles/org.eclipse.equinox.p2.director.app/src/org/eclipse/equinox/internal/p2/director/app/Messages.java @@ -8,8 +8,8 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * - * Contributors: + * + * Contributors: * IBM Corporation - initial API and implementation * Cloudsmith - https://bugs.eclipse.org/bugs/show_bug.cgi?id=226401 ******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.director.app/src_ant/org/eclipse/equinox/p2/director/app/ant/DirectorTask.java b/bundles/org.eclipse.equinox.p2.director.app/src_ant/org/eclipse/equinox/p2/director/app/ant/DirectorTask.java index 4dd59101a..5fcad1f07 100644 --- a/bundles/org.eclipse.equinox.p2.director.app/src_ant/org/eclipse/equinox/p2/director/app/ant/DirectorTask.java +++ b/bundles/org.eclipse.equinox.p2.director.app/src_ant/org/eclipse/equinox/p2/director/app/ant/DirectorTask.java @@ -1,13 +1,13 @@ /******************************************************************************* * Copyright (c) 2007, 2017 IBM Corporation and others. * - * This program and the accompanying materials + * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 * which accompanies this distribution, and is available at * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -36,7 +36,7 @@ import org.eclipse.osgi.util.NLS; /** * An Ant task to call the p2 Director application. - * + * * @since 1.0 */ public class DirectorTask extends Task implements ILog { diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/ApplicablePatchQuery.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/ApplicablePatchQuery.java index 2800b092c..72cded157 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/ApplicablePatchQuery.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/ApplicablePatchQuery.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation * Cloudsmith Inc. - converted into expression based query diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/AttachmentHelper.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/AttachmentHelper.java index a35158080..b9748f936 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/AttachmentHelper.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/AttachmentHelper.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Explanation.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Explanation.java index 7e455a11d..c24960dc6 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Explanation.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Explanation.java @@ -9,7 +9,7 @@ * * SPDX-License-Identifier: EPL-2.0 * - * Contributors: + * Contributors: * Daniel Le Berre - initial API and implementation * IBM - ongoing development ******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/InfiniteProgress.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/InfiniteProgress.java index 3833b569f..05d88e956 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/InfiniteProgress.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/InfiniteProgress.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Messages.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Messages.java index 3b0130071..87e08a7ec 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Messages.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Messages.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/OperationGenerator.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/OperationGenerator.java index 1ea4e4e1a..e7334a627 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/OperationGenerator.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/OperationGenerator.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/PlannerComponent.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/PlannerComponent.java index 3e0200a95..338012459 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/PlannerComponent.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/PlannerComponent.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Projector.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Projector.java index a226aad91..36b0e7122 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Projector.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Projector.java @@ -9,7 +9,7 @@ * * SPDX-License-Identifier: EPL-2.0 * - * Contributors: + * Contributors: * IBM Corporation - initial API and implementation * Daniel Le Berre - Fix in the encoding and the optimization function * Alban Browaeys - Optimized string concatenation in bug 251357 @@ -82,7 +82,7 @@ public class Projector { //Non greedy things private Set<IInstallableUnit> nonGreedyIUs; //All the IUs that would satisfy non greedy dependencies private Map<IInstallableUnit, AbstractVariable> nonGreedyVariables = new HashMap<>(); - private Map<AbstractVariable, List<Object>> nonGreedyProvider = new HashMap<>(); //Keeps track of all the "object" that provide an IU that is non greedly requested + private Map<AbstractVariable, List<Object>> nonGreedyProvider = new HashMap<>(); //Keeps track of all the "object" that provide an IU that is non greedly requested private boolean emptyBecauseFiltered; private boolean userDefinedFunction; @@ -204,7 +204,7 @@ public class Projector { int timeout = DEFAULT_SOLVER_TIMEOUT; String timeoutString = null; try { - // allow the user to specify a longer timeout. + // allow the user to specify a longer timeout. // only set the value if it is a positive integer larger than the default. // see https://bugs.eclipse.org/336967 timeoutString = DirectorActivator.context.getProperty(PROP_PROJECTOR_TIMEOUT); @@ -368,7 +368,7 @@ public class Projector { return; IInstallableUnitFragment fragment = (IInstallableUnitFragment) iu; - // for each host requirement, find matches and remember them + // for each host requirement, find matches and remember them for (IRequirement req : fragment.getHost()) { List<IInstallableUnit> matches = getApplicableMatches(req); rememberHostMatches((IInstallableUnitFragment) iu, matches); @@ -487,7 +487,7 @@ public class Projector { private Collection<IRequirement> getRequiredCapabilities(IInstallableUnit iu) { boolean isFragment = iu instanceof IInstallableUnitFragment; - //Short-circuit for the case of an IInstallableUnit + //Short-circuit for the case of an IInstallableUnit if ((!isFragment) && iu.getMetaRequirements().size() == 0) return iu.getRequirements(); diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/QueryableArray.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/QueryableArray.java index 094de4791..ca095cb28 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/QueryableArray.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/QueryableArray.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation * Cloudsmith Inc. - query indexes diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/SimpleDirector.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/SimpleDirector.java index d87a7696a..11a1ba5ce 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/SimpleDirector.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/SimpleDirector.java @@ -8,8 +8,8 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * - * Contributors: + * + * Contributors: * IBM Corporation - initial API and implementation * Sonatype, Inc. - ongoing development ******************************************************************************/ diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Slicer.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Slicer.java index 758520321..075a6f918 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Slicer.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/director/Slicer.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation * Sonatype, Inc. - ongoing development @@ -158,7 +158,7 @@ public class Slicer { private Collection<IRequirement> getRequirements(IInstallableUnit iu) { boolean isPatch = iu instanceof IInstallableUnitPatch; boolean isFragment = iu instanceof IInstallableUnitFragment; - //Short-circuit for the case of an IInstallableUnit + //Short-circuit for the case of an IInstallableUnit if ((!isFragment) && (!isPatch) && iu.getMetaRequirements().size() == 0) return iu.getRequirements(); diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/rollback/FormerState.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/rollback/FormerState.java index f648198b1..aeeaf16cb 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/rollback/FormerState.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/p2/rollback/FormerState.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation * Sonatype, Inc. - ongoing development diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/provisional/p2/director/IDirector.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/provisional/p2/director/IDirector.java index 7ee3ba1cf..14e5dd199 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/provisional/p2/director/IDirector.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/provisional/p2/director/IDirector.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -20,14 +20,14 @@ import org.eclipse.equinox.p2.engine.ProvisioningContext; import org.eclipse.equinox.p2.planner.IProfileChangeRequest; /** - * Directors are responsible for determining what should be done to a given - * profile to reshape it as requested. That is, given the current state of a - * profile, a description of the desired end state of that profile and metadata - * describing the available IUs, a director produces a list of provisioning - * operations (e.g., install, update or uninstall) to perform on the related IUs. - * Directors are also able to validate profiles and assist in the diagnosis of - * configuration errors. Note that directors may range in complexity from - * very simple (e.g., reading a list of bundles from a static file) to very complex. + * Directors are responsible for determining what should be done to a given + * profile to reshape it as requested. That is, given the current state of a + * profile, a description of the desired end state of that profile and metadata + * describing the available IUs, a director produces a list of provisioning + * operations (e.g., install, update or uninstall) to perform on the related IUs. + * Directors are also able to validate profiles and assist in the diagnosis of + * configuration errors. Note that directors may range in complexity from + * very simple (e.g., reading a list of bundles from a static file) to very complex. */ public interface IDirector { @@ -38,7 +38,7 @@ public interface IDirector { /** * performs the change request with the given context. - * + * * @param profileChangeRequest The change request * @param context The provisioning context used for finding resources * @param monitor a progress monitor, or <code>null</code> if progress @@ -48,7 +48,7 @@ public interface IDirector { /** * Reverts the profile to a previous state described in the target revertProfile. - * + * * @param profile The profile to revert * @param revertProfile The profile snapshot state to revert to * @param context The provisioning context used for finding resources diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/provisional/p2/director/PlannerStatus.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/provisional/p2/director/PlannerStatus.java index 1bdada5d7..ff00f323d 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/provisional/p2/director/PlannerStatus.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/provisional/p2/director/PlannerStatus.java @@ -39,7 +39,7 @@ public class PlannerStatus implements IStatus { /** * Returns a request status object containing additional global details on the planning of the request - * + * * @return An IStatus object with global details on the planning process */ public RequestStatus getRequestStatus() { @@ -50,8 +50,8 @@ public class PlannerStatus implements IStatus { * Returns a map of the problems associated with changes to the given installable unit * in this plan. A status with severity {@link IStatus#OK} is returned if the unit * can be provisioned successfully - * - * @return A map of {@link IInstallableUnit} to {@link IStatus} of the requested + * + * @return A map of {@link IInstallableUnit} to {@link IStatus} of the requested * changes and their corresponding explanation. */ public Map<IInstallableUnit, RequestStatus> getRequestChanges() { @@ -77,16 +77,16 @@ public class PlannerStatus implements IStatus { } /** - * Returns the set of InstallableUnits that make up the expected planned state in terms - * of additions and removals to the profile based on the planning process. - * - * @return An IQueryable of the InstallableUnits in the planned state. + * Returns the set of InstallableUnits that make up the expected planned state in terms + * of additions and removals to the profile based on the planning process. + * + * @return An IQueryable of the InstallableUnits in the planned state. */ public IQueryable<IInstallableUnit> getPlannedState() { return plannedState; } - // Remaining Methods Delegate to wrapped Status + // Remaining Methods Delegate to wrapped Status @Override public IStatus[] getChildren() { return status.getChildren(); diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/provisional/p2/director/RequestStatus.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/provisional/p2/director/RequestStatus.java index d5ae455fe..e39f3a42a 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/provisional/p2/director/RequestStatus.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/internal/provisional/p2/director/RequestStatus.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2008, 2017 IBM Corporation and others. + * Copyright (c) 2008, 2017 IBM Corporation and others. * * This * program and the accompanying materials are made available under the terms of diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/p2/planner/IPlanner.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/p2/planner/IPlanner.java index 9b031e628..88c3bead6 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/p2/planner/IPlanner.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/p2/planner/IPlanner.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation * Sonatype, Inc. - ongoing development @@ -20,12 +20,12 @@ import org.eclipse.equinox.p2.metadata.IInstallableUnit; import org.eclipse.equinox.p2.query.IQueryResult; /** - * Planners are responsible for determining what should be done to a given - * profile to reshape it as requested. That is, given the current state of a - * profile, a description of the desired changes to that profile and metadata + * Planners are responsible for determining what should be done to a given + * profile to reshape it as requested. That is, given the current state of a + * profile, a description of the desired changes to that profile and metadata * describing the available installable units, a planner produces a concrete plan that lists the * exact steps that the engine should perform. - * + * * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. * @since 2.0 @@ -39,7 +39,7 @@ public interface IPlanner { /** * Returns a plan describing the set of changes that must be performed to * satisfy the given profile change request. - * + * * @param profileChangeRequest the request to be evaluated * @param context the context in which the request is processed * @param monitor a monitor on which planning @@ -52,8 +52,8 @@ public interface IPlanner { public IProfileChangeRequest createChangeRequest(IProfile profileToChange); /** - * @noreference This method is not intended to be referenced by clients. - * You may want to consider using the org.eclipse.equinox.p2.operations.UpdateOperation class instead. + * @noreference This method is not intended to be referenced by clients. + * You may want to consider using the org.eclipse.equinox.p2.operations.UpdateOperation class instead. */ public IQueryResult<IInstallableUnit> updatesFor(IInstallableUnit iu, ProvisioningContext context, IProgressMonitor monitor); } diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/p2/planner/IProfileChangeRequest.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/p2/planner/IProfileChangeRequest.java index 0cdece8ec..693bb83ae 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/p2/planner/IProfileChangeRequest.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/p2/planner/IProfileChangeRequest.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * Sonatype, Inc. - initial API and implementation * IBM Corporation - ongoing development @@ -28,9 +28,9 @@ import org.eclipse.equinox.p2.metadata.IRequirement; * state consistent. * * It is important to note that a change request can only be submitted once to the planner. - * + * * Clients should create and manipulate profile change requests via the API {@link IPlanner#createChangeRequest(IProfile)}. - * + * * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. * @since 2.0 @@ -51,7 +51,7 @@ public interface IProfileChangeRequest { /** * Requests the removal of the specified installable unit - * + * * @param toUninstall the installable units to be remove from the profile */ public abstract void remove(IInstallableUnit toUninstall); @@ -64,7 +64,7 @@ public interface IProfileChangeRequest { /** * Add extra requirements that must be satisfied by the planner. - * + * * @param requirements the additional requirements */ public void addExtraRequirements(Collection<IRequirement> requirements); @@ -82,35 +82,35 @@ public interface IProfileChangeRequest { /** * Removes all inclusion rules associated with the given installable unit - * + * * @param iu the installable unit to remove inclusion rules for */ public abstract void removeInstallableUnitInclusionRules(IInstallableUnit iu); - /** + /** * Set a global property on the profile - * + * * @param key key of the property * @param value value of the property */ public abstract void setProfileProperty(String key, String value); - /** + /** * Remove a global property on the profile - * + * * @param key key of the property */ public abstract void removeProfileProperty(String key); - /** + /** * Associate a property with a given installable unit. - * + * * @param key key of the property * @param value value of the property */ public abstract void setInstallableUnitProfileProperty(IInstallableUnit iu, String key, String value); - /** + /** * Remove a property with a given installable unit. * @param iu The installable until to remove a property for * @param key key of the property diff --git a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/p2/planner/ProfileInclusionRules.java b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/p2/planner/ProfileInclusionRules.java index 29f93ac16..6c1b18fb2 100644 --- a/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/p2/planner/ProfileInclusionRules.java +++ b/bundles/org.eclipse.equinox.p2.director/src/org/eclipse/equinox/p2/planner/ProfileInclusionRules.java @@ -7,7 +7,7 @@ * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 - * + * * Contributors: * IBM Corporation - initial API and implementation * Sonatype Inc - Refactoring @@ -33,7 +33,7 @@ public class ProfileInclusionRules { * later profile change request. That is, when there is a dependency conflict * between a strictly installed unit and a non-strict unit, the strictly installed * installable unit will take precedence. - * + * * @param iu the installable unit to be installed. * @return an opaque token to be passed to the {@link IProfileChangeRequest#setInstallableUnitInclusionRules(IInstallableUnit, String)} */ @@ -45,7 +45,7 @@ public class ProfileInclusionRules { * Returns an inclusion rule to optionally install the given installable unit. An optionally * installed installable unit will automatically be removed from the profile if any of * its dependencies become unsatisfied. - * + * * @param iu the installable unit to be installed. * @return an opaque token to be passed to the {@link IProfileChangeRequest#setInstallableUnitInclusionRules(IInstallableUnit, String)} */ |