001 /******************************************************************************
002 * Copyright (C) MActor Developers. All rights reserved. *
003 * ---------------------------------------------------------------------------*
004 * This file is part of MActor. *
005 * *
006 * MActor is free software; you can redistribute it and/or modify *
007 * it under the terms of the GNU General Public License as published by *
008 * the Free Software Foundation; either version 2 of the License, or *
009 * (at your option) any later version. *
010 * *
011 * MActor is distributed in the hope that it will be useful, *
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
014 * GNU General Public License for more details. *
015 * *
016 * You should have received a copy of the GNU General Public License *
017 * along with MActor; if not, write to the Free Software *
018 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *
019 ******************************************************************************/
020 package org.mactor.framework.extensioninterface;
021
022 import java.util.List;
023
024 import org.mactor.framework.MactorException;
025 import org.mactor.framework.TestContext;
026
027 /**
028 * The interface that must be implemented by value commands
029 * <p>
030 * From a testspec: <value name="MyValue" command="java:<i>class that
031 * implements the ValueCommand interface</i>"/>
032 * </p>
033 *
034 * @author Lars Ivar Almli
035 */
036 public interface ValueCommand {
037 /**
038 * The method invoked by the testrunner to perform the action node.
039 *
040 * @param context
041 * contains information about the context of the test that might
042 * be useful (such as all messages sent/received so far in the
043 * test)
044 * @param params
045 * the list of parameteres specifed for the given node in the
046 * test-spec xml (after the ##{...} substitution has been
047 * performed)
048 * @throws MactorException
049 * if some problem occured (this will case the test to fail)
050 */
051 String extractValue(TestContext context, List<String> params) throws MactorException;
052 }