TimeDifference

FORMAT_ADAPTIVE

static val FORMAT_ADAPTIVE: Int

Formatting option: adaptive (e.g. 1h 5m; 15m; 1m 30s; 5s).

Value: 1

FORMAT_CHRONOMETER

static val FORMAT_CHRONOMETER: Int

Formatting option: chronometer-style, (e.g. two hours = "2:00:00").

Value: 2

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

forPausedStopwatch

static fun forPausedStopwatch(
    elapsedTime: Duration, 
    format: Int
): Notification.Metric.TimeDifference

Creates a "paused stopwatch" metric, showing the elapsedTime.

forPausedTimer

static fun forPausedTimer(
    remainingTime: Duration, 
    format: Int
): Notification.Metric.TimeDifference

Creates a "paused timer" metric, showing the remainingTime.

forStopwatch

static fun forStopwatch(
    startTime: Instant, 
    format: Int
): Notification.Metric.TimeDifference

Creates a "running stopwatch" metric, which will show the time elapsed since startTime.

forStopwatch

static fun forStopwatch(
    startTime: Long, 
    format: Int
): Notification.Metric.TimeDifference

Creates a "running stopwatch" metric, which will show the time elapsed since startTime, specified in the SystemClock.elapsedRealtime() frame of reference.

forTimer

static fun forTimer(
    endTime: Instant, 
    format: Int
): Notification.Metric.TimeDifference

Creates a "running timer" metric, which will show a countdown to endTime.

forTimer

static fun forTimer(
    endTime: Long, 
    format: Int
): Notification.Metric.TimeDifference

Creates a "running timer" metric, which will show a countdown to endTime, specified in the SystemClock.elapsedRealtime() frame of reference.

getFormat

fun getFormat(): Int

Formatting option for the timer/stopwatch.

getPausedDuration

fun getPausedDuration(): Duration?

The fixed time difference, for a paused timer or stopwatch.

• For a paused timer this is the remainingTime supplied to forPausedTimer.
• For a paused stopwatch this is the elapsedTime supplied to forPausedStopwatch.
• For running timers or stopwatches this is null.

getZeroElapsedRealtime

fun getZeroElapsedRealtime(): Long?

The elapsed realtime at which the time difference is zero. Only valid for an SystemClock.elapsedRealtime()-based TimeDifference.

• For a running timer this is the endTime supplied to forTimer(long,int).
• For a running stopwatch this is the startTime supplied to forStopwatch(long,int).
• For running timers or stopwatches based on Instant (as well as paused timers and stopwatches), this is null.

getZeroTime

fun getZeroTime(): Instant?

The Instant at which the time difference is zero. Only valid for an Instant-based TimeDifference.

• For a running timer this is the endTime supplied to forTimer(Instant,int).
• For a running stopwatch this is the startTime supplied to forStopwatch(Instant,int).
• For running timers or stopwatches based on elapsed realtime (as well as paused timers and stopwatches), this is null.

hashCode

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

isStopwatch

fun isStopwatch(): Boolean

Whether this TimeDifference value represents a stopwatch -- when running, it counts up from getZeroTime() (or getZeroElapsedRealtime()).

isTimer

fun isTimer(): Boolean

Whether this TimeDifference value represents a timer -- when running, it counts down to getZeroTime() (or getZeroElapsedRealtime()).

toString

fun toString(): String

Returns a string representation of the object.