org.echocat.jomon.runtime.util

Class Duration

java.lang.Object

org.echocat.jomon.runtime.util.Duration

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Duration>

@Immutable
@ThreadSafe
public class Duration
extends java.lang.Object
implements java.lang.Comparable<Duration>, java.io.Serializable

Synopsis

A Duration represents a duration of time. The minimum unit are milliseconds.

It could be defined by an amount of milliseconds, a combination of amount and TimeUnit and a string pattern.

Pattern

Syntax

<amount>[<unit>][[ ]...]

Units

• S/ms: milliseconds
• s: seconds
• m: minutes
• h: hours
• d: days
• w: weeks

Examples

new Duration("1ms").toMilliSeconds() == 1
new Duration("1s").toMilliSeconds() == 1,000
new Duration("1m").toMilliSeconds() == 60,000
new Duration("1m10s").toMilliSeconds() == 70,000
new Duration("1m 10s").toMilliSeconds() == 70,000
new Duration("15").toMilliSeconds() == 15
new Duration("2s 15").toMilliSeconds() == 2,015

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Duration.Adapter

Constructor Summary

Constructors

Constructor and Description
Duration(java.util.Date from, java.util.Date to)
Duration(long milliSeconds)
Duration(long duration, java.util.concurrent.TimeUnit durationUnit)
Duration(java.lang.String plain)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Duration other)
Duration	dividedBy(double what)
Duration	dividedBy(long what)
static Duration	duration(Duration duration)
static Duration	duration(long duration)
static Duration	duration(java.lang.String duration)
static Duration	durationOf(Duration duration)
static Duration	durationOf(long duration)
static Duration	durationOf(java.lang.String duration)
boolean	equals(java.lang.Object o)
boolean	hasContent()
int	hashCode()
long	in(java.util.concurrent.TimeUnit timeUnit)
boolean	isEmpty()
boolean	isGreaterThan(Duration other)
boolean	isGreaterThan(long milliSeconds)
boolean	isGreaterThan(long amount, java.util.concurrent.TimeUnit unit)
boolean	isGreaterThan(java.lang.String other)
boolean	isGreaterThanOrEqualTo(Duration other)
boolean	isGreaterThanOrEqualTo(long milliSeconds)
boolean	isGreaterThanOrEqualTo(long amount, java.util.concurrent.TimeUnit unit)
boolean	isGreaterThanOrEqualTo(java.lang.String other)
boolean	isLessThan(Duration other)
boolean	isLessThan(long milliSeconds)
boolean	isLessThan(long amount, java.util.concurrent.TimeUnit unit)
boolean	isLessThan(java.lang.String other)
boolean	isLessThanOrEqualTo(Duration other)
boolean	isLessThanOrEqualTo(long milliSeconds)
boolean	isLessThanOrEqualTo(long amount, java.util.concurrent.TimeUnit unit)
boolean	isLessThanOrEqualTo(java.lang.String other)
Duration	minus(Duration duration)
Duration	minus(long milliSeconds)
Duration	minus(long amount, java.util.concurrent.TimeUnit unit)
Duration	minus(java.lang.String duration)
Duration	multiplyBy(double what)
Duration	multiplyBy(long what)
protected static long	oneIntervalToMilliSeconds(java.lang.String interval)
protected static long	oneUncheckedIntervalToMilliSeconds(java.lang.String interval)
protected static long	parsePattern(java.lang.String pattern)
Duration	plus(Duration duration)
Duration	plus(long milliSeconds)
Duration	plus(long amount, java.util.concurrent.TimeUnit unit)
Duration	plus(java.lang.String duration)
static Duration	since(long startTime) Returns a new Duration object for the time between now and the given startTime.
void	sleep()
static void	sleep(Duration duration)
static void	sleep(long milliSeconds)
static void	sleep(long amount, java.util.concurrent.TimeUnit unit)
static void	sleep(java.lang.String duration)
static void	sleepSafe(Duration duration)
static void	sleepSafe(long milliSeconds)
static void	sleepSafe(long amount, java.util.concurrent.TimeUnit unit)
static void	sleepSafe(java.lang.String duration)
void	sleepUnchecked()
long	toMilliSeconds()
java.lang.String	toPattern()
protected static java.lang.String	toPattern(long milliseconds)
java.lang.String	toString()
java.util.Map<java.util.concurrent.TimeUnit,java.lang.Long>	toUnitToValue()
protected static java.util.Map<java.util.concurrent.TimeUnit,java.lang.Long>	toUnitToValue(long milliseconds)
Duration	trim(java.util.concurrent.TimeUnit toUnit)

Methods inherited from class java.lang.Object

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

Constructor Detail

Duration

public Duration(@Nonnegative
        long milliSeconds)

Duration

public Duration(@Nonnegative
        long duration,
        java.util.concurrent.TimeUnit durationUnit)

Duration

public Duration(@Nonnull
        java.lang.String plain)
         throws java.lang.IllegalArgumentException

Parameters:

plain - See Duration

Throws:

java.lang.IllegalArgumentException

Duration

public Duration(@Nonnull
        java.util.Date from,
        @Nonnull
        java.util.Date to)

Method Detail

sleep

public static void sleep(@Nonnull
         java.lang.String duration)
                  throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

sleep

public static void sleep(@Nonnull
         Duration duration)
                  throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

sleep

public static void sleep(@Nonnegative
         long amount,
         @Nonnull
         java.util.concurrent.TimeUnit unit)
                  throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

sleep

public static void sleep(@Nonnegative
         long milliSeconds)
                  throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

sleepSafe

public static void sleepSafe(@Nonnull
             java.lang.String duration)
                      throws GotInterruptedException

Throws:

GotInterruptedException

sleepSafe

public static void sleepSafe(@Nonnull
             Duration duration)
                      throws GotInterruptedException

Throws:

GotInterruptedException

sleepSafe

public static void sleepSafe(@Nonnegative
             long amount,
             @Nonnull
             java.util.concurrent.TimeUnit unit)
                      throws GotInterruptedException

Throws:

GotInterruptedException

sleepSafe

public static void sleepSafe(@Nonnegative
             long milliSeconds)
                      throws GotInterruptedException

Throws:

GotInterruptedException

duration

@Nonnull
public static Duration duration(@Nonnull
                        Duration duration)

duration

@Nullable
public static Duration duration(@Nullable
                         java.lang.String duration)

duration

@Nullable
public static Duration duration(@Nonnegative
                         long duration)

durationOf

@Nonnull
public static Duration durationOf(@Nonnull
                          Duration duration)

durationOf

@Nullable
public static Duration durationOf(@Nullable
                           java.lang.String duration)

durationOf

@Nullable
public static Duration durationOf(@Nonnegative
                           long duration)

since

public static Duration since(long startTime)

Returns a new Duration object for the time between now and the given startTime.

Parameters:

startTime - the return value of a previous call to System.currentTimeMillis()

plus

@Nonnull
public Duration plus(@Nullable
                    java.lang.String duration)

plus

@Nonnull
public Duration plus(@Nullable
                    Duration duration)

plus

@Nonnull
public Duration plus(@Nonnegative
                    long amount,
                    @Nonnull
                    java.util.concurrent.TimeUnit unit)

plus

@Nonnull
public Duration plus(@Nonnegative
                    long milliSeconds)

minus

@Nonnull
public Duration minus(@Nullable
                     java.lang.String duration)

minus

@Nonnull
public Duration minus(@Nullable
                     Duration duration)

minus

@Nonnull
public Duration minus(@Nonnegative
                     long amount,
                     @Nonnull
                     java.util.concurrent.TimeUnit unit)

minus

@Nonnull
public Duration minus(@Nonnegative
                     long milliSeconds)

multiplyBy

@Nonnull
public Duration multiplyBy(double what)

dividedBy

@Nonnull
public Duration dividedBy(double what)

multiplyBy

@Nonnull
public Duration multiplyBy(long what)

dividedBy

@Nonnull
public Duration dividedBy(long what)

trim

@Nonnull
public Duration trim(@Nonnull
                    java.util.concurrent.TimeUnit toUnit)

toMilliSeconds

@Nonnegative
public long toMilliSeconds()

Returns:

the duration in milli seconds.

in

@Nonnegative
public long in(@Nonnull
                  java.util.concurrent.TimeUnit timeUnit)

toPattern

@Nonnull
public java.lang.String toPattern()

Returns:

See pattern.

toUnitToValue

@Nonnull
public java.util.Map<java.util.concurrent.TimeUnit,java.lang.Long> toUnitToValue()

isEmpty

public boolean isEmpty()

hasContent

public boolean hasContent()

isLessThan

public boolean isLessThan(@Nullable
                 java.lang.String other)

isLessThan

public boolean isLessThan(@Nullable
                 Duration other)

isLessThan

public boolean isLessThan(@Nonnegative
                 long amount,
                 @Nonnull
                 java.util.concurrent.TimeUnit unit)

isLessThan

public boolean isLessThan(@Nonnegative
                 long milliSeconds)

isLessThanOrEqualTo

public boolean isLessThanOrEqualTo(@Nullable
                          java.lang.String other)

isLessThanOrEqualTo

public boolean isLessThanOrEqualTo(@Nullable
                          Duration other)

isLessThanOrEqualTo

public boolean isLessThanOrEqualTo(@Nonnegative
                          long amount,
                          @Nonnull
                          java.util.concurrent.TimeUnit unit)

isLessThanOrEqualTo

public boolean isLessThanOrEqualTo(@Nonnegative
                          long milliSeconds)

isGreaterThan

public boolean isGreaterThan(@Nullable
                    java.lang.String other)

isGreaterThan

public boolean isGreaterThan(@Nullable
                    Duration other)

isGreaterThan

public boolean isGreaterThan(@Nonnegative
                    long amount,
                    @Nonnull
                    java.util.concurrent.TimeUnit unit)

isGreaterThan

public boolean isGreaterThan(@Nonnegative
                    long milliSeconds)

isGreaterThanOrEqualTo

public boolean isGreaterThanOrEqualTo(@Nullable
                             java.lang.String other)

isGreaterThanOrEqualTo

public boolean isGreaterThanOrEqualTo(@Nullable
                             Duration other)

isGreaterThanOrEqualTo

public boolean isGreaterThanOrEqualTo(@Nonnegative
                             long amount,
                             @Nonnull
                             java.util.concurrent.TimeUnit unit)

isGreaterThanOrEqualTo

public boolean isGreaterThanOrEqualTo(@Nonnegative
                             long milliSeconds)

sleep

public void sleep()
           throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

sleepUnchecked

public void sleepUnchecked()
                    throws GotInterruptedException

Throws:

GotInterruptedException

compareTo

public int compareTo(Duration other)

Specified by:

compareTo in interface java.lang.Comparable<Duration>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

oneUncheckedIntervalToMilliSeconds

@Nonnegative
protected static long oneUncheckedIntervalToMilliSeconds(@Nonnull
                                                  java.lang.String interval)

oneIntervalToMilliSeconds

@Nonnegative
protected static long oneIntervalToMilliSeconds(@Nonnull
                                         java.lang.String interval)

parsePattern

@Nonnegative
protected static long parsePattern(@Nonnull
                            java.lang.String pattern)
                            throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

toPattern

@Nonnull
protected static java.lang.String toPattern(@Nonnegative
                                 long milliseconds)

toUnitToValue

@Nonnull
protected static java.util.Map<java.util.concurrent.TimeUnit,java.lang.Long> toUnitToValue(@Nonnegative
                                                                                long milliseconds)