TMF: Make the ITmfEvent#getTimestamp() return NonNull

And all the required NonNull annotations to fix all the warnings

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

8 files changed, 29 insertions, 35 deletions

diff --git a/org.eclipse.tracecompass.tmf.core.tests/src/org/eclipse/tracecompass/tmf/core/tests/event/TmfEventTest.java b/org.eclipse.tracecompass.tmf.core.tests/src/org/eclipse/tracecompass/tmf/core/tests/event/TmfEventTest.java
index 1b7c7526e9..07f47b5c31 100644
--- a/org.eclipse.tracecompass.tmf.core.tests/src/org/eclipse/tracecompass/tmf/core/tests/event/TmfEventTest.java
+++ b/org.eclipse.tracecompass.tmf.core.tests/src/org/eclipse/tracecompass/tmf/core/tests/event/TmfEventTest.java
@@ -92,7 +92,7 @@ public class TmfEventTest {
         final ITmfEvent event = new TmfEvent(fTrace, ITmfContext.UNKNOWN_RANK, null, null, null);
         assertNotNull("getTrace", event.getTrace());
         assertEquals("getRank", ITmfContext.UNKNOWN_RANK, event.getRank());
-        assertNull("getTimestamp", event.getTimestamp());
+        assertEquals("getTimestamp", TmfTimestamp.ZERO, event.getTimestamp());
         assertNull("getType", event.getType());
         assertNull("getContent", event.getContent());
     }
diff --git a/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/event/ITmfEvent.java b/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/event/ITmfEvent.java
index b6ec6710a0..6f39e5c30e 100644
--- a/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/event/ITmfEvent.java
+++ b/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/event/ITmfEvent.java
@@ -55,7 +55,7 @@ public interface ITmfEvent extends IAdaptable {
      * @return the event timestamp
      * @since 2.0
      */
-    ITmfTimestamp getTimestamp();
+    @NonNull ITmfTimestamp getTimestamp();
 
     /**
      * @return the event type
diff --git a/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/event/TmfEvent.java b/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/event/TmfEvent.java
index 91a3101864..1fc6f77f49 100644
--- a/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/event/TmfEvent.java
+++ b/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/event/TmfEvent.java
@@ -16,6 +16,7 @@ package org.eclipse.tracecompass.tmf.core.event;
 import org.eclipse.core.runtime.PlatformObject;
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimestamp;
+import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestamp;
 import org.eclipse.tracecompass.tmf.core.trace.ITmfContext;
 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
 
@@ -38,7 +39,7 @@ public class TmfEvent extends PlatformObject implements ITmfEvent {
 
     private final ITmfTrace fTrace;
     private final long fRank;
-    private final ITmfTimestamp fTimestamp;
+    private final @NonNull ITmfTimestamp fTimestamp;
     private final ITmfEventType fType;
     private final ITmfEventField fContent;
 
@@ -82,7 +83,11 @@ public class TmfEvent extends PlatformObject implements ITmfEvent {
             final ITmfEventField content) {
         fTrace = trace;
         fRank = rank;
-        fTimestamp = timestamp;
+        if (timestamp != null) {
+            fTimestamp = timestamp;
+        } else {
+            fTimestamp = TmfTimestamp.ZERO;
+        }
         fType = type;
         fContent = content;
     }
@@ -146,7 +151,7 @@ public class TmfEvent extends PlatformObject implements ITmfEvent {
         int result = 1;
         result = prime * result + ((fTrace == null) ? 0 : fTrace.hashCode());
         result = prime * result + (int) (fRank ^ (fRank >>> 32));
-        result = prime * result + ((fTimestamp == null) ? 0 : fTimestamp.hashCode());
+        result = prime * result + fTimestamp.hashCode();
         result = prime * result + ((fType == null) ? 0 : fType.hashCode());
         result = prime * result + ((fContent == null) ? 0 : fContent.hashCode());
         return result;
@@ -174,11 +179,7 @@ public class TmfEvent extends PlatformObject implements ITmfEvent {
         if (fRank != other.fRank) {
             return false;
         }
-        if (fTimestamp == null) {
-            if (other.fTimestamp != null) {
-                return false;
-            }
-        } else if (!fTimestamp.equals(other.fTimestamp)) {
+        if (!fTimestamp.equals(other.fTimestamp)) {
             return false;
         }
         if (fType == null) {
diff --git a/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/parsers/custom/CustomEvent.java b/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/parsers/custom/CustomEvent.java
index f8f03f71e6..4076e55c6c 100644
--- a/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/parsers/custom/CustomEvent.java
+++ b/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/parsers/custom/CustomEvent.java
@@ -45,7 +45,7 @@ public class CustomEvent extends TmfEvent {
     protected static final String NO_MESSAGE = ""; //$NON-NLS-1$
 
     /** Replacement for the super-class' timestamp field */
-    private ITmfTimestamp customEventTimestamp;
+    private @NonNull ITmfTimestamp customEventTimestamp;
 
     /** Replacement for the super-class' content field */
     private ITmfEventField customEventContent;
@@ -71,6 +71,7 @@ public class CustomEvent extends TmfEvent {
         super(null, ITmfContext.UNKNOWN_RANK, null, null, null);
         fDefinition = definition;
         fData = new HashMap<>();
+        customEventTimestamp = TmfTimestamp.ZERO;
     }
 
     /**
@@ -112,7 +113,11 @@ public class CustomEvent extends TmfEvent {
         fData = new HashMap<>();
 
         /* Set our overridden fields */
-        customEventTimestamp = timestamp;
+        if (timestamp == null) {
+            customEventTimestamp = TmfTimestamp.ZERO;
+        } else {
+            customEventTimestamp = timestamp;
+        }
         customEventContent = null;
         customEventType = type;
     }
@@ -149,7 +154,7 @@ public class CustomEvent extends TmfEvent {
      * @param timestamp
      *            The new timestamp
      */
-    protected void setTimestamp(ITmfTimestamp timestamp) {
+    protected void setTimestamp(@NonNull ITmfTimestamp timestamp) {
         customEventTimestamp = timestamp;
     }
 
@@ -235,7 +240,7 @@ public class CustomEvent extends TmfEvent {
         final int prime = 31;
         int result = super.hashCode();
         result = prime * result + ((fDefinition == null) ? 0 : fDefinition.hashCode());
-        result = prime * result + ((customEventTimestamp == null) ? 0 : customEventTimestamp.hashCode());
+        result = prime * result + customEventTimestamp.hashCode();
         result = prime * result + ((customEventContent == null) ? 0 : customEventContent.hashCode());
         result = prime * result + ((customEventType == null) ? 0 : customEventType.hashCode());
         return result;
@@ -261,11 +266,7 @@ public class CustomEvent extends TmfEvent {
             return false;
         }
 
-        if (customEventTimestamp == null) {
-            if (other.customEventTimestamp != null) {
-                return false;
-            }
-        } else if (!customEventTimestamp.equals(other.customEventTimestamp)) {
+        if (!customEventTimestamp.equals(other.customEventTimestamp)) {
             return false;
         }
 
diff --git a/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestamp.java b/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestamp.java
index 4e39d52055..b754a8add5 100644
--- a/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestamp.java
+++ b/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestamp.java
@@ -17,6 +17,8 @@ package org.eclipse.tracecompass.tmf.core.timestamp;
 
 import java.nio.ByteBuffer;
 
+import org.eclipse.jdt.annotation.NonNull;
+
 /**
  * A generic timestamp implementation. The timestamp is represented by the
  * tuple { value, scale, precision }. By default, timestamps are scaled in
@@ -34,29 +36,19 @@ public class TmfTimestamp implements ITmfTimestamp {
     /**
      * The beginning of time
      */
-    public static final ITmfTimestamp BIG_BANG =
+    public static final @NonNull ITmfTimestamp BIG_BANG =
             new TmfTimestamp(Long.MIN_VALUE, Integer.MAX_VALUE);
 
     /**
      * The end of time
      */
-    public static final ITmfTimestamp BIG_CRUNCH =
+    public static final @NonNull ITmfTimestamp BIG_CRUNCH =
             new TmfTimestamp(Long.MAX_VALUE, Integer.MAX_VALUE);
 
     /**
-     * A more practical definition of "beginning of time"
-     */
-    public static final ITmfTimestamp PROJECT_IS_FUNDED = BIG_BANG;
-
-    /**
-     * A more practical definition of "end of time"
-     */
-    public static final ITmfTimestamp PROJECT_IS_CANNED = BIG_CRUNCH;
-
-    /**
      * Zero
      */
-    public static final ITmfTimestamp ZERO =
+    public static final @NonNull ITmfTimestamp ZERO =
             new TmfTimestamp(0, 0);
 
     // ------------------------------------------------------------------------
diff --git a/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/trace/experiment/TmfExperiment.java b/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/trace/experiment/TmfExperiment.java
index d775673352..8af64480d1 100644
--- a/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/trace/experiment/TmfExperiment.java
+++ b/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/trace/experiment/TmfExperiment.java
@@ -419,7 +419,7 @@ public class TmfExperiment extends TmfTrace implements ITmfPersistentlyIndexable
         for (int i = 0; i < length; i++) {
             final ITmfEvent event = expContext.getEvent(i);
 
-            if (event != null && event.getTimestamp() != null) {
+            if (event != null) {
                 final ITmfTimestamp otherTS = event.getTimestamp();
                 if (otherTS.compareTo(timestamp) < 0) {
                     trace = i;
diff --git a/org.eclipse.tracecompass.tmf.ctf.core.tests/src/org/eclipse/tracecompass/tmf/ctf/core/tests/event/CtfTmfLostEventsTest.java b/org.eclipse.tracecompass.tmf.ctf.core.tests/src/org/eclipse/tracecompass/tmf/ctf/core/tests/event/CtfTmfLostEventsTest.java
index 04e4fd7eca..7d1af7dd06 100644
--- a/org.eclipse.tracecompass.tmf.ctf.core.tests/src/org/eclipse/tracecompass/tmf/ctf/core/tests/event/CtfTmfLostEventsTest.java
+++ b/org.eclipse.tracecompass.tmf.ctf.core.tests/src/org/eclipse/tracecompass/tmf/ctf/core/tests/event/CtfTmfLostEventsTest.java
@@ -212,7 +212,7 @@ public class CtfTmfLostEventsTest {
 
         public OneEventRequestPerTs(ITmfTimestamp ts) {
             super(CtfTmfEvent.class,
-                    new TmfTimeRange(ts, TmfTimestamp.PROJECT_IS_CANNED),
+                    new TmfTimeRange(ts, TmfTimestamp.BIG_CRUNCH),
                     0, 1, ExecutionType.FOREGROUND);
         }
 
diff --git a/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/viewers/events/TmfEventPropertySource.java b/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/viewers/events/TmfEventPropertySource.java
index 94a0ed37c9..eb90396c2c 100644
--- a/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/viewers/events/TmfEventPropertySource.java
+++ b/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/viewers/events/TmfEventPropertySource.java
@@ -306,7 +306,7 @@ public class TmfEventPropertySource implements IPropertySource {
 
     @Override
     public Object getPropertyValue(Object id) {
-        if (id.equals(ID_TIMESTAMP) && fEvent.getTimestamp() != null) {
+        if (id.equals(ID_TIMESTAMP)) {
             return new TimestampPropertySource(fEvent.getTimestamp());
         } else if (id.equals(ID_TYPE) && fEvent.getType() != null) {
             return fEvent.getType().toString();