tmf: Update copyright headers in tmf.ui

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / views / uml2sd / handlers / provider / ISDGraphNodeSupporter.java

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDGraphNodeSupporter.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDGraphNodeSupporter.java
index 879800b033edce066a9ac9f08cf1a387f9162eb6..46e914a39f975ea76a5532bdbb547e9a761e73ca 100755 (executable)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDGraphNodeSupporter.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDGraphNodeSupporter.java
@@ -1,46 +1,82 @@
 /**********************************************************************
- * Copyright (c) 2005, 2006, 2011 IBM Corporation and others.
+ * Copyright (c) 2005, 2012 IBM Corporation, 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
- * $Id: ISDGraphNodeSupporter.java,v 1.2 2006/09/20 20:56:26 ewchan Exp $
- * 
- * Contributors: 
- * IBM - Initial API and implementation
- * Bernd Hufmann - Updated for TMF
+ *
+ * Contributors:
+ *     IBM - Initial API and implementation
+ *     Bernd Hufmann - Updated for TMF
  **********************************************************************/
+
 package org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider;
 
 /**
+ * Interface for providing a graph node supporter.
+ *
  * Sequence Diagram loaders which implement this class provide the actions for finding or filtering the sequence
  * diagram. This interface also allow the implementor to set which action/feature are supported
- * 
- * Action provider are associated to a Sequence Diagram SDWidget calling SDViewer.setSDFindProvider() or
- * SDViewer.setSDFilterProvider
- * 
+ *
+ * Action provider are associated to a Sequence Diagram SDWidget calling <code>SDViewer.setSDFindProvider()</code> or
+ * <code>SDViewer.setSDFilterProvider()</code>.
+ *
+ * @version 1.0
  * @author sveyrier
- * 
+ *
  */
 public abstract interface ISDGraphNodeSupporter {
 
+    // ------------------------------------------------------------------------
+    // Constants
+    // ------------------------------------------------------------------------
+
+    /**
+     * Lifeline support ID
+     */
     public static int LIFELINE = 0;
+    /**
+     * Synchronous message support ID
+     */
     public static int SYNCMESSAGE = 1;
+    /**
+     * Synchronous message return support ID
+     */
     public static int SYNCMESSAGERETURN = 2;
+    /**
+     * Asynchronous message support ID
+     */
     public static int ASYNCMESSAGE = 3;
+    /**
+     * Asynchronous message return support ID
+     */
     public static int ASYNCMESSAGERETURN = 4;
+    /**
+     * Stop support ID
+     */
     public static int STOP = 5;
 
+    // ------------------------------------------------------------------------
+    // Methods
+    // ------------------------------------------------------------------------
+
     /**
      * Return true to enable this options, false otherwise
-     * 
+     *
+     * @param nodeType
+     *            The integer value matching the type of the node
      * @return true to enable this options, false otherwise
      */
     public boolean isNodeSupported(int nodeType);
 
     /**
-     * Return the name to use in dialogs Not called if isNodeSupported return false
-     * 
+     * Return the name to use in dialogs Not called if isNodeSupported return
+     * false
+     *
+     * @param nodeType
+     *            The integer value matching the type of the node
+     * @param loaderClassName
+     *            The name of the loader class
      * @return the name to use in dialogs
      */
     public String getNodeName(int nodeType, String loaderClassName);