Refactor TmfCheckpoint and dependencies (+JUnits)

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / trace / TmfCheckpoint.java

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfCheckpoint.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfCheckpoint.java
index 675f1899f613ce894bef5b904786eb0c6351d94f..d0c4690dfda1cf544d39edfb85ba9f6f542e4524 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfCheckpoint.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfCheckpoint.java
@@ -86,19 +86,19 @@ public class TmfCheckpoint implements ITmfCheckpoint {
     }
 
     // ------------------------------------------------------------------------
-    // Accessors
+    // ITmfCheckpoint
     // ------------------------------------------------------------------------
 
-    /**
-     * @return the checkpoint timestamp
+    /* (non-Javadoc)
+     * @see org.eclipse.linuxtools.tmf.core.trace.ITmfCheckpoint#getTimestamp()
      */
     @Override
     public ITmfTimestamp getTimestamp() {
         return fTimestamp;
     }
 
-    /**
-     * @return the checkpoint stream location
+    /* (non-Javadoc)
+     * @see org.eclipse.linuxtools.tmf.core.trace.ITmfCheckpoint#getLocation()
      */
     @Override
     public ITmfLocation<?> getLocation() {
@@ -109,6 +109,12 @@ public class TmfCheckpoint implements ITmfCheckpoint {
     // Comparable
     // ------------------------------------------------------------------------
 
+    /* (non-Javadoc)
+     * @see org.eclipse.linuxtools.tmf.core.trace.ITmfCheckpoint#compareTo(org.eclipse.linuxtools.tmf.core.trace.ITmfCheckpoint)
+     * 
+     * Compares the checkpoints timestamp. If either is null, compares the
+     * trace checkpoints locations.
+     */
     @Override
     @SuppressWarnings({ "unchecked", "rawtypes" })
     public int compareTo(final ITmfCheckpoint other) {
@@ -124,6 +130,9 @@ public class TmfCheckpoint implements ITmfCheckpoint {
     // Object
     // ------------------------------------------------------------------------
 
+    /* (non-Javadoc)
+     * @see java.lang.Object#hashCode()
+     */
     @Override
     public int hashCode() {
         final int prime = 31;
@@ -133,6 +142,9 @@ public class TmfCheckpoint implements ITmfCheckpoint {
         return result;
     }
 
+    /* (non-Javadoc)
+     * @see java.lang.Object#equals(java.lang.Object)
+     */
     @Override
     public boolean equals(final Object obj) {
         if (this == obj)
@@ -155,6 +167,9 @@ public class TmfCheckpoint implements ITmfCheckpoint {
         return true;
     }
 
+    /* (non-Javadoc)
+     * @see java.lang.Object#toString()
+     */
     @Override
     @SuppressWarnings("nls")
     public String toString() {