net.obvj.agents.util

Class TimeInterval

java.lang.Object

net.obvj.agents.util.TimeInterval

public class TimeInterval
extends Object

An object that represents a time interval, which consists of a duration and a TimeUnit, with advanced text parsing logic.

Author:

oswaldo.bapvic.jr

Constructor Summary

Constructors

Constructor and Description
TimeInterval(int duration, TimeUnit timeUnit) Builds a TimeInterval with a given duration and TimeUnit.
TimeInterval(TimeInterval source) Builds a new TimeInterval with the same attributes from a preset object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getDuration() Returns the duration of this TimeUnit.
TimeUnit	getTimeUnit() Returns the TimeUnit associated with this TimeInterval.
int	hashCode() Returns a hash code value for the object, to support hash tables.
static TimeInterval	of(String input) Builds a TimerInterval by parsing the given string.
long	toMillis() Returns this time interval's duration, in milliseconds.
String	toString() Returns a human-friendly string representation of this TimeInterval, for example: "2 minute(s)".

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeInterval

public TimeInterval(int duration,
                    TimeUnit timeUnit)

Builds a TimeInterval with a given duration and TimeUnit.

Parameters:

duration - the duration to set

timeUnit - the TimeUnit to set

TimeInterval

public TimeInterval(TimeInterval source)

Builds a new TimeInterval with the same attributes from a preset object.

Parameters:

source - the source object to be copied; not null

Throws:

NullPointerException - if the source TimeInterval is null

Method Detail

of

public static TimeInterval of(String input)

Builds a TimerInterval by parsing the given string.

For example: all of the following formats are recognized (case ignored):

• "1 second", or "1s"
• "60 SECONDS", or "60s"
• "25 minutes", or "25M"
• "1 HOUR", or "1h"

Parameters:

input - the string to be parsed

Returns:

a TimerInteral from the given input

Throws:

IllegalArgumentException - if the string is not in a valid TimeInterval format

getDuration

public int getDuration()

Returns the duration of this TimeUnit.

Returns:

the duration

getTimeUnit

public TimeUnit getTimeUnit()

Returns the TimeUnit associated with this TimeInterval.

Returns:

the interval's time unit

toMillis

public long toMillis()

Returns this time interval's duration, in milliseconds.

Returns:

the interval duration, in milliseconds

toString

public String toString()

Returns a human-friendly string representation of this TimeInterval, for example: "2 minute(s)".

Overrides:

toString in class Object

Returns:

the string representation of this object

See Also:

Object.toString()

hashCode

public int hashCode()

Returns a hash code value for the object, to support hash tables.

Overrides:

hashCode in class Object

Returns:

the hash code

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(Object)