tmf: Deprecate and remove a few things not used in Trace type code

Some methods are never called and are achievable through other means
anyway.

Change-Id: Ifdc248f47b277cec6c00f0bc32a4df4ae862512e
Signed-off-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/85830
Reviewed-by: Hudson CI
Reviewed-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-by: Patrick Tasse <patrick.tasse@gmail.com>
Tested-by: Patrick Tasse <patrick.tasse@gmail.com>

diff --git a/tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/project/model/TmfTraceType.java b/tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/project/model/TmfTraceType.java
index e15a92b5561c7e2e0acba933f80b462c09dc8c91..5cd37293c7385ee37d218238a37467f3cbfb4358 100644 (file)
--- a/tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/project/model/TmfTraceType.java
+++ b/tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/project/model/TmfTraceType.java
@@ -135,7 +135,11 @@ public final class TmfTraceType {
      * @param categoryId
      *            The category ID
      * @return the category name or empty string if not found
+     * @deprecated Use {@link Platform#getExtensionRegistry()} and various
+     *             public constants in {@link TmfTraceType} if achieving this is
+     *             needed.
      */
+    @Deprecated
     public static String getCategoryName(String categoryId) {
         IConfigurationElement[] elements = Platform.getExtensionRegistry()
                 .getConfigurationElementsFor(TMF_TRACE_TYPE_ID);
@@ -152,7 +156,11 @@ public final class TmfTraceType {
      * for the trace type extension that apply to traces and not experiments.
      *
      * @return an array of trace type configuration elements
+     * @deprecated Use {@link Platform#getExtensionRegistry()} and various
+     *             public constants in {@link TmfTraceType} if achieving this is
+     *             needed.
      */
+    @Deprecated
     public static IConfigurationElement[] getTypeElements() {
         IConfigurationElement[] elements = Platform.getExtensionRegistry()
                 .getConfigurationElementsFor(TMF_TRACE_TYPE_ID);
@@ -169,7 +177,10 @@ public final class TmfTraceType {
      * Get an iterable view of the existing trace type IDs.
      *
      * @return The currently registered trace type IDs
+     * @deprecated Use a combination of {@link #getTraceTypeHelpers()} and
+     *             {@link TraceTypeHelper#getTraceTypeId()} instead.
      */
+    @Deprecated
     public static Iterable<String> getTraceTypeIDs() {
         return TRACE_TYPES.keySet();
     }
@@ -230,7 +241,11 @@ public final class TmfTraceType {
      * Gets all the custom trace types
      *
      * @return the list of custom trace types
+     * @deprecated Use {@link CustomTxtTraceDefinition#loadAll()} and
+     *             {@link CustomXmlTraceDefinition#loadAll()} if achieving this
+     *             is needed.
      */
+    @Deprecated
     public static List<String> getCustomTraceTypes() {
 
         List<String> traceTypes = new ArrayList<>();
@@ -413,7 +428,11 @@ public final class TmfTraceType {
      * Returns the list of trace categories
      *
      * @return the list of trace categories
+     * @deprecated Use {@link #getTraceTypeHelpers()} and
+     *             {@link TraceTypeHelper#getCategoryName()} to retrieve all
+     *             category names.
      */
+    @Deprecated
     public static List<String> getTraceCategories() {
         List<String> categoryNames = new ArrayList<>();
         for (TraceTypeHelper helper : TRACE_TYPES.values()) {
@@ -432,7 +451,11 @@ public final class TmfTraceType {
      * @param categoryName
      *            the categoryName to lookup
      * @return a list of trace type helper classes {@link TraceTypeHelper}
+     * @deprecated Use {@link #getTraceTypeHelpers()} and
+     *             {@link TraceTypeHelper#getCategoryName()} to retrieve all
+     *             category names.
      */
+    @Deprecated
     public static List<TraceTypeHelper> getTraceTypes(String categoryName) {
         List<TraceTypeHelper> traceNames = new ArrayList<>();
         for (TraceTypeHelper traceTypeHelper : TRACE_TYPES.values()) {
@@ -454,7 +477,11 @@ public final class TmfTraceType {
      * @param fileName
      *            the file name (and path)
      * @return true if the trace is of a valid type
+     * @deprecated Use TmfTraceType.getTraceTypeHelpers and
+     *             {@link TraceTypeHelper#validate(String)} or
+     *             {@link TraceTypeHelper#validateWithConfidence(String)}
      */
+    @Deprecated
     public static boolean validate(String traceTypeName, String fileName) {
         if (traceTypeName != null && !traceTypeName.isEmpty()) {
             final TraceTypeHelper traceTypeHelper = TRACE_TYPES.get(traceTypeName);
@@ -471,7 +498,11 @@ public final class TmfTraceType {
      * @param traceToValidate
      *            the trace category (canonical name)
      * @return true if the trace is of a valid type
+     * @deprecated Use TmfTraceType.getTraceTypeHelpers and
+     *             {@link TraceTypeHelper#validate(String)} or
+     *             {@link TraceTypeHelper#validateWithConfidence(String)}
      */
+    @Deprecated
     public static boolean validate(TraceValidationHelper traceToValidate) {
         return validate(traceToValidate.getTraceType(), traceToValidate.getTraceToScan());
     }

diff --git a/tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/project/model/TraceValidationHelper.java b/tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/project/model/TraceValidationHelper.java
index dc9efae8720087ec9eea6f53790eb0a1ccfc9f80..29ce22be8f76ef35ad1910490808f01c0326ea0c 100644 (file)
--- a/tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/project/model/TraceValidationHelper.java
+++ b/tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/project/model/TraceValidationHelper.java
@@ -18,7 +18,11 @@ import java.util.Objects;
  * Trace import helper class
  *
  * @author Matthew Khouzam
+ * @deprecated Use TmfTraceType.getTraceTypeHelpers and
+ *             {@link TraceTypeHelper#validate(String)} or
+ *             {@link TraceTypeHelper#validateWithConfidence(String)}
  */
+@Deprecated
 public class TraceValidationHelper implements Comparable<TraceValidationHelper> {
 
     private final String fTraceToScan;

diff --git a/tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/internal/tmf/ui/project/wizards/importtrace/TraceTypeContentProvider.java b/tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/internal/tmf/ui/project/wizards/importtrace/TraceTypeContentProvider.java
deleted file mode 100644 (file)
index a79c1cb..0000000
--- a/tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/internal/tmf/ui/project/wizards/importtrace/TraceTypeContentProvider.java
+++ /dev/null
@@ -1,100 +0,0 @@
-/*******************************************************************************
- * Copyright (c) 2013, 2014 Ericsson
- *
- * 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:
- *   Matthew Khouzam - Initial API and implementation
- *******************************************************************************/
-
-package org.eclipse.tracecompass.internal.tmf.ui.project.wizards.importtrace;
-
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import org.eclipse.jface.viewers.ITreeContentProvider;
-import org.eclipse.jface.viewers.Viewer;
-import org.eclipse.tracecompass.tmf.core.project.model.TmfTraceType;
-import org.eclipse.tracecompass.tmf.core.project.model.TraceTypeHelper;
-
-/**
- * Trace type content provider, a helper for showing trace types
- *
- * @author Matthew Khouzam
- */
-public class TraceTypeContentProvider implements ITreeContentProvider {
-
-    private final List<String> fTraceCategory = new ArrayList<>();
-    private final Map<String, List<TraceTypeHelper>> fTraceType = new HashMap<>();
-
-    /**
-     * Default Constructor
-     */
-    public TraceTypeContentProvider() {
-        fTraceType.clear();
-        fTraceCategory.clear();
-
-        for (String category : TmfTraceType.getTraceCategories()) {
-            List<TraceTypeHelper> value = TmfTraceType.getTraceTypes(category);
-            if (!value.isEmpty()) {
-                fTraceCategory.add(category);
-                fTraceType.put(category, value);
-            }
-        }
-    }
-
-    @Override
-    public void dispose() {
-    }
-
-    @Override
-    public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {
-        // Do nothing
-    }
-
-    @Override
-    public Object[] getElements(Object inputElement) {
-        return fTraceCategory.toArray(new String[0]);
-    }
-
-    @Override
-    public Object[] getChildren(Object parentElement) {
-        if (parentElement instanceof String) {
-            final List<TraceTypeHelper> children = fTraceType.get(parentElement);
-            if (children != null) {
-                return children.toArray(new TraceTypeHelper[0]);
-            }
-        }
-        return null;
-    }
-
-    @Override
-    public Object getParent(Object element) {
-        if (element instanceof TraceTypeHelper) {
-            for (String key : fTraceCategory) {
-                List<TraceTypeHelper> traceSet = fTraceType.get(key);
-                if (traceSet != null) {
-                    if (traceSet.contains(element)) {
-                        return key;
-                    }
-                }
-            }
-        }
-        return null;
-    }
-
-    @Override
-    public boolean hasChildren(Object element) {
-        if (element instanceof String) {
-            String key = (String) element;
-            return fTraceType.containsKey(key);
-        }
-        return false;
-    }
-
-}