tmf: Update copyright headers in tmf.core

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / signal / TmfSignal.java

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignal.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignal.java
index ebf321096a7cc5cd52135df669eebe31eef02967..3304828c18fe083a4763fafe50676fa898a51878 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignal.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfSignal.java
@@ -1,11 +1,11 @@
 /*******************************************************************************
- * Copyright (c) 2009 Ericsson
- * 
+ * Copyright (c) 2009, 2012 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,36 +13,61 @@
 package org.eclipse.linuxtools.tmf.core.signal;
 
 /**
- * <b><u>TmfSignal</u></b>
- * <p>
- * TODO: Implement me. Please.
+ * Base class for TMF signals
+ *
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public abstract class TmfSignal {
 
-       // The signal originator
-       private final Object fSource;
+    private final Object fSource;
+    private int fReference;
 
-       private int fReference;
+    /**
+     * Basic constructor, which uses a default of "0" for the reference index
+     *
+     * @param source
+     *            Object sending this signal
+     */
+    public TmfSignal(Object source) {
+        this(source, 0);
+    }
 
-       public TmfSignal(Object source) {
-               this(source, 0);
-       }
+    /**
+     * Standard constructor
+     *
+     * @param source
+     *            Object sending this signal
+     * @param reference
+     *            Reference index to assign to this signal
+     */
+    public TmfSignal(Object source, int reference) {
+        fSource = source;
+        fReference = reference;
+    }
 
-       public TmfSignal(Object source, int reference) {
-               fSource = source;
-               fReference = reference;
-       }
+    /**
+     * @return The source object of this signal
+     */
+    public Object getSource() {
+        return fSource;
+    }
 
-       public Object getSource() {
-               return fSource;
-       }
+    /**
+     * Change this signal's reference index
+     *
+     * @param reference
+     *            The new reference to use
+     */
+    public void setReference(int reference) {
+        fReference = reference;
+    }
 
-       public void setReference(int reference) {
-               fReference = reference;
-       }
-
-       public int getReference() {
-               return fReference;
-       }
+    /**
+     * @return This signal's reference index
+     */
+    public int getReference() {
+        return fReference;
+    }
 
 }