tmf/org.eclipse.tracecompass.tmf.analysis.xml.core/src/org/eclipse/tracecompass/internal/tmf/analysis/xml/core/model/ITmfXmlAction.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.tracecompass.tmf.core.event.ITmfEvent;
  12
  13 /**
  14  * Interface for an action behavior. An action is an output of the pattern.
  15  * Basically something that the pattern needs to do if it reaches a given state.
  16  *
  17  * @author Jean-Christian Kouame
  18  */
  19 public interface ITmfXmlAction {
  20
  21     /** The save stored fields action label */
  22     String SAVE_STORED_FIELDS_STRING = "saveStoredFields"; //$NON-NLS-1$
  23
  24     /** The clear stored fields action label */
  25     String CLEAR_STORED_FIELDS_STRING = "clearStoredFields"; //$NON-NLS-1$
  26
  27     /**
  28      * Execute the action
  29      *
  30      * @param event
  31      *            The active event
  32      * @param scenarioInfo
  33      *            The active scenario details. Or <code>null</code> if there is
  34      *            no scenario.
  35      */
  36     void execute(ITmfEvent event, TmfXmlScenarioInfo scenarioInfo);
  37 }