Klasse StopWatch

java.lang.Object
org.apache.fulcrum.yaafi.interceptor.util.StopWatch

public class StopWatch extends Object

StopWatch provides a convenient API for timings.

To start the watch, call start(). At this point you can:

  • split() the watch to get the time whilst the watch continues in the background. unsplit() will remove the effect of the split. At this point, these three options are available again.
  • suspend() the watch to pause it. resume() allows the watch to continue. Any time between the suspend and resume will not be counted in the total. At this point, these three options are available again.
  • stop() the watch to complete the timing session.

It is intended that the output methods toString() and getTime() should only be called after stop, split or suspend, however a suitable result will be returned at other points.

NOTE: As from v2.1, the methods protect against inappropriate calls. Thus you cannot now call stop before start, resume before suspend or unsplit before split.

1. split(), suspend(), or stop() cannot be invoked twice
2. unsplit() may only be called if the watch has been split()
3. resume() may only be called if the watch has been suspend()
4. start() cannot be called twice without calling reset()

Seit:
2.0
Version:
$Id$
Autor:
Henri Yandell, Stephen Colebourne
  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    Constructor.
  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    long
    Get the split time on the stopwatch.
    long
    Get the time on the stopwatch.
    void
    Resets the stopwatch.
    void
    Resume the stopwatch after a suspend.
    void
    Split the time.
    void
    Start the stopwatch.
    void
    Stop the stopwatch.
    void
    Suspend the stopwatch for later resumption.
    Gets a summary of the time that the stopwatch recorded as a string.
    void
    Remove a split.

    Von Klasse geerbte Methoden java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Konstruktordetails

    • StopWatch

      public StopWatch()

      Constructor.

  • Methodendetails

    • start

      public void start()

      Start the stopwatch.

      This method starts a new timing session, clearing any previous values.

      Löst aus:
      IllegalStateException - if the StopWatch is already running.
    • stop

      public void stop()

      Stop the stopwatch.

      This method ends a new timing session, allowing the time to be retrieved.

      Löst aus:
      IllegalStateException - if the StopWatch is not running.
    • reset

      public void reset()

      Resets the stopwatch. Stops it if need be.

      This method clears the internal values to allow the object to be reused.

    • split

      public void split()

      Split the time.

      This method sets the stop time of the watch to allow a time to be extracted. The start time is unaffected, enabling unsplit() to continue the timing from the original start point.

      Löst aus:
      IllegalStateException - if the StopWatch is not running.
    • unsplit

      public void unsplit()

      Remove a split.

      This method clears the stop time. The start time is unaffected, enabling timing from the original start point to continue.

      Löst aus:
      IllegalStateException - if the StopWatch has not been split.
    • suspend

      public void suspend()

      Suspend the stopwatch for later resumption.

      This method suspends the watch until it is resumed. The watch will not include time between the suspend and resume calls in the total time.

      Löst aus:
      IllegalStateException - if the StopWatch is not currently running.
    • resume

      public void resume()

      Resume the stopwatch after a suspend.

      This method resumes the watch after it was suspended. The watch will not include time between the suspend and resume calls in the total time.

      Löst aus:
      IllegalStateException - if the StopWatch has not been suspended.
    • getTime

      public long getTime()
      Get the time on the stopwatch. This is either the time between the start and the moment this method is called, or the amount of time between start and stop.
      Gibt zurück:
      the time in milliseconds
    • getSplitTime

      public long getSplitTime()
      Get the split time on the stopwatch. This is the time between start and latest split.
      Gibt zurück:
      the split time in milliseconds
      Löst aus:
      IllegalStateException - if the StopWatch has not yet been split.
      Seit:
      2.1
    • toString

      public String toString()
      Gets a summary of the time that the stopwatch recorded as a string.
      Setzt außer Kraft:
      toString in Klasse Object
      Gibt zurück:
      the time as a String