tmf: Update copyright headers in tmf.ui

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui.tests / src / org / eclipse / linuxtools / tmf / ui / tests / views / uml2sd / loader / Uml2SDSignalValidator.java

diff --git a/org.eclipse.linuxtools.tmf.ui.tests/src/org/eclipse/linuxtools/tmf/ui/tests/views/uml2sd/loader/Uml2SDSignalValidator.java b/org.eclipse.linuxtools.tmf.ui.tests/src/org/eclipse/linuxtools/tmf/ui/tests/views/uml2sd/loader/Uml2SDSignalValidator.java
index 08c59df64e38463e4ee574eae3782b4d7cedac8c..85c591f08fa1148d66736bb446d7cdfbeff577a3 100644 (file)
--- a/org.eclipse.linuxtools.tmf.ui.tests/src/org/eclipse/linuxtools/tmf/ui/tests/views/uml2sd/loader/Uml2SDSignalValidator.java
+++ b/org.eclipse.linuxtools.tmf.ui.tests/src/org/eclipse/linuxtools/tmf/ui/tests/views/uml2sd/loader/Uml2SDSignalValidator.java
@@ -1,30 +1,32 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2012 Ericsson
- * 
+ * Copyright (c) 2011, 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:
  *   Bernd Hufmann - Initial API and implementation
  *******************************************************************************/
 package org.eclipse.linuxtools.tmf.ui.tests.views.uml2sd.loader;
 
 import org.eclipse.linuxtools.tmf.core.component.TmfComponent;
-import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
-import org.eclipse.linuxtools.tmf.core.event.TmfTimestamp;
 import org.eclipse.linuxtools.tmf.core.signal.TmfEndSynchSignal;
 import org.eclipse.linuxtools.tmf.core.signal.TmfRangeSynchSignal;
 import org.eclipse.linuxtools.tmf.core.signal.TmfSignalHandler;
 import org.eclipse.linuxtools.tmf.core.signal.TmfStartSynchSignal;
 import org.eclipse.linuxtools.tmf.core.signal.TmfTimeSynchSignal;
+import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange;
+import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimestamp;
 
 /**
- *  Class to implement that certain signals are sent as well as are sent with correct content. 
+ *  Class to implement that certain signals are sent as well as are sent with correct content.
+ *
+ *  @author Bernd Hufmann
  */
 public class Uml2SDSignalValidator extends TmfComponent implements IUml2SdSignalValidator {
-    
+
     // ------------------------------------------------------------------------
     // Attributes
     // ------------------------------------------------------------------------
@@ -42,44 +44,63 @@ public class Uml2SDSignalValidator extends TmfComponent implements IUml2SdSignal
     // ------------------------------------------------------------------------
     // Constructor
     // ------------------------------------------------------------------------
+    /**
+     * Constructor
+     */
     public Uml2SDSignalValidator() {
     }
-    
+
     // ------------------------------------------------------------------------
     // Operations
     // ------------------------------------------------------------------------
+    /**
+     * Signal handler for time synch signal.
+     * @param signal the signal to handle.
+     */
     @TmfSignalHandler
     public void synchToTime(TmfTimeSynchSignal signal) {
-        // Set results so that it can be validated in the test case 
+        // Set results so that it can be validated in the test case
         setSignalReceived(true);
         setSourceError(getSource() != signal.getSource());
         setCurrentTimeError(!getCurrentTime().equals(signal.getCurrentTime()));
     }
 
+    /**
+     * Signal handler for time range synch signal.
+     * @param signal the signal to handle.
+     */
     @TmfSignalHandler
     public void synchToTimeRange(TmfRangeSynchSignal signal) {
-        // Set results so that it can be validated in the test case 
+        // Set results so that it can be validated in the test case
         setSignalReceived(true);
         setSourceError(getSource() != signal.getSource());
         setCurrentTimeError(!getCurrentTime().equals(signal.getCurrentTime()));
         setRangeError(!getCurrentRange().equals(signal.getCurrentRange()));
     }
-    
+
+    /**
+     * Signal handler for handling start synch signal.
+     * @param signal the signal to handle.
+     */
     @TmfSignalHandler
     public void startSynch(TmfStartSynchSignal signal) {
         fSignalDepth++;
-        // make sure that the signal which is send by the loader class is not handled by the loader class 
+        // make sure that the signal which is send by the loader class is not handled by the loader class
         // after receiving it. i.e. it must not trigger a another signal
-        
+
         // Set results so that it can be validated in the test case
         setSignalError(fSignalDepth > 1);
     }
 
+    /**
+     * Signal handler for handling end synch signal.
+     * @param signal the signal to handle.
+     */
     @TmfSignalHandler
     public void endSynch(TmfEndSynchSignal signal) {
         fSignalDepth = fSignalDepth > 0 ? fSignalDepth - 1 : 0;
     }
-    
+
     @Override
     public boolean isSignalReceived() {
         return fIsSignalReceived;
@@ -123,8 +144,8 @@ public class Uml2SDSignalValidator extends TmfComponent implements IUml2SdSignal
     @Override
     public boolean isSignalError() {
         return fIsSignalError;
-    }    
-    
+    }
+
     @Override
     public void setSignalError(boolean fIsSignalError) {
         this.fIsSignalError = fIsSignalError;
@@ -139,7 +160,7 @@ public class Uml2SDSignalValidator extends TmfComponent implements IUml2SdSignal
     public void setSource(Object source) {
         fSource = source;
     }
-    
+
     @Override
     public TmfTimestamp getCurrentTime() {
         return fCurrentTimestamp;
@@ -159,5 +180,5 @@ public class Uml2SDSignalValidator extends TmfComponent implements IUml2SdSignal
     public void setCurrentRange(TmfTimeRange currentRange) {
         fCurrentTimeRange = currentRange == null ? null : new TmfTimeRange(currentRange);
     }
-};
+}