org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/component/ITmfComponent.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2010 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Francois Chouinard - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.core.component;
  14
  15 import org.eclipse.linuxtools.tmf.core.signal.TmfSignal;
  16
  17 /**
  18  * This is the basic interface of all the TMF components.
  19  * <p>
  20  * Currently, it only addresses the inter-component signalling.
  21  *
  22  * @version 1.0
  23  * @author Francois Chouinard
  24  *
  25  * @see TmfComponent
  26  */
  27 public interface ITmfComponent {
  28
  29         /**
  30          * @return the component ID (display name)
  31          */
  32         public String getName();
  33
  34         /**
  35          * Dispose of the component
  36          */
  37         public void dispose();
  38
  39         /**
  40          * Propagate a signal to all the interested listeners.
  41          *
  42          * @param signal the signal to broadcast
  43          */
  44         public void broadcast(TmfSignal signal);
  45
  46 }