Package io.github.srcimon.screwbox.core

Class Duration

java.lang.Object

io.github.srcimon.screwbox.core.Duration

All Implemented Interfaces:

Serializable

public class Duration
extends Object
implements Serializable

Represents a Duration between two Times.

See Also:

• Time
• Serialized Form

Method Summary

Modifier and Type	Method	Description
Duration	add(Duration other)	Adds another Duration to this Duration.
Time	addTo(Time time)	Adds this Duration on the given Time.
static Duration	between(Time aTime, Time anotherTime)	Creates a new instance with the duration between two given Time values.
boolean	equals(Object obj)
int	hashCode()
String	humanReadable()	Returns a human readable String of the Duration.
boolean	isAtLeast(Duration other)	Returns true if the Duration is at least that long with the other Duration.
boolean	isLessThan(Duration other)	Returns true if the Duration is at less than the other Duration.
boolean	isNone()	Checks if duration has no length.
long	milliseconds()	Returns the total milliseconds of the Duration.
long	nanos()	Returns the total nanoseconds of the Duration.
static Duration	none()	Creates a new instance with no duration at all.
static Duration	ofExecution(Runnable execution)	Creates a new instance with the duration of the time it took to execute the given Runnable.
static Duration	ofMicros(long micros)	Creates a new instance with the duration of the given value of microseconds.
static Duration	ofMillis(long millis)	Creates a new instance with the duration of the given value of milliseconds.
static Duration	ofNanos(long nanos)	Creates a new instance with the duration of the given value of nanoseconds.
static Duration	ofSeconds(long seconds)	Creates a new instance with the duration of the given value of seconds.
long	seconds()	Returns the total seconds of the Duration.
static Duration	since(Time time)	Creates a new instance with the duration since the given Time value.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

ofNanos

public static Duration ofNanos(long nanos)

Creates a new instance with the duration of the given value of nanoseconds.

See Also:

• ofMillis(long)
• ofSeconds(long)
• ofMicros(long)

ofMicros

public static Duration ofMicros(long micros)

Creates a new instance with the duration of the given value of microseconds.

See Also:

• ofMillis(long)
• ofSeconds(long)
• ofNanos(long)

ofMillis

public static Duration ofMillis(long millis)

Creates a new instance with the duration of the given value of milliseconds.

See Also:

• ofNanos(long)
• ofSeconds(long)
• ofMicros(long)

ofSeconds

public static Duration ofSeconds(long seconds)

Creates a new instance with the duration of the given value of seconds.

See Also:

• ofMillis(long)
• ofNanos(long)
• ofMicros(long)

since

public static Duration since(Time time)

Creates a new instance with the duration since the given Time value.

See Also:

• ofExecution(Runnable)

none

public static Duration none()

Creates a new instance with no duration at all.

See Also:

• isNone()

isNone

public boolean isNone()

Checks if duration has no length.

ofExecution

public static Duration ofExecution(Runnable execution)

Creates a new instance with the duration of the time it took to execute the given Runnable.

Parameters:

execution - the execution that is measured

between

public static Duration between(Time aTime,
 Time anotherTime)

Creates a new instance with the duration between two given Time values.

milliseconds

public long milliseconds()

Returns the total milliseconds of the Duration.

See Also:

• nanos()
• seconds()

nanos

public long nanos()

Returns the total nanoseconds of the Duration.

See Also:

• milliseconds()
• seconds()

seconds

public long seconds()

Returns the total seconds of the Duration.

See Also:

• nanos()
• milliseconds()

add

public Duration add(Duration other)

Adds another Duration to this Duration.

Parameters:

other - the Duration to add

Returns:

the resulting Duration

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isAtLeast

public boolean isAtLeast(Duration other)

Returns true if the Duration is at least that long with the other Duration.

isLessThan

public boolean isLessThan(Duration other)

Returns true if the Duration is at less than the other Duration.

addTo

public Time addTo(Time time)

Adds this Duration on the given Time.

humanReadable

public String humanReadable()

Returns a human readable String of the Duration.