ValueCommand.java :  » Testing » MActor » org » mactor » framework » extensioninterface » Java Open Source

/******************************************************************************
 * Copyright (C) Lars Ivar Almli. All rights reserved.                        *
 * ---------------------------------------------------------------------------*
 * This file is part of MActor.                                               *
 *                                                                            *
 * MActor is free software; you can redistribute it and/or modify             *
 * it under the terms of the GNU General Public License as published by       *
 * the Free Software Foundation; either version 2 of the License, or          *
 * (at your option) any later version.                                        *
 *                                                                            *
 * MActor is distributed in the hope that it will be useful,                  *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
 * GNU General Public License for more details.                               *
 *                                                                            *
 * You should have received a copy of the GNU General Public License          *
 * along with MActor; if not, write to the Free Software                      *
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA *
 ******************************************************************************/
package org.mactor.framework.extensioninterface;

import java.util.List;
import org.mactor.framework.MactorException;
import org.mactor.framework.TestContext;

/**
 * The interface that must be implemented by value commands
 * <p>
 * From a testspec: &lt;value name="MyValue" command="java:<i>class that
 * implements the ValueCommand interface</i>"/&gt;
 * </p>
 * 
 * @author Lars Ivar Almli
 */
public interface ValueCommand {
  /**
   * The method invoked by the testrunner to perform the action node.
   * 
   * @param context
   *            contains information about the context of the test that might
   *            be useful (such as all messages sent/received so far in the
   *            test)
   * @param params
   *            the list of parameteres specifed for the given node in the
   *            test-spec xml (after the ##{...} substitution has been
   *            performed)
   * @throws MactorException
   *             if some problem occured (this will case the test to fail)
   */
  String extractValue(TestContext context, List<String> params) throws MactorException;
}