de.griefed.serverpackcreator.utilities

Class SimpleStopWatch

java.lang.Object

de.griefed.serverpackcreator.utilities.SimpleStopWatch

public class SimpleStopWatch
extends java.lang.Object

Minimalistic stopwatch to measure the elapsed time between operations.

This stopwatch uses System.nanoTime() to retrieve both the start-time and stop-time. A regular run expects you to call start(), followed by stop(), and then either of getTime(), getTime(String), or toString() to retrieve the elapsed time as a formatted string.

Hours are calculated in a 24h-format: elapsed time / 1.000.000.000 / 3600 % 24

Minutes are calculated: elapsed time / 1.000.000.000 / 60 % 60

Seconds are calculated: elapsed time / 1.000.000.000 % 60

Milliseconds are calculated: elapsed time / 1.000.000

Constructor Summary

Constructors

Constructor and Description
SimpleStopWatch()

Method Summary

Modifier and Type	Method and Description
long	getElapsedNanoseconds() Get the elapsed time in nanoseconds.
@NotNull java.lang.String	getTime() Get the elapsed time of this stopwatch, formatted using %2dh:%02dm:%02ds:%04dms.
@NotNull java.lang.String	getTime(@NotNull java.lang.String format) Get the elapsed time of this stopwatch using a custom formatting.
@NotNull SimpleStopWatch	start() Starts the stopwatch.
@NotNull SimpleStopWatch	stop() Stops the stopwatch.
@NotNull java.lang.String	toString() Get the elapsed time of this stopwatch, formatted using %2dh:%02dm:%02ds:%04dms.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleStopWatch

public SimpleStopWatch()

Method Detail

start

@NotNull
public @NotNull SimpleStopWatch start()

Starts the stopwatch.

After having started the stopwatch, call stop(), followed by any of

• getTime()
• getTime(String)
• toString()

to retrieve the elapsed time.

Returns:

This instance of SimpleStopWatch

stop

@NotNull
public @NotNull SimpleStopWatch stop()
                                       throws java.lang.IllegalStateException

Stops the stopwatch.

The stopwatch must have been started before calling this method, otherwise an IllegalStateException will be thrown. Call start() first!

Returns:

This instance of SimpleStopWatch

Throws:

java.lang.IllegalStateException - if the stopwatch was stopped without having been started first.

toString

@NotNull
public @NotNull java.lang.String toString()
                                            throws java.lang.IllegalStateException

Get the elapsed time of this stopwatch, formatted using %2dh:%02dm:%02ds:%04dms.

The stopwatch must be started and stopped before calling this method, getTime(), or getTime(String). If any of the aforementioned methods are called, but the stopwatch was not started and stopped yet first, an IllegalStateException will be thrown.

Overrides:

toString in class java.lang.Object

Returns:

The elapsed time of a stopwatch run, formatted using %2d:%02d:%02d.

Throws:

java.lang.IllegalStateException - if the stopwatch was started, but not stopped yet.

getTime

@NotNull
public @NotNull java.lang.String getTime()
                                           throws java.lang.IllegalStateException

Get the elapsed time of this stopwatch, formatted using %2dh:%02dm:%02ds:%04dms.

The stopwatch must be started and stopped before calling this method, getTime(String), or toString(). If any of the aforementioned methods are called, but the stopwatch was not started and stopped yet first, an IllegalStateException will be thrown.

Returns:

The elapsed time of a stopwatch run, formatted using %2d:%02d:%02d.

Throws:

java.lang.IllegalStateException - if the stopwatch was started, but not stopped yet.

getTime

@NotNull
public @NotNull java.lang.String getTime(@NotNull
                                                  @NotNull java.lang.String format)
                                           throws java.lang.IllegalStateException

Get the elapsed time of this stopwatch using a custom formatting.

The stopwatch must be started and stopped before calling this method, getTime(), or toString(). If any of the aforementioned methods are called, but the stopwatch was not started and stopped yet first, an IllegalStateException will be thrown.

Parameters:

format - Formatting to apply to the elapsed hours, minutes and seconds.

Returns:

The elapsed time, formatted with the provided formatting.

Throws:

java.lang.IllegalStateException - if the stopwatch was started, but not stopped yet.

getElapsedNanoseconds

public long getElapsedNanoseconds()
                           throws java.lang.IllegalStateException

Get the elapsed time in nanoseconds. Depending on the state of the stopwatch, two values or an IllegalStateException may be thrown.

1. Stopwatch is still running: The elapsed time up to the point of calling this method is returned.
2. Stopwatch started and stopped: The elapsed time between the start and stop is returned.
3. Any other state: An IllegalStateException is thrown.

Returns:

The elapsed time in nanoseconds.

Throws:

java.lang.IllegalStateException - when the stopwatch is in an invalid state for time-retrieval.