From a585769e7dbd9e682b71b5371b2c4f4d72b71849 Mon Sep 17 00:00:00 2001 From: Jeff McAffer Date: Wed, 21 Jan 2004 22:15:02 +0000 Subject: [PATCH 01/29] add wad support --- .../org/eclipse/core/runtime/IProduct.java | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java new file mode 100644 index 0000000000..b6a7294c5a --- /dev/null +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -0,0 +1,42 @@ +package org.eclipse.core.runtime; + +import java.net.URL; + +public interface IProduct { + + /** + * Returns the applicatoin associated with this product. This information is used + * to guide the runtime as to what application extension to create and execute. + * @return this product's application or null if none + */ + public String getApplication(); + /** + * Returns the name of this product. The name is typcially used in the title + * bar of UI windows. + * @return the name of this product or null if none + */ + public String getName(); + /** + * Returns the text desciption of this product + * @return the description of this product or null if none + */ + public String getDescription(); + /** + * Returns the URL for this product's image. The image is used in the about dialog + * and should be either full-sized (no larger than 500x330 pixels) or half-sized + * (no larger than 250x330 pixels). + * @return the image for this product or null if none + */ + public URL getImage(); + /** + * Returns the id of the welcome extension to use for this product + * @return the id of this product's welcome page or null if none + */ + public String getDefaultPerspective(); + + /** Returns the unique product id of this product. + * @return the id of this product + */ + public String getId(); + +} From 8bb0d9039a9597dfd3b0f92fd7ca9fcc68b16e8b Mon Sep 17 00:00:00 2001 From: Jeff McAffer Date: Thu, 22 Jan 2004 16:23:46 +0000 Subject: [PATCH 02/29] update copyrights --- .../src/org/eclipse/core/runtime/IProduct.java | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index b6a7294c5a..70ec5a57e2 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -1,3 +1,13 @@ +/********************************************************************** + * Copyright (c) 2004 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Common Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/cpl-v10.html + * + * Contributors: + * IBM Corporation - initial API and implementation + *******************************************************************************/ package org.eclipse.core.runtime; import java.net.URL; From 057239265d7b0dab6928a747defd49ad5fc72391 Mon Sep 17 00:00:00 2001 From: Jeff McAffer Date: Mon, 26 Jan 2004 21:27:11 +0000 Subject: [PATCH 03/29] reorg IProduct and IBundleGroup to be more generic --- .../org/eclipse/core/runtime/IProduct.java | 25 ++++++++----------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index 70ec5a57e2..295e13cc37 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -10,8 +10,6 @@ *******************************************************************************/ package org.eclipse.core.runtime; -import java.net.URL; - public interface IProduct { /** @@ -31,22 +29,19 @@ public interface IProduct { * @return the description of this product or null if none */ public String getDescription(); - /** - * Returns the URL for this product's image. The image is used in the about dialog - * and should be either full-sized (no larger than 500x330 pixels) or half-sized - * (no larger than 250x330 pixels). - * @return the image for this product or null if none - */ - public URL getImage(); - /** - * Returns the id of the welcome extension to use for this product - * @return the id of this product's welcome page or null if none - */ - public String getDefaultPerspective(); - /** Returns the unique product id of this product. * @return the id of this product */ public String getId(); + /** + * Returns the property of this product with the given key. + * null is returned if there is no such key/value pair. + * @param key the name of the property to return + * @return the value associated with the given key + */ + public String getProperty(String key); + + + } From 01c116dfbeceab3c068f595b0ccaaa8c4bc2d6fc Mon Sep 17 00:00:00 2001 From: Pascal Rapicault Date: Mon, 26 Jan 2004 22:30:44 +0000 Subject: [PATCH 04/29] fix some javadoc --- .../src/org/eclipse/core/runtime/IProduct.java | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index 295e13cc37..8ab911bbbc 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -11,26 +11,29 @@ package org.eclipse.core.runtime; public interface IProduct { - /** * Returns the applicatoin associated with this product. This information is used * to guide the runtime as to what application extension to create and execute. * @return this product's application or null if none + * @since 3.0 */ public String getApplication(); /** * Returns the name of this product. The name is typcially used in the title * bar of UI windows. * @return the name of this product or null if none + * @since 3.0 */ public String getName(); /** * Returns the text desciption of this product * @return the description of this product or null if none + * @since 3.0 */ public String getDescription(); /** Returns the unique product id of this product. * @return the id of this product + * @since 3.0 */ public String getId(); @@ -39,6 +42,7 @@ public interface IProduct { * null is returned if there is no such key/value pair. * @param key the name of the property to return * @return the value associated with the given key + * @since 3.0 */ public String getProperty(String key); From c997cbf5f9b6b58f9e250d0b3d6cd868a2f2dd4f Mon Sep 17 00:00:00 2001 From: Jeff McAffer Date: Mon, 16 Feb 2004 04:14:53 +0000 Subject: [PATCH 05/29] add IProductProvider, update Javadoc and the schema definition. --- .../org/eclipse/core/runtime/IProduct.java | 25 +++++++++++++------ 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index 8ab911bbbc..544a95cb80 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -10,6 +10,24 @@ *******************************************************************************/ package org.eclipse.core.runtime; +/** + * Products are Eclipse unit of branding. From the runtime point of view they have + * a name, id and description and identify the Eclipse application to run. + *

+ * Since the bulk of the branding related information is + * specific to the UI, products also carry an arbitrary set of properties. The valid set of + * key-value pairs and their interpretation defined by the UI of the target environment. + *

+ * Products can be defined using extensions to the org.eclipse.core.runtime.products + * extension point or by using facilities provided by IProductProvider implementations. + *

+ * For readers familiar with Eclipse 2.1 and earlier, products are roughly equivalent to + * primary features. + *

+ * + * @see IProductProvider + * @since 3.0 + */ public interface IProduct { /** * Returns the applicatoin associated with this product. This information is used @@ -22,18 +40,15 @@ public interface IProduct { * Returns the name of this product. The name is typcially used in the title * bar of UI windows. * @return the name of this product or null if none - * @since 3.0 */ public String getName(); /** * Returns the text desciption of this product * @return the description of this product or null if none - * @since 3.0 */ public String getDescription(); /** Returns the unique product id of this product. * @return the id of this product - * @since 3.0 */ public String getId(); @@ -42,10 +57,6 @@ public interface IProduct { * null is returned if there is no such key/value pair. * @param key the name of the property to return * @return the value associated with the given key - * @since 3.0 */ public String getProperty(String key); - - - } From 1cf0931b58c7137f44028607678520b6d7fb9a6a Mon Sep 17 00:00:00 2001 From: Pascal Rapicault Date: Fri, 2 Apr 2004 20:55:52 +0000 Subject: [PATCH 06/29] *** empty log message *** --- .../src/org/eclipse/core/runtime/IProduct.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index 544a95cb80..8dd30f7a5b 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -28,6 +28,8 @@ * @see IProductProvider * @since 3.0 */ + +//TODO Need to put a reference to the org.eclipse.ui.branding.IProductConstants public interface IProduct { /** * Returns the applicatoin associated with this product. This information is used From 5f824a628bd5ea3eb97cf0088ac26273bcf12a27 Mon Sep 17 00:00:00 2001 From: Jeff McAffer Date: Mon, 12 Apr 2004 16:34:02 +0000 Subject: [PATCH 07/29] Javadoc updates and a few todos --- .../org/eclipse/core/runtime/IProduct.java | 28 ++++++++++++------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index 8dd30f7a5b..eda18b4737 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -11,14 +11,16 @@ package org.eclipse.core.runtime; /** - * Products are Eclipse unit of branding. From the runtime point of view they have + * Products are the Eclipse unit of branding. From the runtime point of view they have * a name, id and description and identify the Eclipse application to run. *

* Since the bulk of the branding related information is * specific to the UI, products also carry an arbitrary set of properties. The valid set of * key-value pairs and their interpretation defined by the UI of the target environment. + * For example, in the standard Eclipse UI, org.eclipse.ui.branding.IProductConstants + * the properties of interest to the UI. Other clients may specify additional properties. *

- * Products can be defined using extensions to the org.eclipse.core.runtime.products + * Products can be defined directly using extensions to the org.eclipse.core.runtime.products * extension point or by using facilities provided by IProductProvider implementations. *

* For readers familiar with Eclipse 2.1 and earlier, products are roughly equivalent to @@ -26,39 +28,45 @@ *

* * @see IProductProvider + * @see org.eclipse.ui.branding.IProductConstants * @since 3.0 */ - -//TODO Need to put a reference to the org.eclipse.ui.branding.IProductConstants public interface IProduct { /** * Returns the applicatoin associated with this product. This information is used * to guide the runtime as to what application extension to create and execute. - * @return this product's application or null if none - * @since 3.0 + * + * @return this product's application or null if none */ public String getApplication(); + /** * Returns the name of this product. The name is typcially used in the title * bar of UI windows. - * @return the name of this product or null if none + * + * @return the name of this product or null if none */ public String getName(); + /** * Returns the text desciption of this product - * @return the description of this product or null if none + * + * @return the description of this product or null if none */ public String getDescription(); + /** Returns the unique product id of this product. + * * @return the id of this product */ public String getId(); /** * Returns the property of this product with the given key. - * null is returned if there is no such key/value pair. + * null is returned if there is no such key/value pair. + * * @param key the name of the property to return - * @return the value associated with the given key + * @return the value associated with the given key or null if none */ public String getProperty(String key); } From 4abc58a26bea1e67bdb5b3f2c44b482e996efd7a Mon Sep 17 00:00:00 2001 From: Jeff McAffer Date: Fri, 16 Apr 2004 02:15:23 +0000 Subject: [PATCH 08/29] Reformat Equinox code according to the Core formatter settings --- .../src/org/eclipse/core/runtime/IProduct.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index eda18b4737..e9aa29a1fc 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -60,7 +60,7 @@ public interface IProduct { * @return the id of this product */ public String getId(); - + /** * Returns the property of this product with the given key. * null is returned if there is no such key/value pair. @@ -69,4 +69,4 @@ public interface IProduct { * @return the value associated with the given key or null if none */ public String getProperty(String key); -} +} \ No newline at end of file From 9844ab148354a740b9dbe0d446cacf27f921bc69 Mon Sep 17 00:00:00 2001 From: Jeff McAffer Date: Thu, 27 May 2004 15:51:14 +0000 Subject: [PATCH 09/29] Bug 64253 [API] add IProduct.getDefiningBundle() --- .../src/org/eclipse/core/runtime/IProduct.java | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index e9aa29a1fc..651abfe772 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -10,6 +10,8 @@ *******************************************************************************/ package org.eclipse.core.runtime; +import org.osgi.framework.Bundle; + /** * Products are the Eclipse unit of branding. From the runtime point of view they have * a name, id and description and identify the Eclipse application to run. @@ -69,4 +71,13 @@ public interface IProduct { * @return the value associated with the given key or null if none */ public String getProperty(String key); + + /** + * Returns the bundle which is responsible for the definition of this product. + * Typically this is used as a base for searching for images and other files + * that are needed in presenting the product. + * + * @return Bundle the bundle which defines this product or null if none + */ + public Bundle getDefiningBundle(); } \ No newline at end of file From 1d46e0df49385dd6a5bc6819bef663df18480e45 Mon Sep 17 00:00:00 2001 From: Jeff McAffer Date: Thu, 27 May 2004 16:10:00 +0000 Subject: [PATCH 10/29] javadoc fix --- .../src/org/eclipse/core/runtime/IProduct.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index 651abfe772..04579e1293 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -77,7 +77,7 @@ public interface IProduct { * Typically this is used as a base for searching for images and other files * that are needed in presenting the product. * - * @return Bundle the bundle which defines this product or null if none + * @return the bundle which defines this product or null if none */ public Bundle getDefiningBundle(); } \ No newline at end of file From 2bfc2b719c1a0de5162ff3b42b28865978017711 Mon Sep 17 00:00:00 2001 From: John Arthorne Date: Mon, 21 Feb 2005 23:10:19 +0000 Subject: [PATCH 11/29] Convert copyrights from CPL to EPL --- .../src/org/eclipse/core/runtime/IProduct.java | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index 04579e1293..8303f1cb9c 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -1,11 +1,11 @@ -/********************************************************************** +/******************************************************************************* * Copyright (c) 2004 IBM Corporation and others. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Common Public License v1.0 + * 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/cpl-v10.html + * http://www.eclipse.org/legal/epl-v10.html * - * Contributors: + * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.core.runtime; @@ -80,4 +80,4 @@ public interface IProduct { * @return the bundle which defines this product or null if none */ public Bundle getDefiningBundle(); -} \ No newline at end of file +} From ee4e6af1a077843a70da4ac5e9a3507c7d7107e9 Mon Sep 17 00:00:00 2001 From: John Arthorne Date: Wed, 8 Jun 2005 19:44:31 +0000 Subject: [PATCH 12/29] fixed typos in javadoc --- .../src/org/eclipse/core/runtime/IProduct.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index 8303f1cb9c..d03417e01c 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -35,7 +35,7 @@ */ public interface IProduct { /** - * Returns the applicatoin associated with this product. This information is used + * Returns the application associated with this product. This information is used * to guide the runtime as to what application extension to create and execute. * * @return this product's application or null if none @@ -43,7 +43,7 @@ public interface IProduct { public String getApplication(); /** - * Returns the name of this product. The name is typcially used in the title + * Returns the name of this product. The name is typically used in the title * bar of UI windows. * * @return the name of this product or null if none @@ -51,7 +51,7 @@ public interface IProduct { public String getName(); /** - * Returns the text desciption of this product + * Returns the text description of this product * * @return the description of this product or null if none */ From 6123ed6fe7b38cf01d4c0443158699c3241ca4cb Mon Sep 17 00:00:00 2001 From: John Arthorne Date: Tue, 4 Apr 2006 20:55:44 +0000 Subject: [PATCH 13/29] updated copyrights --- .../src/org/eclipse/core/runtime/IProduct.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index d03417e01c..33abd94f8e 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2004 IBM Corporation and others. + * Copyright (c) 2004, 2005 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 *******************************************************************************/ From 0c4964a8c87c8a338c457c0aa2370f786877cc8b Mon Sep 17 00:00:00 2001 From: DJ Houghton Date: Wed, 10 May 2006 18:15:12 +0000 Subject: [PATCH 14/29] Updated copyrights. --- .../src/org/eclipse/core/runtime/IProduct.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index 33abd94f8e..246be33cc3 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2005 IBM Corporation and others. + * Copyright (c) 2004, 2006 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 From 9b837145a7af3c4c1495e7d361fa0af330a25bb9 Mon Sep 17 00:00:00 2001 From: John Arthorne Date: Thu, 16 Aug 2007 17:10:37 +0000 Subject: [PATCH 15/29] Removed @see to type that may not be present --- .../src/org/eclipse/core/runtime/IProduct.java | 1 - 1 file changed, 1 deletion(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index 246be33cc3..f696629b80 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -30,7 +30,6 @@ *

* * @see IProductProvider - * @see org.eclipse.ui.branding.IProductConstants * @since 3.0 */ public interface IProduct { From 28e548da6c1a5b4ff76d59af4a43ad90a0a3e5c2 Mon Sep 17 00:00:00 2001 From: John Arthorne Date: Wed, 4 Mar 2009 14:30:05 +0000 Subject: [PATCH 16/29] copyright update --- .../src/org/eclipse/core/runtime/IProduct.java | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index f696629b80..39ad59d852 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -1,11 +1,11 @@ /******************************************************************************* - * Copyright (c) 2004, 2006 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: + * Copyright (c) 2004, 2007 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.runtime; From 7d21c7f26ac4d29d8011a42ecf20b0d0939e0ab8 Mon Sep 17 00:00:00 2001 From: Simon Scholz Date: Mon, 16 Mar 2015 10:27:13 +0100 Subject: [PATCH 17/29] Bug 462035 - Solve whitespace issues in eclipse.runtime plug-ins Change-Id: I776107680b86a43d201b760be935914fa352315f Signed-off-by: Simon Scholz --- .../org/eclipse/core/runtime/IProduct.java | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index 39ad59d852..8ca5306495 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.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 *******************************************************************************/ @@ -14,10 +14,10 @@ /** * Products are the Eclipse unit of branding. From the runtime point of view they have - * a name, id and description and identify the Eclipse application to run. + * a name, id and description and identify the Eclipse application to run. *

* Since the bulk of the branding related information is - * specific to the UI, products also carry an arbitrary set of properties. The valid set of + * specific to the UI, products also carry an arbitrary set of properties. The valid set of * key-value pairs and their interpretation defined by the UI of the target environment. * For example, in the standard Eclipse UI, org.eclipse.ui.branding.IProductConstants * the properties of interest to the UI. Other clients may specify additional properties. @@ -25,18 +25,18 @@ * Products can be defined directly using extensions to the org.eclipse.core.runtime.products * extension point or by using facilities provided by IProductProvider implementations. *

- * For readers familiar with Eclipse 2.1 and earlier, products are roughly equivalent to - * primary features. + * For readers familiar with Eclipse 2.1 and earlier, products are roughly equivalent to + * primary features. *

- * + * * @see IProductProvider * @since 3.0 */ public interface IProduct { /** - * Returns the application associated with this product. This information is used + * Returns the application associated with this product. This information is used * to guide the runtime as to what application extension to create and execute. - * + * * @return this product's application or null if none */ public String getApplication(); @@ -44,20 +44,20 @@ public interface IProduct { /** * Returns the name of this product. The name is typically used in the title * bar of UI windows. - * + * * @return the name of this product or null if none */ public String getName(); /** * Returns the text description of this product - * + * * @return the description of this product or null if none */ public String getDescription(); /** Returns the unique product id of this product. - * + * * @return the id of this product */ public String getId(); @@ -65,17 +65,17 @@ public interface IProduct { /** * Returns the property of this product with the given key. * null is returned if there is no such key/value pair. - * + * * @param key the name of the property to return * @return the value associated with the given key or null if none */ public String getProperty(String key); - + /** * Returns the bundle which is responsible for the definition of this product. - * Typically this is used as a base for searching for images and other files + * Typically this is used as a base for searching for images and other files * that are needed in presenting the product. - * + * * @return the bundle which defines this product or null if none */ public Bundle getDefiningBundle(); From b0c7a5b1c1f310177c1924f811bf6129874fc39a Mon Sep 17 00:00:00 2001 From: Lars Vogel Date: Fri, 17 Aug 2018 14:15:32 +0200 Subject: [PATCH 18/29] Bug 535802 - Update license to EPL-2.0 in our source files This affects all files except the .exsd , the "org.eclipse.jdt.ui.prefs" and the pom.xml files. Regular expression used: find . -type f ! -name "*.exsd" ! -name "org.eclipse.jdt.ui.prefs" -exec sed -i 's/Eclipse Public License v1.0/Eclipse Public License 2.0/g' {} + find . -type f ! -name "*.exsd" ! -name "org.eclipse.jdt.ui.prefs" -exec sed -i -E 's/([[:blank:]]*[^[:blank:]])*([[:blank:]]*)http:\/\/www.eclipse.org\/legal\/epl-v10.html/\1\2https:\/\/www.eclipse.org\/legal\/epl-2.0\/\ \1\ \1\2SPDX-License-Identifier: EPL-2.0/' {} + # Get rid of the All rights reserved find . -type f ! -name "*.exsd" ! -name "org.eclipse.jdt.ui.prefs" ! -name "pom.xml" -exec sed -i -E 's/([[:blank:]]*[^[:blank:]])*([[:blank:]]*)(All rights reserved. )/\1\n\1\2/' {} + Change-Id: I9ca35a0f032a75a181f7dc6268989d848a210963 Signed-off-by: Lars Vogel --- .../src/org/eclipse/core/runtime/IProduct.java | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java index 8ca5306495..42cf5c14d6 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java @@ -1,9 +1,12 @@ /******************************************************************************* * Copyright (c) 2004, 2007 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 + * + * 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 - * http://www.eclipse.org/legal/epl-v10.html + * https://www.eclipse.org/legal/epl-2.0/ + * + * SPDX-License-Identifier: EPL-2.0 * * Contributors: * IBM Corporation - initial API and implementation From bdd418198ce32ae52d321b209edf02b58d9799da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20L=C3=A4ubrich?= Date: Wed, 4 Dec 2024 11:05:49 +0100 Subject: [PATCH 19/29] Move IProduct to commons --- .../src/org/eclipse/core/runtime/IProduct.java | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename bundles/{org.eclipse.core.runtime => org.eclipse.equinox.common}/src/org/eclipse/core/runtime/IProduct.java (100%) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProduct.java similarity index 100% rename from bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProduct.java rename to bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProduct.java From 4e5c3bf4de7078b3347ce6caff68908aef1ca2da Mon Sep 17 00:00:00 2001 From: Jeff McAffer Date: Mon, 16 Feb 2004 04:14:53 +0000 Subject: [PATCH 20/29] add IProductProvider, update Javadoc and the schema definition. --- .../core/runtime/IProductProvider.java | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java new file mode 100644 index 0000000000..cf9a02caeb --- /dev/null +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java @@ -0,0 +1,40 @@ +/********************************************************************** + * Copyright (c) 2004 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Common Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/cpl-v10.html + * + * Contributors: + * IBM Corporation - initial API and implementation + *******************************************************************************/ +package org.eclipse.core.runtime; + +/** + * Product providers define products (units of branding) which have been installed in + * the current system. Typically, a configuration agent (i.e., plug-in installer) will + * define a product provider so that it can report to the system the products it has installed. + *

+ * Products are normally defined and installed in the system using extensions to the + * org.eclipse.core.runtime.products extension point. In cases where + * the notion of product is defined by alternate means (e.g., primary feature), an IProductProvider + * can be installed in this extension point (using an executable extension). The provider + * then acts as a proxy for the product extensions that represent the products installed. + *

+ * + * @see IProduct + * @since 3.0 + */ +public interface IProductProvider { + /** + * Returns the human-readable name of this product provider. + * @return the name of this product provider + */ + public String getName(); + + /** + * Returns the products provided by this provider. + * @return the products provided by this provider + */ + public IProduct[] getProducts(); +} \ No newline at end of file From 2e3789aa74cfc9cc88c38d4785877e4824d956c1 Mon Sep 17 00:00:00 2001 From: Jeff McAffer Date: Mon, 12 Apr 2004 16:34:02 +0000 Subject: [PATCH 21/29] Javadoc updates and a few todos --- .../src/org/eclipse/core/runtime/IProductProvider.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java index cf9a02caeb..4dc24c150d 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java @@ -18,7 +18,7 @@ * Products are normally defined and installed in the system using extensions to the * org.eclipse.core.runtime.products extension point. In cases where * the notion of product is defined by alternate means (e.g., primary feature), an IProductProvider - * can be installed in this extension point (using an executable extension). The provider + * can be installed in this extension point using an executable extension. The provider * then acts as a proxy for the product extensions that represent the products installed. *

* @@ -28,12 +28,14 @@ public interface IProductProvider { /** * Returns the human-readable name of this product provider. + * * @return the name of this product provider */ public String getName(); /** * Returns the products provided by this provider. + * * @return the products provided by this provider */ public IProduct[] getProducts(); From 07f11a1b32865677093d14d8e222df6d756342ec Mon Sep 17 00:00:00 2001 From: Jeff McAffer Date: Fri, 16 Apr 2004 02:15:23 +0000 Subject: [PATCH 22/29] Reformat Equinox code according to the Core formatter settings --- .../src/org/eclipse/core/runtime/IProductProvider.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java index 4dc24c150d..67a0a0da4a 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java @@ -32,7 +32,7 @@ public interface IProductProvider { * @return the name of this product provider */ public String getName(); - + /** * Returns the products provided by this provider. * From b60376f30c4aee8601f6d01a259a00ea5fce3269 Mon Sep 17 00:00:00 2001 From: John Arthorne Date: Mon, 21 Feb 2005 23:10:19 +0000 Subject: [PATCH 23/29] Convert copyrights from CPL to EPL --- .../org/eclipse/core/runtime/IProductProvider.java | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java index 67a0a0da4a..72a0ab4b32 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java @@ -1,11 +1,11 @@ -/********************************************************************** +/******************************************************************************* * Copyright (c) 2004 IBM Corporation and others. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Common Public License v1.0 + * 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/cpl-v10.html + * http://www.eclipse.org/legal/epl-v10.html * - * Contributors: + * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.core.runtime; @@ -39,4 +39,4 @@ public interface IProductProvider { * @return the products provided by this provider */ public IProduct[] getProducts(); -} \ No newline at end of file +} From 97dfaa0bb71345fc1ada945c400820436560d75d Mon Sep 17 00:00:00 2001 From: John Arthorne Date: Tue, 4 Apr 2006 20:55:44 +0000 Subject: [PATCH 24/29] updated copyrights --- .../src/org/eclipse/core/runtime/IProductProvider.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java index 72a0ab4b32..4f4747c5de 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java @@ -1,10 +1,10 @@ /******************************************************************************* - * Copyright (c) 2004 IBM Corporation and others. + * Copyright (c) 2004, 2005 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 *******************************************************************************/ From 6e56a1958cd5ea1c02751783e544c836d11b628a Mon Sep 17 00:00:00 2001 From: DJ Houghton Date: Wed, 10 May 2006 18:15:12 +0000 Subject: [PATCH 25/29] Updated copyrights. --- .../src/org/eclipse/core/runtime/IProductProvider.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java index 4f4747c5de..5e72785392 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2005 IBM Corporation and others. + * Copyright (c) 2004, 2006 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 From dd95c0a4b60ec48d2a14ab296d4baf13b3e0006c Mon Sep 17 00:00:00 2001 From: Simon Scholz Date: Mon, 16 Mar 2015 10:27:13 +0100 Subject: [PATCH 26/29] Bug 462035 - Solve whitespace issues in eclipse.runtime plug-ins Change-Id: I776107680b86a43d201b760be935914fa352315f Signed-off-by: Simon Scholz --- .../org/eclipse/core/runtime/IProductProvider.java | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java index 5e72785392..4decb0529d 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java @@ -12,30 +12,30 @@ /** * Product providers define products (units of branding) which have been installed in - * the current system. Typically, a configuration agent (i.e., plug-in installer) will + * the current system. Typically, a configuration agent (i.e., plug-in installer) will * define a product provider so that it can report to the system the products it has installed. *

- * Products are normally defined and installed in the system using extensions to the - * org.eclipse.core.runtime.products extension point. In cases where + * Products are normally defined and installed in the system using extensions to the + * org.eclipse.core.runtime.products extension point. In cases where * the notion of product is defined by alternate means (e.g., primary feature), an IProductProvider * can be installed in this extension point using an executable extension. The provider * then acts as a proxy for the product extensions that represent the products installed. *

- * + * * @see IProduct * @since 3.0 */ public interface IProductProvider { /** * Returns the human-readable name of this product provider. - * + * * @return the name of this product provider */ public String getName(); /** * Returns the products provided by this provider. - * + * * @return the products provided by this provider */ public IProduct[] getProducts(); From eabb303ef37059c9e7f4145316ae37e48f0aef89 Mon Sep 17 00:00:00 2001 From: Lars Vogel Date: Fri, 17 Aug 2018 14:15:32 +0200 Subject: [PATCH 27/29] Bug 535802 - Update license to EPL-2.0 in our source files This affects all files except the .exsd , the "org.eclipse.jdt.ui.prefs" and the pom.xml files. Regular expression used: find . -type f ! -name "*.exsd" ! -name "org.eclipse.jdt.ui.prefs" -exec sed -i 's/Eclipse Public License v1.0/Eclipse Public License 2.0/g' {} + find . -type f ! -name "*.exsd" ! -name "org.eclipse.jdt.ui.prefs" -exec sed -i -E 's/([[:blank:]]*[^[:blank:]])*([[:blank:]]*)http:\/\/www.eclipse.org\/legal\/epl-v10.html/\1\2https:\/\/www.eclipse.org\/legal\/epl-2.0\/\ \1\ \1\2SPDX-License-Identifier: EPL-2.0/' {} + # Get rid of the All rights reserved find . -type f ! -name "*.exsd" ! -name "org.eclipse.jdt.ui.prefs" ! -name "pom.xml" -exec sed -i -E 's/([[:blank:]]*[^[:blank:]])*([[:blank:]]*)(All rights reserved. )/\1\n\1\2/' {} + Change-Id: I9ca35a0f032a75a181f7dc6268989d848a210963 Signed-off-by: Lars Vogel --- .../src/org/eclipse/core/runtime/IProductProvider.java | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java index 4decb0529d..c95be3d86c 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java @@ -1,9 +1,12 @@ /******************************************************************************* * Copyright (c) 2004, 2006 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 + * + * 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 - * http://www.eclipse.org/legal/epl-v10.html + * https://www.eclipse.org/legal/epl-2.0/ + * + * SPDX-License-Identifier: EPL-2.0 * * Contributors: * IBM Corporation - initial API and implementation From 4e2b8b4a980966cfdd8a0018f59a6b0bb9e00621 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20L=C3=A4ubrich?= Date: Wed, 4 Dec 2024 11:07:59 +0100 Subject: [PATCH 28/29] Move IProductProvider from platfrom > common --- .../src/org/eclipse/core/runtime/IProductProvider.java | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename bundles/{org.eclipse.core.runtime => org.eclipse.equinox.common}/src/org/eclipse/core/runtime/IProductProvider.java (100%) diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProductProvider.java similarity index 100% rename from bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/IProductProvider.java rename to bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProductProvider.java From 2d3f1e135d9b5bdfe977d5c0df94390a7e11af24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20L=C3=A4ubrich?= Date: Wed, 4 Dec 2024 11:09:11 +0100 Subject: [PATCH 29/29] Add API filter for moved files / bump version --- .../.settings/.api_filters | 21 +++++++++++++++++++ .../META-INF/MANIFEST.MF | 2 +- 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 bundles/org.eclipse.equinox.common/.settings/.api_filters diff --git a/bundles/org.eclipse.equinox.common/.settings/.api_filters b/bundles/org.eclipse.equinox.common/.settings/.api_filters new file mode 100644 index 0000000000..fd59ceb29f --- /dev/null +++ b/bundles/org.eclipse.equinox.common/.settings/.api_filters @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/bundles/org.eclipse.equinox.common/META-INF/MANIFEST.MF b/bundles/org.eclipse.equinox.common/META-INF/MANIFEST.MF index 47c4a0c963..77de180a27 100644 --- a/bundles/org.eclipse.equinox.common/META-INF/MANIFEST.MF +++ b/bundles/org.eclipse.equinox.common/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %pluginName Bundle-SymbolicName: org.eclipse.equinox.common; singleton:=true -Bundle-Version: 3.19.200.qualifier +Bundle-Version: 3.20.0.qualifier Bundle-Localization: plugin Export-Package: org.eclipse.core.internal.boot;x-friends:="org.eclipse.core.resources,org.eclipse.pde.build", org.eclipse.core.internal.runtime;common=split;mandatory:=common;