IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.patterns.framework.test
Class AbstractTestModule

java.lang.Object
  extended bycom.ibm.xtools.patterns.framework.test.AbstractTestModule
All Implemented Interfaces:
ITestModule
Direct Known Subclasses:
TestModuleAddAll, TestModuleRemoveAll

public abstract class AbstractTestModule
extends Object
implements ITestModule


Method Summary
protected  boolean addParameterArgument(String parameterName, Object value)
          Add the specified value as an argument to the parameter with the specified name
 void endOfSubgroupReached()
          This method should be called after a given subgroup of elements has been processed (passed to processElement()).
protected  IParameterDescriptor getParameter(String name)
          Retrieve the pattern parameter with the specified name
protected  AbstractTestSetup getTestSetup()
           
protected  boolean removeParameterValue(String parameterName, Object value)
          Remove the specified value from the parameter with the specified name
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.xtools.patterns.framework.test.ITestModule
processElement
 

Method Detail

endOfSubgroupReached

public void endOfSubgroupReached()
Description copied from interface: ITestModule
This method should be called after a given subgroup of elements has been processed (passed to processElement()). This is mainly for reporting and cleaning purposes. For example, a iterateHorizontaly method would call this after all elements prepared for a given parameter were processed.

Specified by:
endOfSubgroupReached in interface ITestModule

addParameterArgument

protected boolean addParameterArgument(String parameterName,
                                       Object value)
Add the specified value as an argument to the parameter with the specified name

Parameters:
parameterName - name of a pattern parameter
value - value to be added as an argument to the specified parameter
Returns:
true if the value was added successfully

getParameter

protected IParameterDescriptor getParameter(String name)
                                     throws NoSuchElementException
Retrieve the pattern parameter with the specified name

Parameters:
name - name of a pattern parameter
Returns:
pattern parameter with the specified name
Throws:
NoSuchElementException

removeParameterValue

protected boolean removeParameterValue(String parameterName,
                                       Object value)
Remove the specified value from the parameter with the specified name

Parameters:
parameterName - name of a pattern parameter
value - value to be removed from the specified parameter
Returns:
true if the value was removed successfully

getTestSetup

protected AbstractTestSetup getTestSetup()

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.