TMF: Add some @NonNull annotations to the AbstractTimeGraphView

Change-Id: I772295648eabab3ec3aec16365989478c32e7eff
Signed-off-by: Geneviève Bastien <gbastien+lttng@versatic.net>
Reviewed-on: https://git.eclipse.org/r/35845
Tested-by: Hudson CI
Reviewed-by: Patrick Tasse <patrick.tasse@gmail.com>
Reviewed-by: Matthew Khouzam <matthew.khouzam@ericsson.com>

diff --git a/org.eclipse.tracecompass.lttng2.kernel.ui/src/org/eclipse/tracecompass/internal/lttng2/kernel/ui/views/controlflow/ControlFlowView.java b/org.eclipse.tracecompass.lttng2.kernel.ui/src/org/eclipse/tracecompass/internal/lttng2/kernel/ui/views/controlflow/ControlFlowView.java
index f0d9072f3894a72a48a0517974b2b820cf442ce5..15e85daf1510d70e7e0ac1d025c0e079a0082a2d 100644 (file)
--- a/org.eclipse.tracecompass.lttng2.kernel.ui/src/org/eclipse/tracecompass/internal/lttng2/kernel/ui/views/controlflow/ControlFlowView.java
+++ b/org.eclipse.tracecompass.lttng2.kernel.ui/src/org/eclipse/tracecompass/internal/lttng2/kernel/ui/views/controlflow/ControlFlowView.java
@@ -20,6 +20,7 @@ import java.util.List;
 import java.util.Map;
 
 import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
 import org.eclipse.jface.action.IAction;
 import org.eclipse.jface.action.IToolBarManager;
@@ -223,9 +224,6 @@ public class ControlFlowView extends AbstractTimeGraphView {
 
     @Override
     protected void buildEventList(final ITmfTrace trace, ITmfTrace parentTrace, IProgressMonitor monitor) {
-        if (trace == null) {
-            return;
-        }
         ITmfStateSystem ssq = TmfStateSystemAnalysisModule.getStateSystem(trace, LttngKernelAnalysis.ID);
         if (ssq == null) {
             return;
@@ -374,7 +372,7 @@ public class ControlFlowView extends AbstractTimeGraphView {
         removeFromEntryList(parentTrace, rootListToRemove);
     }
 
-    private void buildStatusEvents(ITmfTrace trace, ControlFlowEntry entry, IProgressMonitor monitor, long start, long end) {
+    private void buildStatusEvents(ITmfTrace trace, ControlFlowEntry entry, @NonNull IProgressMonitor monitor, long start, long end) {
         if (start < entry.getEndTime() && end > entry.getStartTime()) {
             ITmfStateSystem ssq = TmfStateSystemAnalysisModule.getStateSystem(entry.getTrace(), LttngKernelAnalysis.ID);
             if (ssq == null) {

diff --git a/org.eclipse.tracecompass.lttng2.kernel.ui/src/org/eclipse/tracecompass/internal/lttng2/kernel/ui/views/resources/ResourcesView.java b/org.eclipse.tracecompass.lttng2.kernel.ui/src/org/eclipse/tracecompass/internal/lttng2/kernel/ui/views/resources/ResourcesView.java
index 3013a8e6d4ee010579b2778a0119cb26afce59dd..4430db3994f22b3f45b7ad2549ccb2f530e2bbe5 100644 (file)
--- a/org.eclipse.tracecompass.lttng2.kernel.ui/src/org/eclipse/tracecompass/internal/lttng2/kernel/ui/views/resources/ResourcesView.java
+++ b/org.eclipse.tracecompass.lttng2.kernel.ui/src/org/eclipse/tracecompass/internal/lttng2/kernel/ui/views/resources/ResourcesView.java
@@ -97,9 +97,6 @@ public class ResourcesView extends AbstractTimeGraphView {
 
     @Override
     protected void buildEventList(ITmfTrace trace, ITmfTrace parentTrace, IProgressMonitor monitor) {
-        if (trace == null) {
-            return;
-        }
         ITmfStateSystem ssq = TmfStateSystemAnalysisModule.getStateSystem(trace, LttngKernelAnalysis.ID);
         if (ssq == null) {
             return;

diff --git a/org.eclipse.tracecompass.tmf.analysis.xml.ui/src/org/eclipse/tracecompass/tmf/analysis/xml/ui/views/timegraph/XmlTimeGraphView.java b/org.eclipse.tracecompass.tmf.analysis.xml.ui/src/org/eclipse/tracecompass/tmf/analysis/xml/ui/views/timegraph/XmlTimeGraphView.java
index 7305f35183eb711f5ee68264b765a20e7d41079d..6a842a6273c2c43b0cc509edc1bc7a43f6a33942 100644 (file)
--- a/org.eclipse.tracecompass.tmf.analysis.xml.ui/src/org/eclipse/tracecompass/tmf/analysis/xml/ui/views/timegraph/XmlTimeGraphView.java
+++ b/org.eclipse.tracecompass.tmf.analysis.xml.ui/src/org/eclipse/tracecompass/tmf/analysis/xml/ui/views/timegraph/XmlTimeGraphView.java
@@ -424,7 +424,7 @@ public class XmlTimeGraphView extends AbstractTimeGraphView {
                 entryStart, entryEnd, EntryDisplayType.DISPLAY, ss, entryElement);
     }
 
-    private void buildStatusEvent(XmlEntry traceEntry, IProgressMonitor monitor, long start, long end) {
+    private void buildStatusEvent(XmlEntry traceEntry, @NonNull IProgressMonitor monitor, long start, long end) {
         long resolution = (end - start) / getDisplayWidth();
         long startTime = Math.max(start, traceEntry.getStartTime());
         long endTime = Math.min(end + 1, traceEntry.getEndTime());

diff --git a/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/views/timegraph/AbstractTimeGraphView.java b/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/views/timegraph/AbstractTimeGraphView.java
index 6518c0e1fad90f6ae7b2e1b9584f301b812c01c6..d4b77e0fe1443af5e09aca96fd4fc6f029cbc025 100644 (file)
--- a/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/views/timegraph/AbstractTimeGraphView.java
+++ b/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/views/timegraph/AbstractTimeGraphView.java
@@ -27,6 +27,7 @@ import java.util.concurrent.CopyOnWriteArrayList;
 
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.core.runtime.NullProgressMonitor;
+import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
 import org.eclipse.jface.action.Action;
 import org.eclipse.jface.action.IAction;
@@ -461,11 +462,11 @@ public abstract class AbstractTimeGraphView extends TmfView {
     }
 
     private class BuildThread extends Thread {
-        private final ITmfTrace fBuildTrace;
-        private final ITmfTrace fParentTrace;
-        private final IProgressMonitor fMonitor;
+        private final @NonNull ITmfTrace fBuildTrace;
+        private final @NonNull ITmfTrace fParentTrace;
+        private final @NonNull IProgressMonitor fMonitor;
 
-        public BuildThread(final ITmfTrace trace, final ITmfTrace parentTrace, final String name) {
+        public BuildThread(final @NonNull ITmfTrace trace, final @NonNull ITmfTrace parentTrace, final String name) {
             super(name + " build"); //$NON-NLS-1$
             fBuildTrace = trace;
             fParentTrace = parentTrace;
@@ -486,13 +487,13 @@ public abstract class AbstractTimeGraphView extends TmfView {
     }
 
     private class ZoomThread extends Thread {
-        private final List<TimeGraphEntry> fZoomEntryList;
+        private final @NonNull List<TimeGraphEntry> fZoomEntryList;
         private final long fZoomStartTime;
         private final long fZoomEndTime;
         private final long fResolution;
-        private final IProgressMonitor fMonitor;
+        private final @NonNull  IProgressMonitor fMonitor;
 
-        public ZoomThread(List<TimeGraphEntry> entryList, long startTime, long endTime, String name) {
+        public ZoomThread(@NonNull List<TimeGraphEntry> entryList, long startTime, long endTime, String name) {
             super(name + " zoom"); //$NON-NLS-1$
             fZoomEntryList = entryList;
             fZoomStartTime = startTime;
@@ -503,13 +504,13 @@ public abstract class AbstractTimeGraphView extends TmfView {
 
         @Override
         public void run() {
-            if (fZoomEntryList == null) {
-                return;
-            }
             for (TimeGraphEntry entry : fZoomEntryList) {
                 if (fMonitor.isCanceled()) {
                     return;
                 }
+                if (entry == null) {
+                    break;
+                }
                 zoom(entry, fMonitor);
             }
             /* Refresh the arrows when zooming */
@@ -520,7 +521,7 @@ public abstract class AbstractTimeGraphView extends TmfView {
             }
         }
 
-        private void zoom(TimeGraphEntry entry, IProgressMonitor monitor) {
+        private void zoom(@NonNull TimeGraphEntry entry, @NonNull IProgressMonitor monitor) {
             if (fZoomStartTime <= fStartTime && fZoomEndTime >= fEndTime) {
                 entry.setZoomedEventList(null);
             } else {
@@ -893,9 +894,6 @@ public abstract class AbstractTimeGraphView extends TmfView {
                 final long endTime = event.getEndTime();
                 TmfTimeRange range = new TmfTimeRange(new TmfNanoTimestamp(startTime), new TmfNanoTimestamp(endTime));
                 broadcast(new TmfRangeSynchSignal(AbstractTimeGraphView.this, range));
-                if (fZoomThread != null) {
-                    fZoomThread.cancel();
-                }
                 startZoomThread(startTime, endTime);
             }
         });
@@ -1089,9 +1087,16 @@ public abstract class AbstractTimeGraphView extends TmfView {
         setStartTime(Long.MAX_VALUE);
         setEndTime(Long.MIN_VALUE);
         refresh();
+        ITmfTrace viewTrace = fTrace;
+        if (viewTrace == null) {
+            return;
+        }
         synchronized (fBuildThreadMap) {
-            for (ITmfTrace trace : getTracesToBuild(fTrace)) {
-                BuildThread buildThread = new BuildThread(trace, fTrace, getName());
+            for (ITmfTrace trace : getTracesToBuild(viewTrace)) {
+                if (trace == null) {
+                    break;
+                }
+                BuildThread buildThread = new BuildThread(trace, viewTrace, getName());
                 fBuildThreadMap.put(trace, buildThread);
                 buildThread.start();
             }
@@ -1122,8 +1127,10 @@ public abstract class AbstractTimeGraphView extends TmfView {
      * @return List of traces with data to display
      * @since 3.0
      */
-    protected Iterable<ITmfTrace> getTracesToBuild(ITmfTrace trace) {
-        return Arrays.asList(TmfTraceManager.getTraceSet(trace));
+    protected @NonNull Iterable<ITmfTrace> getTracesToBuild(@NonNull ITmfTrace trace) {
+        @SuppressWarnings("null")
+        @NonNull List<ITmfTrace> list = Arrays.asList(TmfTraceManager.getTraceSet(trace));
+        return list;
     }
 
     /**
@@ -1139,7 +1146,7 @@ public abstract class AbstractTimeGraphView extends TmfView {
      *            The progress monitor object
      * @since 3.0
      */
-    protected abstract void buildEventList(ITmfTrace trace, ITmfTrace parentTrace, IProgressMonitor monitor);
+    protected abstract void buildEventList(@NonNull ITmfTrace trace, @NonNull ITmfTrace parentTrace, @NonNull IProgressMonitor monitor);
 
     /**
      * Gets the list of event for an entry in a given timerange
@@ -1156,9 +1163,9 @@ public abstract class AbstractTimeGraphView extends TmfView {
      *            The progress monitor object
      * @return The list of events for the entry
      */
-    protected abstract @Nullable List<ITimeEvent> getEventList(TimeGraphEntry entry,
+    protected abstract @Nullable List<ITimeEvent> getEventList(@NonNull TimeGraphEntry entry,
             long startTime, long endTime, long resolution,
-            IProgressMonitor monitor);
+            @NonNull IProgressMonitor monitor);
 
     /**
      * Gets the list of links (displayed as arrows) for a trace in a given
@@ -1175,8 +1182,8 @@ public abstract class AbstractTimeGraphView extends TmfView {
      * @return The list of link events
      * @since 2.1
      */
-    protected List<ILinkEvent> getLinkList(long startTime, long endTime,
-            long resolution, IProgressMonitor monitor) {
+    protected @Nullable List<ILinkEvent> getLinkList(long startTime, long endTime,
+            long resolution, @NonNull IProgressMonitor monitor) {
         return new ArrayList<>();
     }
 
@@ -1270,7 +1277,11 @@ public abstract class AbstractTimeGraphView extends TmfView {
         if (fZoomThread != null) {
             fZoomThread.cancel();
         }
-        fZoomThread = new ZoomThread(fEntryList, startTime, endTime, getName());
+        final List<TimeGraphEntry> entryList = fEntryList;
+        if (entryList == null) {
+            return;
+        }
+        fZoomThread = new ZoomThread(entryList, startTime, endTime, getName());
         fZoomThread.start();
     }
 

diff --git a/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/widgets/timegraph/TimeGraphCombo.java b/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/widgets/timegraph/TimeGraphCombo.java
index d99d2820412256ff598667553b3e55f6448ba58b..d0d20820dd5ff8ae192f17cd153a803802389277 100644 (file)
--- a/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/widgets/timegraph/TimeGraphCombo.java
+++ b/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/widgets/timegraph/TimeGraphCombo.java
@@ -22,6 +22,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
+import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jface.action.Action;
 import org.eclipse.jface.viewers.AbstractTreeViewer;
 import org.eclipse.jface.viewers.ILabelProviderListener;
@@ -95,7 +96,7 @@ public class TimeGraphCombo extends Composite {
     private TreeViewer fTreeViewer;
 
     /** The time viewer */
-    private TimeGraphViewer fTimeGraphViewer;
+    private @NonNull TimeGraphViewer fTimeGraphViewer;
 
     /** The selection listener map */
     private final Map<ITimeGraphSelectionListener, SelectionListenerWrapper> fSelectionListenerMap = new HashMap<>();
@@ -640,7 +641,7 @@ public class TimeGraphCombo extends Composite {
      *
      * @return the time graph viewer
      */
-    public TimeGraphViewer getTimeGraphViewer() {
+    public @NonNull TimeGraphViewer getTimeGraphViewer() {
         return fTimeGraphViewer;
     }