org.ofbiz.base.util
Class TimeDuration

java.lang.Object
  org.ofbiz.base.util.TimeDuration

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TimeDuration.NullDuration

public class TimeDuration
extends java.lang.Object
implements java.io.Serializable

A representation of a period of time.

See Also:

Serialized Form

Nested Class Summary

protected static class

TimeDuration.NullDuration

Field Summary

protected int	days
protected int	hours
protected int	millis
protected int	minutes
protected int	months
protected int	seconds
protected int	years
static TimeDuration	ZeroTimeDuration A TimeDuration instance that represents a zero time duration.

Constructor Summary

protected	TimeDuration()
	TimeDuration(java.util.Calendar cal1, java.util.Calendar cal2) Elapsed time constructor.
	TimeDuration(int years, int months, int days, int hours, int minutes, int seconds, int millis)

Method Summary

java.util.Calendar	addToCalendar(java.util.Calendar cal) Add this time duration to a Calendar instance.
protected int	advanceCalendar(java.util.Calendar start, java.util.Calendar end, int units, int type)
int	days() Returns the days in this time duration.
boolean	equals(java.lang.Object obj)
static TimeDuration	fromLong(long millis) Returns a TimeDuration instance derived from a long value.
int	hours() Returns the hours in this time duration.
protected void	makeNegative()
int	millis() Returns the milliseconds in this time duration.
int	minutes() Returns the minutes in this time duration.
int	months() Returns the months in this time duration.
int	seconds() Returns the seconds in this time duration.
protected void	set(java.util.Calendar cal1, java.util.Calendar cal2)
static long	toLong(TimeDuration duration) Returns a long value derived from a TimeDuration instance.
java.lang.String	toString()
int	years() Returns the years in this time duration.

Methods inherited from class java.lang.Object

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

Field Detail

ZeroTimeDuration

public static final TimeDuration ZeroTimeDuration

A TimeDuration instance that represents a zero time duration.

millis

protected int millis

seconds

protected int seconds

minutes

protected int minutes

hours

protected int hours

days

protected int days

months

protected int months

years

protected int years

Constructor Detail

TimeDuration

protected TimeDuration()

TimeDuration

public TimeDuration(int years,
                    int months,
                    int days,
                    int hours,
                    int minutes,
                    int seconds,
                    int millis)

Parameters:

years - The number of years in this duration

months - The number of months in this duration

days - The number of days in this duration

hours - The number of hours in this duration

minutes - The number of minutes in this duration

seconds - The number of years in this duration

millis - The number of milliseconds in this duration

TimeDuration

public TimeDuration(java.util.Calendar cal1,
                    java.util.Calendar cal2)

Elapsed time constructor. The time duration will be computed from the two Calendar instances.

Parameters:

cal1 -

cal2 -

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

millis

public int millis()

Returns the milliseconds in this time duration.

seconds

public int seconds()

Returns the seconds in this time duration.

minutes

public int minutes()

Returns the minutes in this time duration.

hours

public int hours()

Returns the hours in this time duration.

days

public int days()

Returns the days in this time duration.

months

public int months()

Returns the months in this time duration.

years

public int years()

Returns the years in this time duration.

addToCalendar

public java.util.Calendar addToCalendar(java.util.Calendar cal)

Add this time duration to a Calendar instance. Returns the original Calendar instance.

Parameters:

cal -

Returns:

cal

set

protected void set(java.util.Calendar cal1,
                   java.util.Calendar cal2)

advanceCalendar

protected int advanceCalendar(java.util.Calendar start,
                              java.util.Calendar end,
                              int units,
                              int type)

makeNegative

protected void makeNegative()

fromLong

public static TimeDuration fromLong(long millis)

Returns a TimeDuration instance derived from a long value. This method is intended to be used in tandem with the toLong method.

The years and months portions of the returned object are based on a Gregorian calendar. Note: this method should not be used to calculate elapsed time - use the elapsed time constructor instead.

Parameters:

millis - A millisecond value

Returns:

A TimeDuration instance

toLong

public static long toLong(TimeDuration duration)

Returns a long value derived from a TimeDuration instance. This method is intended to be used in tandem with the fromLong method.

Parameters:

duration -

Returns:

the number number of milliseconds in the duration