tmf/lttng: Remove unneeded (non-Javadoc) comments

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / event / ITmfEventType.java

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/ITmfEventType.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/ITmfEventType.java
index 08c1eeb9a587919cf46cf2457740c5e5f4483d3a..8e77e938dd4b9c9a33dc8aff28557f4c47fbd773 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/ITmfEventType.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/ITmfEventType.java
@@ -1,11 +1,11 @@
 /*******************************************************************************
- * Copyright (c) 2012 Ericsson
- * 
+ * Copyright (c) 2012, 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
  * accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
- * 
+ *
  * Contributors:
  *   Francois Chouinard - Initial API and implementation
  *******************************************************************************/
@@ -13,41 +13,60 @@
 package org.eclipse.linuxtools.tmf.core.event;
 
 /**
- * <b><u>ITmfEventType</u></b>
+ * The generic event type in TMF. It contains a reference to the full field structure
+ * for that event type.
  * <p>
+ * Types are unique within their context space.
+ *
+ * @version 1.0
+ * @author Francois Chouinard
+ *
+ * @see ITmfEvent
+ * @see ITmfEventField
  */
-public interface ITmfEventType extends Cloneable {
+public interface ITmfEventType {
+
+    // ------------------------------------------------------------------------
+    // Constants
+    // ------------------------------------------------------------------------
 
     /**
-     * @return the event type context
+     * The default event type content
      */
-    public String getContext();
+    public static final String DEFAULT_CONTEXT_ID = "TmfContext"; //$NON-NLS-1$
 
     /**
-     * @return the event type ID
+     * The default event type name
      */
-    public String getId();
+    public static final String DEFAULT_TYPE_ID = "TmfType"; //$NON-NLS-1$
+
+    // ------------------------------------------------------------------------
+    // Getters
+    // ------------------------------------------------------------------------
 
     /**
-     * @return the event field labels
+     * @return the event type context
      */
-    public String[] getFieldLabels();
+    public String getContext();
 
     /**
-     * @param index the event field index
-     * @return the corresponding event field label
+     * @return the event type ID
      */
-    public String getFieldLabel(int index) throws TmfNoSuchFieldException;
+    public String getName();
 
     /**
-     * @param fieldId the event field ID
-     * @return the corresponding event field index
+     * @return the event type root field
      */
-    public int getFieldIndex(String fieldId) throws TmfNoSuchFieldException;
+    public ITmfEventField getRootField();
 
     /**
-     * @return a clone of the event content
+     * @return the event field names (labels)
      */
-    public ITmfEventType clone();
+    public String[] getFieldNames();
 
+    /**
+     * @param index the event field index
+     * @return the corresponding event field label
+     */
+    public String getFieldName(int index);
 }