tmf/org.eclipse.tracecompass.tmf.analysis.xml.core/src/org/eclipse/tracecompass/internal/tmf/analysis/xml/core/model/ITmfXmlCondition.java

   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.internal.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  */
  20 public interface ITmfXmlCondition {
  21
  22     /**
  23      * Test the result of the condition for an event
  24      *
  25      * @param event
  26      *            The event on which to test the condition
  27      * @param scenarioInfo
  28      *            The active scenario details. Or <code>null</code> if there is
  29      *            no scenario.
  30      * @return Whether the condition is true or not
  31      */
  32     boolean test(ITmfEvent event, @Nullable TmfXmlScenarioInfo scenarioInfo);
  33
  34 }