net.sf.japaki.basic
Class Duration

java.lang.Object
  net.sf.japaki.basic.Duration

All Implemented Interfaces:

Comparable<Duration>, Quasigroup<Duration>

public class Duration
extends Object
implements Comparable<Duration>, Quasigroup<Duration>

An elapsed time in milliseconds. It facilitates the breakdown in

• days,
• hours,
• minutes,
• seconds and
• split (milli) seconds.
Negative durations are supported, but then all fields contain absolute values.

Constructor Summary

Duration(int days, int hours, int minutes, int seconds, int millis)
Constructs a new duration.

Duration(long millis)
Constructs a new duration.

Method Summary

Duration	add(Duration other) Add other to this object and return the sum.
void	addTo(Calendar calendar) Add this duration to the calendar.
void	addTo(Date date) Add this duration to the date.
int	compareTo(Duration other)
boolean	equals(Object obj)
long	getTimeInMillis() Returns this duration's value in milliseconds.
int	hashCode()
Duration	inverse() Returns the inverse of this object.
String	toString() Returns a string representation of this duration.

Methods inherited from class java.lang.Object

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

Constructor Detail

Duration

public Duration(long millis)

Constructs a new duration.

Parameters:

millis - The duration's value in milliseconds.

Throws:

OutOfRangeException - if the number of days is not in the integer range

Duration

public Duration(int days,
                int hours,
                int minutes,
                int seconds,
                int millis)

Constructs a new duration.

Method Detail

getTimeInMillis

public long getTimeInMillis()

Returns this duration's value in milliseconds.

Returns:

this duration's value in milliseconds

addTo

public void addTo(Calendar calendar)

Add this duration to the calendar.

Parameters:

calendar - summand and result of the sum

addTo

public void addTo(Date date)

Add this duration to the date.

Parameters:

date - summand and result of the sum

add

public Duration add(Duration other)

Description copied from interface: Quasigroup

Add other to this object and return the sum.

Specified by:

add in interface Quasigroup<Duration>

Parameters:

other - the other summand

Returns:

the sum of this and the other object

inverse

public Duration inverse()

Description copied from interface: Quasigroup

Returns the inverse of this object.

Specified by:

inverse in interface Quasigroup<Duration>

Returns:

the inverse of this object.

compareTo

public int compareTo(Duration other)

Specified by:

compareTo in interface Comparable<Duration>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Returns a string representation of this duration.

Overrides:

toString in class Object

Returns:

a string representation of this duration