@ThreadSafe public class TimeDuration extends Object implements Serializable, Comparable<TimeDuration>
Modifier and Type | Class and Description |
---|---|
protected static class |
TimeDuration.NullDuration |
Modifier and Type | Field and Description |
---|---|
protected int |
days |
protected int |
hours |
protected int |
milliseconds |
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 and Description |
---|
TimeDuration(com.ibm.icu.util.Calendar cal1,
com.ibm.icu.util.Calendar cal2)
Elapsed time constructor.
|
TimeDuration(int years,
int months,
int days,
int hours,
int minutes,
int seconds,
int milliseconds) |
Modifier and Type | Method and Description |
---|---|
com.ibm.icu.util.Calendar |
addToCalendar(com.ibm.icu.util.Calendar cal)
Add this time duration to a Calendar instance.
|
int |
compareTo(TimeDuration arg0) |
int |
days()
Returns the days in this time duration.
|
boolean |
equals(Object obj) |
static TimeDuration |
fromLong(long duration)
Returns a
TimeDuration instance derived from an encoded
long value. |
static TimeDuration |
fromNumber(Number number)
Returns a
TimeDuration instance derived from a Number
instance. |
int |
hashCode() |
int |
hours()
Returns the hours in this time duration.
|
boolean |
isNegative()
Returns
true if this duration is negative. |
boolean |
isZero()
Returns
true if this duration is zero. |
int |
milliseconds()
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.
|
static TimeDuration |
parseDuration(String duration) |
int |
seconds()
Returns the seconds in this time duration.
|
static long |
toLong(TimeDuration duration)
Returns a
long value derived from a TimeDuration
instance. |
String |
toString()
Returns a
String formatted as
years:months:days:hours:minutes:seconds:millseconds. |
int |
years()
Returns the years in this time duration.
|
public static final TimeDuration ZeroTimeDuration
TimeDuration
instance that represents a zero time duration.protected final int milliseconds
protected final int seconds
protected final int minutes
protected final int hours
protected final int days
protected final int months
protected final int years
public TimeDuration(int years, int months, int days, int hours, int minutes, int seconds, int milliseconds)
years
- The number of years in this durationmonths
- The number of months in this durationdays
- The number of days in this durationhours
- The number of hours in this durationminutes
- The number of minutes in this durationseconds
- The number of years in this durationmilliseconds
- The number of milliseconds in this durationpublic TimeDuration(com.ibm.icu.util.Calendar cal1, com.ibm.icu.util.Calendar cal2)
Calendar
instances.cal1
- cal2
- public String toString()
String
formatted as
years:months:days:hours:minutes:seconds:millseconds.public int compareTo(TimeDuration arg0)
compareTo
in interface Comparable<TimeDuration>
public boolean isNegative()
true
if this duration is negative.true
if this duration is negativepublic boolean isZero()
true
if this duration is zero.true
if this duration is zeropublic int milliseconds()
public int seconds()
public int minutes()
public int hours()
public int days()
public int months()
public int years()
public com.ibm.icu.util.Calendar addToCalendar(com.ibm.icu.util.Calendar cal)
cal
- cal
public static TimeDuration fromLong(long duration)
TimeDuration
instance derived from an encoded
long
value. This method is intended to be used in tandem with the
toLong
method. Note: this
method should not be used to calculate elapsed time - use the elapsed
time constructor instead.duration
- An encoded durationTimeDuration
instancepublic static TimeDuration fromNumber(Number number)
TimeDuration
instance derived from a Number
instance. If number
is null
,
returns a zero TimeDuration
.This is a convenience method
intended to be used with entity engine fields. Some duration fields are
stored as a Long
, while others are stored as a
Double
. This method will decode both types.
number
- A Number
instance, can be null
TimeDuration
instancepublic static TimeDuration parseDuration(String duration)
public static long toLong(TimeDuration duration)
long
value derived from a TimeDuration
instance. This method is intended to be used in tandem with the
fromLong
method.duration
- long
value