com.hfg.units

Class TimeSpan

java.lang.Object

com.hfg.units.Quantity

com.hfg.units.TimeSpan

All Implemented Interfaces:

Comparable

public class TimeSpan
extends Quantity

Quantity of time.

Constructor Summary

Constructors

Constructor and Description
TimeSpan(Double inValue, TimeUnit inUnit)
TimeSpan(Float inValue, String inUnit) Convenience constructor that will call TimeUnit.valueOf() on the specified unit string.
TimeSpan(Float inValue, TimeUnit inUnit)
TimeSpan(Integer inValue, String inUnit) Convenience constructor that will call TimeUnit.valueOf() on the specified unit string.
TimeSpan(Integer inValue, TimeUnit inUnit)
TimeSpan(Long inValue, String inUnit) Convenience constructor that will call TimeUnit.valueOf() on the specified unit string.
TimeSpan(Long inValue, TimeUnit inUnit)
TimeSpan(String inValue) Convenience constructor.

Method Summary

Modifier and Type	Method and Description
long	getMilliseconds() Returns the time span's length in milliseconds.
TimeUnit	getUnit()

Methods inherited from class com.hfg.units.Quantity

add, autoScale, autoScale, compareTo, convertTo, divideBy, doubleValue, equals, floatValue, greaterThan, greaterThanOrEqualTo, hashCode, intValue, invert, lessThan, lessThanOrEqualTo, longValue, multiplyBy, scale, subtract, toString, toString, toString, verifyQuantityType

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSpan

public TimeSpan(Float inValue,
                String inUnit)

Convenience constructor that will call TimeUnit.valueOf() on the specified unit string.

Parameters:

inValue - the numeric amount as a float

inUnit - the time unit of the specified amount

TimeSpan

public TimeSpan(Integer inValue,
                String inUnit)

Convenience constructor that will call TimeUnit.valueOf() on the specified unit string.

Parameters:

inValue - the numeric amount as an integer

inUnit - the time unit of the specified amount

TimeSpan

public TimeSpan(Long inValue,
                String inUnit)

Convenience constructor that will call TimeUnit.valueOf() on the specified unit string.

Parameters:

inValue - the numeric amount as a long

inUnit - the time unit of the specified amount

TimeSpan

public TimeSpan(Double inValue,
                TimeUnit inUnit)

TimeSpan

public TimeSpan(Float inValue,
                TimeUnit inUnit)

TimeSpan

public TimeSpan(Integer inValue,
                TimeUnit inUnit)

TimeSpan

public TimeSpan(Long inValue,
                TimeUnit inUnit)

TimeSpan

public TimeSpan(String inValue)

Convenience constructor.

Parameters:

inValue - the string value

Method Detail

getUnit

public TimeUnit getUnit()

Overrides:

getUnit in class Quantity

getMilliseconds

public long getMilliseconds()

Returns the time span's length in milliseconds. Note that the values for MONTH and YEAR are approximations.

Returns:

the length of time in milliseconds that corresponds to this span of time.