org.eclipse.tracecompass.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/collapse/ITmfCollapsibleEvent.java

   1 /*******************************************************************************
   2  * Copyright (c) 2014 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  *   Bernd Hufmann - Initial API and implementation
  11  *******************************************************************************/
  12 package org.eclipse.linuxtools.tmf.core.event.collapse;
  13
  14 import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
  15
  16 /**
  17  * Interface for deciding whether an event can be collapsed with another event.
  18  *
  19  * @author Bernd Hufmann
  20  * @since 3.2
  21  */
  22 public interface ITmfCollapsibleEvent {
  23
  24     /**
  25      * Verifies if an event is similar to a given event and can be collapsed
  26      * into one event. For example, an event can be seen as similar if all data
  27      * of the events but the timestamp is equal.
  28      *
  29      * @param otherEvent
  30      *            an event to compare
  31      * @return <code>true</code> if a given event is similar to another event
  32      *         else <code>false</code>
  33      */
  34     boolean isCollapsibleWith(ITmfEvent otherEvent);
  35 }