org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/load/IUml2SDLoader.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.load;
  15
  16 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.SDView;
  17
  18 /**
  19  * The interface all UML2SD loaders must implement.
  20  *
  21  * @version 1.0
  22  * @author sveyrier
  23  */
  24 public interface IUml2SDLoader {
  25
  26     /**
  27      * Set the viewer object to the loader that has been reloaded at the beginning
  28      * of a new workbench session
  29      *
  30      * @param viewer The sequence diagram view
  31      */
  32     public void setViewer(SDView viewer);
  33
  34     /**
  35      * Returns title string for the UML2SD View when this loader is the one
  36      *
  37      * @return the string convenient for this loader
  38      */
  39     public String getTitleString();
  40
  41     /**
  42      * When another loader becomes the one the previous one is replaced It's time clean-up
  43      * if needed (listeners to be removed for example)
  44      */
  45     public void dispose();
  46
  47 }