org.eclipse.tracecompass.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/load/IUml2SDLoader.java

   1 /**********************************************************************
   2  * Copyright (c) 2005, 2013 IBM Corporation, Ericsson
   3  * All rights reserved.   This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM - Initial API and implementation
  10  *     Bernd Hufmann - Updated for TMF
  11  **********************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.ui.views.uml2sd.load;
  14
  15 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.SDView;
  16
  17 /**
  18  * The interface all UML2SD loaders must implement.
  19  *
  20  * @version 1.0
  21  * @author sveyrier
  22  */
  23 public interface IUml2SDLoader {
  24
  25     /**
  26      * Set the viewer object to the loader that has been reloaded at the beginning
  27      * of a new workbench session
  28      *
  29      * @param viewer The sequence diagram view
  30      */
  31     void setViewer(SDView viewer);
  32
  33     /**
  34      * Returns title string for the UML2SD View when this loader is the one
  35      *
  36      * @return the string convenient for this loader
  37      */
  38     String getTitleString();
  39
  40     /**
  41      * When another loader becomes the one the previous one is replaced It's time clean-up
  42      * if needed (listeners to be removed for example)
  43      */
  44     void dispose();
  45
  46 }