| 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.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 | * @since 2.0 |
| 19 | */ |
| 20 | public interface ITmfXmlAction { |
| 21 | |
| 22 | /** The save stored fields action label */ |
| 23 | String SAVE_STORED_FIELDS_STRING = "saveStoredFields"; //$NON-NLS-1$ |
| 24 | |
| 25 | /** The clear stored fields action label */ |
| 26 | String CLEAR_STORED_FIELDS_STRING = "clearStoredFields"; //$NON-NLS-1$ |
| 27 | |
| 28 | /** |
| 29 | * Execute the action |
| 30 | * |
| 31 | * @param event |
| 32 | * The active event |
| 33 | * @param scenarioInfo |
| 34 | * The active scenario details. Or <code>null</code> if there is |
| 35 | * no scenario. |
| 36 | */ |
| 37 | void execute(ITmfEvent event, TmfXmlScenarioInfo scenarioInfo); |
| 38 | } |