ScalaTest 1.0
org.scalatest

class Tracker
[source: org/scalatest/Tracker.scala]
final class Tracker(firstOrdinal : Ordinal)
extends AnyRef
Class that tracks the progress of a series of Ordinals produced by invoking next and nextNewOldPair on the current Ordinal.

Instances of this class are thread safe. Multiple threads can invoke nextOrdinal and nextTracker concurrently. This facilitates multi-threaded tests that send infoProvided reports concurrently. When using a Dispatcher to execute suites in parallel, the intention is that each Tracker will only be used by one thread. For example, if the optional Dispatcher passed to Suite's implementation of runNestedSuites is defined, that method will obtain a new Tracker by invoking nextTracker for each nested suite it passes to the Dispatcher.

Parameters
firstOrdinal - the first Ordinal in the series of Ordinals tracked by this Tracker, which will be used to initialize this Tracker's current Ordinal.
Author
Bill Venners
Additional Constructor Summary
def this : Tracker
Constructs a new Tracker with a new Ordinal initialized with a run stamp of 0.
Method Summary
def nextOrdinal : Ordinal
Returns the next Ordinal in the series tracked by this Tracker.
def nextTracker : Tracker
Returns a Tracker initialized with the first element in the tuple returned by invoking nextNewOldPair on the current Ordinal, and reassigns the current Ordinal with the second element that was returned by the nextNewOldPair invocation.
Methods inherited from AnyRef
getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized
Methods inherited from Any
==, !=, isInstanceOf, asInstanceOf
Additional Constructor Details
def this : Tracker
Constructs a new Tracker with a new Ordinal initialized with a run stamp of 0.
Method Details
def nextOrdinal : Ordinal
Returns the next Ordinal in the series tracked by this Tracker.

This method saves the current Ordinal in a local variable, reassigns the current Ordinal with the value returned by invoking nextOrdinal on the saved Ordinal, then returns the saved Ordinal. As a result, if this method is invoked immediately after construction, this method will return the Ordinal passed as firstOrdinal.

Returns
the next Ordinal in the series
def nextTracker : Tracker
Returns a Tracker initialized with the first element in the tuple returned by invoking nextNewOldPair on the current Ordinal, and reassigns the current Ordinal with the second element that was returned by the nextNewOldPair invocation.

The Ordinal series of the returned Tracker will be placed after all the Ordinals previously returned by invoking nextOrdinal on this Tracker and before all the Ordinals subsequently returned by invoking nextOrdinal on this Tracker in the future. This method is intended to be used when executing nested suites in parallel. Each nested suite passed to the Distributor will get its own Tracker obtained by invoking nextTracker on the current thread's Tracker.

Returns
the next Tracker in this series
Copyright (C) 2001-2009 Artima, Inc. All rights reserved.
ScalaTest 1.0