org.scalatest

Tracker

class Tracker 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.

attributes: final

Inherits

  1. AnyRef
  2. Any

Value Members

  1. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an equivalence relation:

    • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
    • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef ⇐ Any
  2. def hashCode(): Int

    Returns a hash code value for the object

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    definition classes: AnyRef ⇐ Any
  3. def nextOrdinal(): Ordinal

    Returns the next Ordinal in the series tracked by this Tracker

    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.

  4. 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

    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.

  5. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    definition classes: AnyRef ⇐ Any

Instance constructors

  1. new Tracker()

    Constructs a new Tracker with a new Ordinal initialized with a run stamp of 0

    Constructs a new Tracker with a new Ordinal initialized with a run stamp of 0.

  2. new Tracker(firstOrdinal: Ordinal)