[deliverable/tracecompass.git] / tmf / org.eclipse.tracecompass.tmf.analysis.xml.core / src / org / eclipse / tracecompass / tmf / analysis / xml / core / model / ITmfXmlCondition.java

/*******************************************************************************
 * Copyright (c) 2016 Ecole Polytechnique de Montreal, 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
 ******************************************************************************/
package org.eclipse.tracecompass.tmf.analysis.xml.core.model;

import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;

/**
 * Determines a true or false value for a given input. The input is an event and
 * an optional scenarioInfo.
 *
 * @author Matthew Khouzam
 * @since 2.0
 */
public interface ITmfXmlCondition {

    /**
     * Test the result of the condition for an event
     *
     * @param event
     *            The event on which to test the condition
     * @param scenarioInfo
     *            The active scenario details. Or <code>null</code> if there is
     *            no scenario.
     * @return Whether the condition is true or not
     * @since 2.0
     */
    boolean test(ITmfEvent event, @Nullable TmfXmlScenarioInfo scenarioInfo);

}
Commit	Line	Data
3a5f73a1 JCK	1	/*******************************************************************************
	2	* Copyright (c) 2016 Ecole Polytechnique de Montreal, 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	package org.eclipse.tracecompass.tmf.analysis.xml.core.model;
	10
	11	import org.eclipse.jdt.annotation.Nullable;
	12	import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
	13
	14	/**
	15	* Determines a true or false value for a given input. The input is an event and
	16	* an optional scenarioInfo.
	17	*
	18	* @author Matthew Khouzam
	19	* @since 2.0
	20	*/
	21	public interface ITmfXmlCondition {
	22
	23	/**
	24	* Test the result of the condition for an event
	25	*
	26	* @param event
	27	* The event on which to test the condition
	28	* @param scenarioInfo
	29	* The active scenario details. Or <code>null</code> if there is
	30	* no scenario.
	31	* @return Whether the condition is true or not
	32	* @since 2.0
	33	*/
	34	boolean test(ITmfEvent event, @Nullable TmfXmlScenarioInfo scenarioInfo);
	35
	36	}