org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDGraphNodeSupporter.java

   1 /**********************************************************************
   2  * Copyright (c) 2005, 2006 IBM Corporation and others.
   3  * Copyright (c) 2011, 2012 Ericsson.
   4  *
   5  * All rights reserved.   This program and the accompanying materials
   6  * are made available under the terms of the Eclipse Public License v1.0
   7  * which accompanies this distribution, and is available at
   8  * http://www.eclipse.org/legal/epl-v10.html
   9  *
  10  * Contributors:
  11  * IBM - Initial API and implementation
  12  * Bernd Hufmann - Updated for TMF
  13  **********************************************************************/
  14 package org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider;
  15
  16 /**
  17  * Interface for providing a graph node supporter.
  18  *
  19  * Sequence Diagram loaders which implement this class provide the actions for finding or filtering the sequence
  20  * diagram. This interface also allow the implementor to set which action/feature are supported
  21  *
  22  * Action provider are associated to a Sequence Diagram SDWidget calling <code>SDViewer.setSDFindProvider()</code> or
  23  * <code>SDViewer.setSDFilterProvider()</code>.
  24  *
  25  * @version 1.0
  26  * @author sveyrier
  27  *
  28  */
  29 public abstract interface ISDGraphNodeSupporter {
  30
  31     // ------------------------------------------------------------------------
  32     // Constants
  33     // ------------------------------------------------------------------------
  34
  35     /**
  36      * Lifeline support ID
  37      */
  38     public static int LIFELINE = 0;
  39     /**
  40      * Synchronous message support ID
  41      */
  42     public static int SYNCMESSAGE = 1;
  43     /**
  44      * Synchronous message return support ID
  45      */
  46     public static int SYNCMESSAGERETURN = 2;
  47     /**
  48      * Asynchronous message support ID
  49      */
  50     public static int ASYNCMESSAGE = 3;
  51     /**
  52      * Asynchronous message return support ID
  53      */
  54     public static int ASYNCMESSAGERETURN = 4;
  55     /**
  56      * Stop support ID
  57      */
  58     public static int STOP = 5;
  59
  60     // ------------------------------------------------------------------------
  61     // Methods
  62     // ------------------------------------------------------------------------
  63
  64     /**
  65      * Return true to enable this options, false otherwise
  66      *
  67      * @param nodeType
  68      *            The integer value matching the type of the node
  69      * @return true to enable this options, false otherwise
  70      */
  71     public boolean isNodeSupported(int nodeType);
  72
  73     /**
  74      * Return the name to use in dialogs Not called if isNodeSupported return
  75      * false
  76      *
  77      * @param nodeType
  78      *            The integer value matching the type of the node
  79      * @param loaderClassName
  80      *            The name of the loader class
  81      * @return the name to use in dialogs
  82      */
  83     public String getNodeName(int nodeType, String loaderClassName);
  84 }