com.mgnt.utils.entities

Class TimeInterval

java.lang.Object

com.mgnt.utils.entities.TimeInterval

All Implemented Interfaces:

java.lang.Comparable<TimeInterval>

public class TimeInterval
extends java.lang.Object
implements java.lang.Comparable<TimeInterval>

This is convenience class that holds time interval as numerical value and its associated TimeUnit. The class also provides methods of retrieval of its value as a long in needed scale (nanoseconds, milliseconds, seconds, minutes, hours or days) see methods toNanos(), toMillis(), toSeconds(), toMinutes(), toHours(), toDays()

Constructor Summary

Constructors

Constructor and Description
TimeInterval() Default constructor
TimeInterval(long interval, java.util.concurrent.TimeUnit timeUnit) Constructor that allows to create initialized instance

Method Summary

Modifier and Type	Method and Description
int	compareTo(TimeInterval o)
boolean	equals(java.lang.Object o)
java.util.concurrent.TimeUnit	getTimeUnit() TimeUnit getter
long	getValue() Time interval numerical value getter (without time unit)
int	hashCode()
void	setTimeUnit(java.util.concurrent.TimeUnit timeUnit) TimeUnit Setter
void	setValue(long value) Numerical value setter
long	toDays() returns long value of this TimeInterval in days
long	toHours() returns long value of this TimeInterval in hours
long	toMillis() returns long value of this TimeInterval in milliseconds
long	toMinutes() returns long value of this TimeInterval in minutes
long	toNanos() returns long value of this TimeInterval in nanoseconds
long	toSeconds() returns long value of this TimeInterval in seconds
java.lang.String	toString() Provides String representation of the value such as "3 MILLISECONDS".

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeInterval

public TimeInterval()

Default constructor

TimeInterval

public TimeInterval(long interval,
                    java.util.concurrent.TimeUnit timeUnit)

Constructor that allows to create initialized instance

Parameters:

interval - time value

timeUnit - TimeUnit that defines scale

Method Detail

getValue

public long getValue()

Time interval numerical value getter (without time unit)

Returns:

Time Interval numerical value

setValue

public void setValue(long value)

Numerical value setter

Parameters:

value -

getTimeUnit

public java.util.concurrent.TimeUnit getTimeUnit()

TimeUnit getter

Returns:

TimeUnit of this TimeInterval

setTimeUnit

public void setTimeUnit(java.util.concurrent.TimeUnit timeUnit)

TimeUnit Setter

Parameters:

timeUnit -

toNanos

public long toNanos()

returns long value of this TimeInterval in nanoseconds

Returns:

long

toMillis

public long toMillis()

returns long value of this TimeInterval in milliseconds

Returns:

long

toSeconds

public long toSeconds()

returns long value of this TimeInterval in seconds

Returns:

long

toMinutes

public long toMinutes()

returns long value of this TimeInterval in minutes

Returns:

long

toHours

public long toHours()

returns long value of this TimeInterval in hours

Returns:

long

toDays

public long toDays()

returns long value of this TimeInterval in days

Returns:

long

toString

public java.lang.String toString()

Provides String representation of the value such as "3 MILLISECONDS".

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(TimeInterval o)

Specified by:

compareTo in interface java.lang.Comparable<TimeInterval>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object