tmf: Add missing Javadoc to tmf.ui

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / internal / tmf / ui / parsers / custom / CustomTraceDefinition.java

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomTraceDefinition.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomTraceDefinition.java
index ef947757581b31cfb8bbdd88f8936b952de2e47e..af367f2df8490c8d9cf0de7eae22623abcee1031 100644 (file)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomTraceDefinition.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomTraceDefinition.java
@@ -18,26 +18,58 @@ import java.util.List;
 import org.eclipse.linuxtools.internal.tmf.ui.Messages;
 import org.eclipse.linuxtools.tmf.core.event.TmfTimestamp;
 
-
+/**
+ * Base class for custom trace definitions.
+ *
+ * @author Patrick Tassé
+ */
 public abstract class CustomTraceDefinition {
 
+    /** "set" action */
     public static final int ACTION_SET = 0;
+
+    /** "append" action */
     public static final int ACTION_APPEND = 1;
+
+    /** "append with separator" action */
     public static final int ACTION_APPEND_WITH_SEPARATOR = 2;
 
+    /** Timestamp tag */
     public static final String TAG_TIMESTAMP = Messages.CustomTraceDefinition_timestampTag;
+
+    /** Message tag */
     public static final String TAG_MESSAGE = Messages.CustomTraceDefinition_messageTag;
+
+    /** "Other" tag */
     public static final String TAG_OTHER = Messages.CustomTraceDefinition_otherTag;
 
+    /** Name of this trace definition */
     public String definitionName;
+
+    /** List of output columns */
     public List<OutputColumn> outputs;
+
+    /** Timestamp format */
     public String timeStampOutputFormat;
 
+    /**
+     * Definition of an output column
+     */
     public static class OutputColumn {
+
+        /** Name of this column */
         public String name;
 
+        /**
+         * Default constructor (empty)
+         */
         public OutputColumn() {}
 
+        /**
+         * Constructor
+         *
+         * @param name Name of this output column
+         */
         public OutputColumn(String name) {
             this.name = name;
         }
@@ -48,11 +80,28 @@ public abstract class CustomTraceDefinition {
         }
     }
 
+    /**
+     * Format a timestamp in this trace's current time stamp format.
+     *
+     * @param timestamp
+     *            The timestamp to format
+     * @return The same timestamp as a formatted string
+     */
     public String formatTimeStamp(TmfTimestamp timestamp) {
         SimpleDateFormat simpleDateFormat = new SimpleDateFormat(timeStampOutputFormat);
         return simpleDateFormat.format(timestamp.getValue());
     }
 
+    /**
+     * Save this custom trace in the default path.
+     */
     public abstract void save();
+
+    /**
+     * Save this custom trace in the supplied path.
+     *
+     * @param path
+     *            The path to save to
+     */
     public abstract void save(String path);
 }