[deliverable/tracecompass.git] / tmf / org.eclipse.tracecompass.tmf.core / src / org / eclipse / tracecompass / tmf / core / event / collapse / ITmfCollapsibleEvent.java

/*******************************************************************************
 * Copyright (c) 2014 Ericsson
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Bernd Hufmann - Initial API and implementation
 *******************************************************************************/
package org.eclipse.tracecompass.tmf.core.event.collapse;

import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;

/**
 * Interface for deciding whether an event can be collapsed with another event.
 *
 * @author Bernd Hufmann
 */
public interface ITmfCollapsibleEvent {

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