bundles/org.eclipse.platform.doc.isv/porting/4.12/recommended.html - gerrit/platform/eclipse.platform.common - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html lang="en">
 <head>
 <meta name="copyright" content="Copyright (c) 2019 Red Hat Inc. and others. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta http-equiv="Content-Style-Type" content="text/css">
 <link rel="STYLESHEET" href="../../book.css" charset="ISO-8859-1" type="text/css">
 <title>Adopting 4.12 mechanisms and APIs</title>
 </head>
 <body>
 <h1>Adopting 4.12 mechanisms and APIs</h1>

 <p>
   This section describes changes that are required if you are trying to change
   your 4.11 plug-in to adopt the 4.12 mechanisms and APIs.
 </p>

 <ol>
 	<li><a href="#ecf">Removal of the <code>org.eclipse.ecf.filetransfer.httpclient4</code> and <code>org.eclipse.ecf.filetransfer.httpclient4.ssl</code> features</a></li>
 	<li><a href="#icu4j">Direct usages of IBM ICU4j should be upgraded</a></li>
 </ol>

 <hr>

 <!-- ############################################## -->
 <h2>1. <a name="ecf">Removal of the <code>org.eclipse.ecf.filetransfer.httpclient4</code> and <code>org.eclipse.ecf.filetransfer.httpclient4.ssl</code> features</a></h2>
 <p><strong>What is affected:</strong> Clients including either of the above mentioned features from the 4.11 target platform.
 </p>
 <p><strong>Description:</strong>
 Since the Eclipse Platform migrated to the new ECF filetransfer implementation provided by the <code>org.eclipse.ecf.filetransfer.httpclient45</code> feature, the following two features are no longer included in the Eclipse 4.12 target platform:</p>
 <ul>
 	<li><code>org.eclipse.ecf.filetransfer.httpclient4</code></li>
 	<li><code>org.eclipse.ecf.filetransfer.httpclient4.ssl</code></li>
 </ul>
 <p><strong>Action required:</strong>
 Clients are recommended to remove the <code>org.eclipse.ecf.filetransfer.httpclient4</code> and <code>org.eclipse.ecf.filetransfer.httpclient4.ssl</code> features from their products if they are included directly and instead consume the new <code>org.eclipse.ecf.filetransfer.httpclient45</code> feature.</p>
 <p><strong>Alternatively:</strong>
 Clients may also continue to use the old ECF features by consuming them directly from the ECF p2 repository instead of from the Eclipse Platform itself.</p>
 <!-- ############################################## -->
 <h2>2. <a name="icu4j">Direct usages of IBM ICU4j should be upgraded</a></h2>
 <p><strong>What is affected:</strong> Clients directly using IBM ICU4j bundle versions earlier than <code>64.2.0</code>.
 </p>
 <p><strong>Description:</strong>
 The IBM ICU4j bundles used by Eclipse Platform was updated to version <code>64.2.0</code> to take advantage of support for Unicode version 12 and to support the Japanese era.
 Clients that were making direct use of the IBM ICU4j APIs should upgrade and ensure their code continues to work with version <code>64.2.0</code>.
 Other clients should not be affected. See <a href="http://site.icu-project.org/download/">IBM ICU4j website</a> for details.</p>
 <p><strong>Action required:</strong>
 Clients should:
 </p>
 <ul>
 <li>Upgrade their products and code to work with IBM ICU4j version <code>64.2.0</code></li>
 </ul>
 <!-- ############################################## -->
 <h2>3. <a name="wizards">Wizards can now be nonmodal</a></h2>
 <p><strong>We have introduced new API to <code>WizardDialog</code> to enable a wizard to be nonmodal.</strong></p>
 <p><strong>Description:</strong>
 When a dialog is modal it means that the underlying window can not be used. Eclipse Wizard Dialogs are modal by default. There are cases where it is desired that the dialog is not modal but that the underlying window can be reached WHILE the user is finishing the wizard.
 The following API methods are added to the JFace <code>WizardDialog</code>.
 </p>
 <ul>
 	<li><code>public WizardDialog setModal(boolean modal)</code></li>
 	<li><code>public boolean isModal()</code></li>
 </ul>
 <p>
 In addition the following methods have been made public to allow full control over the shell style of the <code>WizardDialog</code>.
 </p>
 <ul>
 	<li><code>public void setShellStyle(int newShellStyle)</code></li>
 	<li><code>public int getShellStyle()</code></li>
 </ul>
 <!-- ############################################## -->
 <h2>4. <a name="icu4j">Direct usages of Apache Batik should be upgraded</a></h2>
 <p><strong>What is affected:</strong> Clients directly using Apache Batik bundle versions earlier than <code>1.11.0</code>.
 </p>
 <p><strong>Description:</strong>
 The Apache Batik bundles used by Eclipse Platform was updated to version <code>1.11.0</code> to take advantage of latest bugfixes and Java 11 compatibility. This updated included update of <code>org.apache.xmlgraphics</code> bundle to version <code>2.3.0</code> too.
 Clients that were making direct use of the Apache Batik APIs should upgrade and ensure their code continues to work with version <code>1.11.0</code>.
 Other clients should not be affected.
 <p><strong>Action required:</strong>
 Clients should:
 </p>
 <ul>
 <li>Upgrade their products and code to work with Apache Batik version <code>1.11.0</code></li>
 </ul>
 <!-- ############################################## -->
 <h2>5. <a name="icu4j">Pre-built Lucene indexes should be updated</a></h2>
 <p><strong>What is affected:</strong> Clients supplying pre-built Lucene help indexes.
 </p>
 <p><strong>Description:</strong>
 We have updated the Apache Lucene search engine to Lucene 8.0.0. This means that the indexes
 built with older versions will not be readable anymore. See <a href="https://lucene.apache.org/core/8_0_0/changes/Changes.html">
 Lucene Change Log</a> for details.
 <p><strong>Action required:</strong>
 Clients should:
 </p>
 <ul>
 <li>Re-build their indexes with Lucene 8.0.0 and supply them as before></li>
 </ul>
 <!-- ############################################## -->
 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	<html lang="en">
	<head>
	<meta name="copyright" content="Copyright (c) 2019 Red Hat Inc. and others. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
	<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
	<meta http-equiv="Content-Style-Type" content="text/css">
	<link rel="STYLESHEET" href="../../book.css" charset="ISO-8859-1" type="text/css">
	<title>Adopting 4.12 mechanisms and APIs</title>
	</head>
	<body>
	<h1>Adopting 4.12 mechanisms and APIs</h1>

	<p>
	This section describes changes that are required if you are trying to change
	your 4.11 plug-in to adopt the 4.12 mechanisms and APIs.
	</p>

	<ol>
	<li><a href="#ecf">Removal of the <code>org.eclipse.ecf.filetransfer.httpclient4</code> and <code>org.eclipse.ecf.filetransfer.httpclient4.ssl</code> features</a></li>
	<li><a href="#icu4j">Direct usages of IBM ICU4j should be upgraded</a></li>
	</ol>

	<hr>

	<!-- ############################################## -->
	<h2>1. <a name="ecf">Removal of the <code>org.eclipse.ecf.filetransfer.httpclient4</code> and <code>org.eclipse.ecf.filetransfer.httpclient4.ssl</code> features</a></h2>
	<p><strong>What is affected:</strong> Clients including either of the above mentioned features from the 4.11 target platform.
	</p>
	<p><strong>Description:</strong>
	Since the Eclipse Platform migrated to the new ECF filetransfer implementation provided by the <code>org.eclipse.ecf.filetransfer.httpclient45</code> feature, the following two features are no longer included in the Eclipse 4.12 target platform:</p>
	<ul>
	<li><code>org.eclipse.ecf.filetransfer.httpclient4</code></li>
	<li><code>org.eclipse.ecf.filetransfer.httpclient4.ssl</code></li>
	</ul>
	<p><strong>Action required:</strong>
	Clients are recommended to remove the <code>org.eclipse.ecf.filetransfer.httpclient4</code> and <code>org.eclipse.ecf.filetransfer.httpclient4.ssl</code> features from their products if they are included directly and instead consume the new <code>org.eclipse.ecf.filetransfer.httpclient45</code> feature.</p>
	<p><strong>Alternatively:</strong>
	Clients may also continue to use the old ECF features by consuming them directly from the ECF p2 repository instead of from the Eclipse Platform itself.</p>
	<!-- ############################################## -->
	<h2>2. <a name="icu4j">Direct usages of IBM ICU4j should be upgraded</a></h2>
	<p><strong>What is affected:</strong> Clients directly using IBM ICU4j bundle versions earlier than <code>64.2.0</code>.
	</p>
	<p><strong>Description:</strong>
	The IBM ICU4j bundles used by Eclipse Platform was updated to version <code>64.2.0</code> to take advantage of support for Unicode version 12 and to support the Japanese era.
	Clients that were making direct use of the IBM ICU4j APIs should upgrade and ensure their code continues to work with version <code>64.2.0</code>.
	Other clients should not be affected. See <a href="http://site.icu-project.org/download/">IBM ICU4j website</a> for details.</p>
	<p><strong>Action required:</strong>
	Clients should:
	</p>
	<ul>
	<li>Upgrade their products and code to work with IBM ICU4j version <code>64.2.0</code></li>
	</ul>
	<!-- ############################################## -->
	<h2>3. <a name="wizards">Wizards can now be nonmodal</a></h2>
	<p><strong>We have introduced new API to <code>WizardDialog</code> to enable a wizard to be nonmodal.</strong></p>
	<p><strong>Description:</strong>
	When a dialog is modal it means that the underlying window can not be used. Eclipse Wizard Dialogs are modal by default. There are cases where it is desired that the dialog is not modal but that the underlying window can be reached WHILE the user is finishing the wizard.
	The following API methods are added to the JFace <code>WizardDialog</code>.
	</p>
	<ul>
	<li><code>public WizardDialog setModal(boolean modal)</code></li>
	<li><code>public boolean isModal()</code></li>
	</ul>
	<p>
	In addition the following methods have been made public to allow full control over the shell style of the <code>WizardDialog</code>.
	</p>
	<ul>
	<li><code>public void setShellStyle(int newShellStyle)</code></li>
	<li><code>public int getShellStyle()</code></li>
	</ul>
	<!-- ############################################## -->
	<h2>4. <a name="icu4j">Direct usages of Apache Batik should be upgraded</a></h2>
	<p><strong>What is affected:</strong> Clients directly using Apache Batik bundle versions earlier than <code>1.11.0</code>.
	</p>
	<p><strong>Description:</strong>
	The Apache Batik bundles used by Eclipse Platform was updated to version <code>1.11.0</code> to take advantage of latest bugfixes and Java 11 compatibility. This updated included update of <code>org.apache.xmlgraphics</code> bundle to version <code>2.3.0</code> too.
	Clients that were making direct use of the Apache Batik APIs should upgrade and ensure their code continues to work with version <code>1.11.0</code>.
	Other clients should not be affected.
	<p><strong>Action required:</strong>
	Clients should:
	</p>
	<ul>
	<li>Upgrade their products and code to work with Apache Batik version <code>1.11.0</code></li>
	</ul>
	<!-- ############################################## -->
	<h2>5. <a name="icu4j">Pre-built Lucene indexes should be updated</a></h2>
	<p><strong>What is affected:</strong> Clients supplying pre-built Lucene help indexes.
	</p>
	<p><strong>Description:</strong>
	We have updated the Apache Lucene search engine to Lucene 8.0.0. This means that the indexes
	built with older versions will not be readable anymore. See <a href="https://lucene.apache.org/core/8_0_0/changes/Changes.html">
	Lucene Change Log</a> for details.
	<p><strong>Action required:</strong>
	Clients should:
	</p>
	<ul>
	<li>Re-build their indexes with Lucene 8.0.0 and supply them as before></li>
	</ul>
	<!-- ############################################## -->
	</body>
	</html>