Bug 483368 - Replace usage of SubProgressMonitor with SubMonitor in ua

Change-Id: Iad6d2733647d1f344922a527b057ee0cc41cf979
Signed-off-by: Conrad Groth <info@conrad-groth.de>

6 files changed, 38 insertions, 49 deletions

diff --git a/org.eclipse.help.base/pom.xml b/org.eclipse.help.base/pom.xml
index bf5e34b3e..9f5c48846 100644
--- a/org.eclipse.help.base/pom.xml
+++ b/org.eclipse.help.base/pom.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  Copyright (c) 2012, 2014 Eclipse Foundation and others.
+  Copyright (c) 2012, 2016 Eclipse Foundation and others.
   All rights reserved. This program and the accompanying materials
   are made available under the terms of the Eclipse Distribution License v1.0
   which accompanies this distribution, and is available at
diff --git a/org.eclipse.help.base/src/org/eclipse/help/internal/base/remote/RemoteSearchManager.java b/org.eclipse.help.base/src/org/eclipse/help/internal/base/remote/RemoteSearchManager.java
index 533b3a190..25527e9a1 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/internal/base/remote/RemoteSearchManager.java
+++ b/org.eclipse.help.base/src/org/eclipse/help/internal/base/remote/RemoteSearchManager.java
@@ -1,5 +1,5 @@
 /***************************************************************************************************
- * Copyright (c) 2006, 2015 IBM Corporation and others. All rights reserved. This program and the
+ * Copyright (c) 2006, 2016 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
@@ -14,7 +14,7 @@ import java.net.URL;
 import java.util.List;
 
 import org.eclipse.core.runtime.IProgressMonitor;
-import org.eclipse.core.runtime.SubProgressMonitor;
+import org.eclipse.core.runtime.SubMonitor;
 import org.eclipse.help.internal.base.HelpBasePlugin;
 import org.eclipse.help.internal.base.util.ProxyUtil;
 import org.eclipse.help.internal.search.ISearchHitCollector;
@@ -38,7 +38,7 @@ public class RemoteSearchManager {
 	 */
 	public void search(ISearchQuery searchQuery, ISearchHitCollector collector, IProgressMonitor pm)
 			throws QueryTooComplexException {
-		pm.beginTask("", 100); //$NON-NLS-1$
+		SubMonitor subMonitor = SubMonitor.convert(pm, 100);
 
 		PreferenceFileHandler prefHandler = new PreferenceFileHandler();
 		String host[] = prefHandler.getHostEntries();
@@ -72,7 +72,7 @@ public class RemoteSearchManager {
 
 							RemoteSearchParser parser = new RemoteSearchParser();
 							// parse the XML-serialized search results
-							List<SearchHit> hits = parser.parse(in, new SubProgressMonitor(pm, 100));
+							List<SearchHit> hits = parser.parse(in, subMonitor.split(100));
 							collector.addHits(hits, null);
 						} catch (IOException e) {
 							String msg = "I/O error while trying to contact the remote help server"; //$NON-NLS-1$
diff --git a/org.eclipse.help.base/src/org/eclipse/help/internal/search/IndexingOperation.java b/org.eclipse.help.base/src/org/eclipse/help/internal/search/IndexingOperation.java
index 03340c8ec..ec744ffa9 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/internal/search/IndexingOperation.java
+++ b/org.eclipse.help.base/src/org/eclipse/help/internal/search/IndexingOperation.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2015 IBM Corporation and others.
+ * Copyright (c) 2000, 2016 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
@@ -28,7 +28,7 @@ import org.eclipse.core.runtime.InvalidRegistryObjectException;
 import org.eclipse.core.runtime.MultiStatus;
 import org.eclipse.core.runtime.OperationCanceledException;
 import org.eclipse.core.runtime.Platform;
-import org.eclipse.core.runtime.SubProgressMonitor;
+import org.eclipse.core.runtime.SubMonitor;
 import org.eclipse.help.ITocContribution;
 import org.eclipse.help.ITopic;
 import org.eclipse.help.internal.HelpPlugin;
@@ -95,15 +95,14 @@ class IndexingOperation {
 			BaseHelpSystem.getLocalSearchManager().clearSearchParticipants();
 			return;
 		}
-		pm.beginTask(HelpBaseResources.UpdatingIndex, numRemoved + 10
-				* numAdded);
+		SubMonitor subMonitor = SubMonitor.convert(pm, HelpBaseResources.UpdatingIndex, numRemoved + 10 * numAdded);
 
 		// 1. remove all documents for plugins changed (including change in a
 		// fragment)
-		removeStaleDocuments(new SubProgressMonitor(pm, numRemoved), staleDocs);
+		removeStaleDocuments(subMonitor.split(numRemoved), staleDocs);
 		checkCancelled(pm);
 		// 2. merge prebult plugin indexes and addjust
-		addNewDocuments(new SubProgressMonitor(pm, 10 * numAdded), newDocs,
+		addNewDocuments(subMonitor.split(10 * numAdded), newDocs,
 				staleDocs.size() == 0);
 
 		pm.done();
@@ -154,13 +153,11 @@ class IndexingOperation {
 		Collection<URL> docsToIndex = calculateDocsToAdd(newDocs, prebuiltDocs);
 		checkCancelled(pm);
 		Map<String, String[]> docsToDelete = calculateNewToRemove(newDocs, prebuiltDocs);
-		pm.beginTask("", 10 * docsToIndex.size() + docsToDelete.size()); //$NON-NLS-1$
+		SubMonitor subMonitor = SubMonitor.convert(pm, 10 * docsToIndex.size() + docsToDelete.size());
 		checkCancelled(pm);
-		addDocuments(new SubProgressMonitor(pm, 10 * docsToIndex.size()),
-				docsToIndex, docsToDelete.size() == 0);
+		addDocuments(subMonitor.split(10 * docsToIndex.size()), docsToIndex, docsToDelete.size() == 0);
 		checkCancelled(pm);
-		removeNewDocuments(new SubProgressMonitor(pm, docsToDelete.size()),
-				docsToDelete);
+		removeNewDocuments(subMonitor.split(docsToDelete.size()), docsToDelete);
 		pm.done();
 		return docsToDelete;
 	}
diff --git a/org.eclipse.help.base/src/org/eclipse/help/internal/search/InfoCenter.java b/org.eclipse.help.base/src/org/eclipse/help/internal/search/InfoCenter.java
index acdd67997..35000aab3 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/internal/search/InfoCenter.java
+++ b/org.eclipse.help.base/src/org/eclipse/help/internal/search/InfoCenter.java
@@ -171,11 +171,11 @@ public final class InfoCenter implements ISearchEngine {
 		tocs.clear();
 		try {
 			URLConnection connection = ProxyUtil.getConnection(url);
-			monitor.beginTask(HelpBaseResources.InfoCenter_connecting, 5);
+			SubMonitor subMonitor = SubMonitor.convert(monitor, HelpBaseResources.InfoCenter_connecting, 5);
 			is = connection.getInputStream();
 			try (BufferedReader reader = new BufferedReader(new InputStreamReader(is, StandardCharsets.UTF_8))) {
-				monitor.worked(1);
-				load(((Scope) scope).url, reader, collector, new SubProgressMonitor(monitor, 4));
+				subMonitor.worked(1);
+				load(((Scope) scope).url, reader, collector, subMonitor.split(4));
 			}
 		} catch (FileNotFoundException e) {
 			reportError(HelpBaseResources.InfoCenter_fileNotFound, e, collector);
@@ -207,8 +207,8 @@ public final class InfoCenter implements ISearchEngine {
 			parser.setEntityResolver(new LocalEntityResolver());
 			if (monitor.isCanceled())
 				return;
-			monitor.beginTask("", 5); //$NON-NLS-1$
-			monitor.subTask(HelpBaseResources.InfoCenter_searching);
+			SubMonitor subMonitor = SubMonitor.convert(monitor, 5);
+			subMonitor.subTask(HelpBaseResources.InfoCenter_searching);
 			document = parser.parse(new InputSource(r));
 			if (monitor.isCanceled())
 				return;
@@ -221,9 +221,8 @@ public final class InfoCenter implements ISearchEngine {
 				if (monitor.isCanceled())
 					return;
 			}
-			monitor.worked(1);
-			load(baseURL, document, (Element) root, collector,
-					new SubProgressMonitor(monitor, 4));
+			subMonitor.worked(1);
+			load(baseURL, document, (Element) root, collector, subMonitor.split(4));
 		} catch (ParserConfigurationException e) {
 			// ignore
 		} catch (IOException e) {
diff --git a/org.eclipse.help.base/src/org/eclipse/help/internal/search/SearchManager.java b/org.eclipse.help.base/src/org/eclipse/help/internal/search/SearchManager.java
index 949b41003..9c0eabbe2 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/internal/search/SearchManager.java
+++ b/org.eclipse.help.base/src/org/eclipse/help/internal/search/SearchManager.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2015 IBM Corporation and others.
+ * Copyright (c) 2000, 2016 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
@@ -22,7 +22,7 @@ import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.Platform;
 import org.eclipse.core.runtime.Status;
-import org.eclipse.core.runtime.SubProgressMonitor;
+import org.eclipse.core.runtime.SubMonitor;
 import org.eclipse.core.runtime.jobs.Job;
 import org.eclipse.help.internal.base.HelpBasePlugin;
 import org.eclipse.help.internal.base.remote.RemoteHelp;
@@ -113,11 +113,11 @@ public class SearchManager {
 		SearchState state = new SearchState();
 		state.searchQuery = searchQuery;
 
-		pm.beginTask("", 100); //$NON-NLS-1$
+		SubMonitor subMonitor = SubMonitor.convert(pm, 100);
 
 		// allocate half of the progress bar for each
-		state.localMonitor = new SubProgressMonitor(pm, 50, SubProgressMonitor.SUPPRESS_SUBTASK_LABEL);
-		state.remoteMonitor = new SubProgressMonitor(pm, 50, SubProgressMonitor.SUPPRESS_SUBTASK_LABEL);
+		state.localMonitor = subMonitor.split(50, SubMonitor.SUPPRESS_SUBTASK);
+		state.remoteMonitor = subMonitor.split(50, SubMonitor.SUPPRESS_SUBTASK);
 
 		// start both searches in parallel
 		state.localSearchJob.schedule();
diff --git a/org.eclipse.help.base/src/org/eclipse/help/search/HelpIndexBuilder.java b/org.eclipse.help.base/src/org/eclipse/help/search/HelpIndexBuilder.java
index 097400ab2..776ddb487 100644
--- a/org.eclipse.help.base/src/org/eclipse/help/search/HelpIndexBuilder.java
+++ b/org.eclipse.help.base/src/org/eclipse/help/search/HelpIndexBuilder.java
@@ -37,7 +37,7 @@ import org.eclipse.core.runtime.MultiStatus;
 import org.eclipse.core.runtime.OperationCanceledException;
 import org.eclipse.core.runtime.Platform;
 import org.eclipse.core.runtime.Status;
-import org.eclipse.core.runtime.SubProgressMonitor;
+import org.eclipse.core.runtime.SubMonitor;
 import org.eclipse.help.internal.base.HelpBasePlugin;
 import org.eclipse.help.internal.base.HelpBaseResources;
 import org.eclipse.help.internal.entityresolver.LocalEntityResolver;
@@ -304,14 +304,13 @@ public class HelpIndexBuilder {
 		// compute the dir tree
 		computeLocaleDirs(fid!=null);
 
-		monitor.beginTask(HelpBaseResources.HelpIndexBuilder_buildingIndex, localeDirs.size());
+		SubMonitor subMonitor = SubMonitor.convert(monitor, HelpBaseResources.HelpIndexBuilder_buildingIndex, localeDirs.size());
 		MultiStatus multiStatus = null;
 
 		for (int i=0; i<localeDirs.size(); i++) {
 			// process locale dir
 			LocaleDir localeDir = localeDirs.get(i);
-			MultiStatus localeStatus = processLocaleDir(pid, fid,
-					localeDir, new SubProgressMonitor(monitor, 1, SubProgressMonitor.PREPEND_MAIN_LABEL_TO_SUBTASK));
+			MultiStatus localeStatus = processLocaleDir(pid, fid, localeDir, subMonitor.split(1));
 			if (localeStatus != null) {
 				if (multiStatus == null)
 					multiStatus = localeStatus;
@@ -319,7 +318,7 @@ public class HelpIndexBuilder {
 					multiStatus.addAll(localeStatus);
 			}
 		}
-		monitor.done();
+		subMonitor.done();
 		if (multiStatus != null)
 			throw new CoreException(multiStatus);
 	}
@@ -467,12 +466,8 @@ public class HelpIndexBuilder {
 	 * documents according to the tocs, then building the index.
 	 */
 
-	private MultiStatus processLocaleDir(PluginIdentifier id,
-			PluginIdentifier fid, LocaleDir localeDir, IProgressMonitor monitor)
-			throws CoreException {
-		// build an index for each locale directory
-		String message = NLS.bind(HelpBaseResources.HelpIndexBuilder_indexFor, localeDir.dirs.get(0).getName());
-		monitor.beginTask(message, 5);
+	private MultiStatus processLocaleDir(PluginIdentifier id, PluginIdentifier fid, LocaleDir localeDir,
+			SubMonitor monitor) throws CoreException {
 		File directory = localeDir.dirs.get(0);
 		File indexDirectory = new File(directory, indexPath);
 		prepareDirectory(indexDirectory);
@@ -485,12 +480,9 @@ public class HelpIndexBuilder {
 			IndexerPluginVersionInfo docPlugins = new IndexerPluginVersionInfo(id,
 				fid, indexDirectory);
 			index.setDocPlugins(docPlugins);
-			status = createIndex(id.id, fid!=null, localeDir, index, docs,
-				new SubProgressMonitor(monitor, 5, SubProgressMonitor.PREPEND_MAIN_LABEL_TO_SUBTASK));
+			status = createIndex(id.id, fid != null, localeDir, index, docs, monitor);
 			index.deleteLockFile();
 		}
-		monitor.setTaskName(""); //$NON-NLS-1$
-		monitor.done();
 		return status;
 	}
 
@@ -573,10 +565,12 @@ public class HelpIndexBuilder {
 	 * will be ignored.
 	 */
 
-	private MultiStatus createIndex(String pluginId, boolean fragment, LocaleDir localeDir,
-			SearchIndex index, Collection<String> addedDocs, IProgressMonitor monitor)
+	private MultiStatus createIndex(String pluginId, boolean fragment, LocaleDir localeDir, SearchIndex index,
+			Collection<String> addedDocs, SubMonitor monitor)
 			throws CoreException {
-		monitor.beginTask(HelpBaseResources.UpdatingIndex, addedDocs.size());
+		// build an index for each locale directory
+		String taskName = NLS.bind(HelpBaseResources.HelpIndexBuilder_indexFor, localeDir.dirs.get(0).getName());
+		monitor.beginTask(taskName + HelpBaseResources.UpdatingIndex, addedDocs.size());
 		if (!index.beginAddBatch(true)) {
 			throwCoreException(HelpBaseResources.HelpIndexBuilder_error, null);
 		}
@@ -607,7 +601,7 @@ public class HelpIndexBuilder {
 			checkCancelled(monitor);
 			monitor.worked(1);
 		}
-		monitor.subTask(HelpBaseResources.Writing_index);
+		monitor.subTask(taskName + HelpBaseResources.Writing_index);
 		if (!index.endAddBatch(true, true)) {
 			IStatus status = new Status(IStatus.ERROR, HelpBasePlugin.PLUGIN_ID,
 					IStatus.OK, HelpBaseResources.HelpIndexBuilder_errorWriting, null);
@@ -615,7 +609,6 @@ public class HelpIndexBuilder {
 				multiStatus = createMultiStatus();
 			multiStatus.add(status);
 		}
-		monitor.done();
 		return multiStatus;
 	}