tmf: Update copyright headers in tmf.ui

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

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomXmlEvent.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomXmlEvent.java
index 6efe4b42cf5a75f841064661aab9040981a991cf..0b68807f3836f9a5ade7fc0f0f2446012e1b2e9f 100644 (file)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomXmlEvent.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/internal/tmf/ui/parsers/custom/CustomXmlEvent.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2010 Ericsson
+ * Copyright (c) 2010, 2013 Ericsson
  *
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License v1.0 which
@@ -13,22 +13,57 @@
 package org.eclipse.linuxtools.internal.tmf.ui.parsers.custom;
 
 import org.eclipse.linuxtools.tmf.core.event.ITmfEventField;
-import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
 import org.eclipse.linuxtools.tmf.core.event.TmfEvent;
 import org.eclipse.linuxtools.tmf.core.event.TmfEventType;
+import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp;
 import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;
 
+/**
+ * Trace event for custom XML traces.
+ *
+ * @author Patrick Tassé
+ */
 public class CustomXmlEvent extends CustomEvent {
 
+    /**
+     * Constructor defining only the trace definition
+     *
+     * @param definition
+     *            Trace definition
+     */
     public CustomXmlEvent(CustomXmlTraceDefinition definition) {
         super(definition);
         setType(new CustomXmlEventType(definition));
     }
 
+    /**
+     * Build a custom trace event from an existing TmfEvent.
+     *
+     * @param definition
+     *            Trace definition
+     * @param other
+     *            Other TmfEvent to copy
+     */
     public CustomXmlEvent(CustomXmlTraceDefinition definition, TmfEvent other) {
         super(definition, other);
     }
 
+    /**
+     * Full constructor
+     *
+     * @param definition
+     *            Trace definition
+     * @param parentTrace
+     *            Parent trace object
+     * @param timestamp
+     *            Timestamp of the event
+     * @param source
+     *            Source of the event
+     * @param type
+     *            Event type
+     * @param reference
+     *            Reference of the event
+     */
     public CustomXmlEvent(CustomXmlTraceDefinition definition, ITmfTrace parentTrace, ITmfTimestamp timestamp, String source, TmfEventType type, String reference) {
         super(definition, parentTrace, timestamp, source, type, reference);
     }
@@ -38,6 +73,14 @@ public class CustomXmlEvent extends CustomEvent {
         super.setContent(content);
     }
 
+    /**
+     * Parse an entry.
+     *
+     * @param value Value
+     * @param name Name
+     * @param inputAction Input action
+     * @param inputFormat Input format
+     */
     public void parseInput(String value, String name, int inputAction, String inputFormat) {
         if (value.length() == 0) {
             return;