IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.kernel.action
Interface ILoop

All Superinterfaces:
IContainer, ICountable, IKAction, IKLog, IKSemaphore, ITestExecutionServices, Runnable
All Known Subinterfaces:
IFor, IPacedLoop, IWhile

public interface ILoop
extends IContainer

Special container to support looping.

This container contains support for looping commands. In particular, it contains support for break and continue within a container.


Field Summary
 
Fields inherited from interface com.ibm.rational.test.lt.kernel.action.IKAction
ABANDONED, DP_ENCRYPTED_VALUES_KEY, EXECUTING, FINISHED, HANDLETIMER, SEMWAIT, SLEEPING, Status, UNSTARTED
 
Fields inherited from interface com.ibm.rational.test.lt.kernel.logging.IKLog
HISTORY_ALL, HISTORY_NONE, HISTORY_PAGES, HISTORY_REQUESTS, HISTORY_SCHEDULE, LOG_ALL, LOG_CONFIG, LOG_FINE, LOG_FINER, LOG_FINEST, LOG_INFO, LOG_NONE, LOG_SEVERE, LOG_WARNING, STATISTIC_ALL, STATISTIC_NONE, STATISTIC_PAGES
 
Fields inherited from interface com.ibm.rational.test.lt.kernel.services.ITestExecutionServices
STORAGE_LOCAL, STORAGE_USER
 
Method Summary
 void breakLoop()
          Break out of the loop.
 void continueLoop()
          Jump to the end of the loop.
 int getLoopIteration()
          Which iteration is this?
 long getTimeStarted()
          When did this loop start?
 boolean isLoopBroken()
          Has the loop been interrupted with a 'break'?
 boolean isLoopContinued()
          Has the loop been interrupted with a 'continue'?
 void resetBreak()
          Reset the break.
 void resetContinue()
          Reset the continuation.
 
Methods inherited from interface com.ibm.rational.test.lt.kernel.action.IContainer
add, addCatch, addFinally, addInitially, current, finish, get, getActions, getActionsArray, getChildCount, getParentHistoryId, getStartEvent, getStartHistoryId, getStopEvent, getUserGroup, getVirtualUser, isAllowChildrenToPageTestLog, next, nextHistoryId, previous, recordChildExecutionTime, registerChildVerdict, registerChildVerdict, registerChildVerdict, registerChildVerdict, remove, rollUpVerdicts, setAllowChildrenToPageTestLog, setStartHistoryId, stopChildren, verifyParentRelationships
 
Methods inherited from interface com.ibm.rational.test.lt.kernel.action.IKAction
abandon, addEventBehavior, blocked, execute, executeAction, executionTime, findDataArea, finish, getBlockedTimeout, getHistory, getHistoryType, getId, getName, getParent, getResultInteger, getResultObject, getResultString, getRtbEnabled, getStatTree, getStopRequested, getSubsystem, getTimeoutDuration, getTimeoutScheme, getVirtualUserName, getWorkerThread, hasFinished, hasStarted, isRunning, reset, setBlockedTimeout, setDispatchingAction, setHistory, setHistoryType, setId, setResultInteger, setResultObject, setResultString, setResultString, setRtbEnabled, setStatTree, start, status, stop, stop, stopAction
 
Methods inherited from interface com.ibm.rational.test.lt.kernel.ICountable
addCounter, getCounter, getCounters, resetCounters
 
Methods inherited from interface com.ibm.rational.test.lt.kernel.logging.IKLog
getHistoryLevel, getHistoryLevel, getLogLevel, getStatisticsLevel, getVirtualUserGUID, log, log, log, log, reportEvent, reportEvent, reportEvent, reportMessage, reportMessage, reportMessage, reportVerdict, reportVerdict, reportVerdict, reportVerdict, reportVerificationPoint, reportVerificationPoint, reportVerificationPoint, reportVerificationPoint, reportVerificationPoint, reportVerificationPoint, wouldARM, wouldLog, wouldReportHistory, wouldReportHistory, wouldReportStatistics
 
Methods inherited from interface com.ibm.rational.test.lt.kernel.action.IKSemaphore
acquire, availablePermits, getQueue, getQueueLength, reducePermits, release, release, toString, tryAcquire, tryAcquire
 
Methods inherited from interface com.ibm.rational.test.lt.kernel.services.ITestExecutionServices
getARM, getLoopControl, getPDLogManager, getStatisticsManager, getTestLogManager, getTime, getTransaction, getValue, setValue
 
Methods inherited from interface java.lang.Runnable
run
 

Method Detail

breakLoop

void breakLoop()
Break out of the loop.

This method is used to indicate the need to break from the loop and continue with the next action outside of the loop construct. It does not evaluate the loop again.


continueLoop

void continueLoop()
Jump to the end of the loop.

This method is used to indicate the need to jump to the end of the loop, reevaluate the loop condition and decide whether or not to reexecute the loop.


resetBreak

void resetBreak()
Reset the break.


resetContinue

void resetContinue()
Reset the continuation.


isLoopBroken

boolean isLoopBroken()
Has the loop been interrupted with a 'break'?

Returns:
true If the loop is to be broken

isLoopContinued

boolean isLoopContinued()
Has the loop been interrupted with a 'continue'?

Returns:
true If the loop is to be continued

getLoopIteration

int getLoopIteration()
Which iteration is this?

Returns:
the number of times the body has been started.

getTimeStarted

long getTimeStarted()
When did this loop start?

Returns:
the time (from Time.currentTimeMillis()) that the loop started

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.