Duration

java.lang.Object
- java.lang.Number
- - uk.ac.ed.epcc.webapp.model.data.Duration

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Duration>
```
public class Duration
extends java.lang.Number
implements java.lang.Comparable<Duration>
```
A class to represent durations of time. Java does not have such a notion in a simple form - the java Duration object is quite complex, allowing durations in months and years that can't necessarily be compared. This is a simple implementation that just wraps around a long. Most constructors for these objects work in seconds. Seconds were chosen primarily because the SI unit of time is a second, so it seems as good a choice as any. Many durations stored in various formats are accurate to at least seconds but not necessarily any more. Internally the value is stored in milliseconds but can be overridden Duration extends Number and the numerical value is milliseconds. This is the value used when storing Durations to the database. However by default If you wish to persist objects in custom units a DurationFieldValue with a custom resolution must be installed in the factory.

Though the numerical value is held in milliseconds the accuracy of the duration is not guaranteed to anything finer than a second. Currently, the implementation stores durations in milliseconds so will be accurate to the millisecond. As with any measurement, this object will only be as accurate as the values given to it. If the accuracy of a duration is less than a second during construction, it will never be more accurate.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static long SCALE
The ratio of seconds to value stored (1:SCALE).

Fields
Modifier and Type	Field and Description
`static long`	`SCALE` The ratio of seconds to value stored (1:SCALE).

Constructor Summary

Constructors
Constructor and Description
`Duration(java.util.Date durationSince1970)` Constructs a new `Duration` using the date provided by assuming the date is actually intended to represent a duration.
`Duration(java.util.Date start, java.util.Date end)`
`Duration(double value)` Constructs a new `Duration` based on the specified time given in seconds.
`Duration(float value)` Constructs a new `Duration` based on the specified time given in seconds.
`Duration(int value)` Constructs a new `Duration` based on the specified time given in seconds.
`Duration(long value)` Constructs a new `Duration` based on the specified time given in seconds.
`Duration(java.lang.Number value)` Constructs a new `Duration` based on the specified time given in seconds.
`Duration(java.lang.Number value, long scale)` Constructs a new `Duration` based on the specified time in some unit.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Duration`	`add(Duration duration)` Returns a new `Duration` object that is equivalent to this duration and the specified duration added together.
`int`	`compareTo(Duration o)`
`double`	`doubleValue()`
`boolean`	`equals(Duration duration)`
`boolean`	`equals(java.lang.Object o)` This duration is equal to the other object if that object is a `Duration` object and lasts for exactly the same length of time as this duration
`float`	`floatValue()`
`long`	`getMilliseconds()` Converts this duration into a measurement of time in milliseconds.
`long`	`getSeconds()` Converts this duration into a measurement of time in seconds.
`long`	`getTime(long resolution)` Get the duration in a specified unit.
`int`	`hashCode()`
`int`	`intValue()`
`boolean`	`isLongerThan(Duration duration)` Test to see if this `Duration` is more than the specified duration
`boolean`	`isNegative()` Test to see if this `Duration` measures a negative time interval.
`boolean`	`isPositive()` Test to see if this `Duration` measures a positive time interval.
`boolean`	`isShorterThan(Duration duration)` Test to see if this `Duration` is less than the specified duration
`long`	`longValue()`
`Duration`	`multiply(double factor)` Returns a new `Duration` object that is equivalent to this duration multiplied by the specified factor.
`Duration`	`multiply(long factor)` Returns a new `Duration` object that is equivalent to this duration multiplied by the specified factor.
`Duration`	`negate()`
`Duration`	`subtract(Duration duration)` Returns a new `Duration` object that is equivalent to this `Duration` with the specified `Duration` subtracted from it.
`java.lang.String`	`toString()` Returns this duration represented as a string in seconds.

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SCALE
```
public static final long SCALE
```
    The ratio of seconds to value stored (1:SCALE). Changing this value will change the accuracy of the object (larger numbers => greater accuracy).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Duration
```
public Duration(java.lang.Number value)
```
    Constructs a new Duration based on the specified time given in seconds. Seconds is picked as the unit for the constructor because it's the SI unit for time
    
    Parameters:
    
    value - The duration measured in seconds.
  - Duration
```
public Duration(java.lang.Number value,
                long scale)
```
    Constructs a new Duration based on the specified time in some unit.
    
    Parameters:
    
    value - The duration measured.
    
    scale - The number of milliseconds per unit of the provided value
  - Duration
```
public Duration(java.util.Date durationSince1970)
```
    Constructs a new Duration using the date provided by assuming the date is actually intended to represent a duration. java.util.Date measures it's time from the start of January 1st 1970 so this is assumed to be the star time of the duration. If this assumption is incorrect, it may be more appropriate to use Duration(Date, Date) instead.
    
    Parameters:
    
    durationSince1970 - The duration, starting at 00:00:00.000 on January first 1970 and lasting until the date specified.
  - Duration
```
public Duration(java.util.Date start,
                java.util.Date end)
```
  - Duration
```
public Duration(double value)
```
    Constructs a new Duration based on the specified time given in seconds. Seconds is picked as the unit for the constructor because it's the SI unit for time
    
    Parameters:
    
    value - The duration measured in seconds.
  - Duration
```
public Duration(float value)
```
    Constructs a new Duration based on the specified time given in seconds. Seconds is picked as the unit for the constructor because it's the SI unit for time
    
    Parameters:
    
    value - The duration measured in seconds.
  - Duration
```
public Duration(int value)
```
    Constructs a new Duration based on the specified time given in seconds. Seconds is picked as the unit for the constructor because it's the SI unit for time
    
    Parameters:
    
    value - The duration measured in seconds.
  - Duration
```
public Duration(long value)
```
    Constructs a new Duration based on the specified time given in seconds. Seconds is picked as the unit for the constructor because it's the SI unit for time
    
    Parameters:
    
    value - The duration measured in seconds.
- Method Detail
  - equals
```
public boolean equals(java.lang.Object o)
```
    This duration is equal to the other object if that object is a Duration object and lasts for exactly the same length of time as this duration
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - The object for comparision
    
    Returns:
    
    true if the other object is a Duration that lasts exactly as long as this duration
    
    See Also:
    
    Object.equals(java.lang.Object)
  - equals
```
public boolean equals(Duration duration)
```
    Parameters:
    
    duration -
    
    Returns:
    
    boolean
    
    See Also:
    
    equals(Object)
  - getMilliseconds
```
public long getMilliseconds()
```
    Converts this duration into a measurement of time in milliseconds. This method guarantees millisecond precision but not millisecond accuracy.
    
    Returns:
    
    This duration measured in milliseconds as a long.
  - getTime
```
public long getTime(long resolution)
```
    Get the duration in a specified unit.
    
    Parameters:
    
    resolution - size of unit in milliseconds.
    
    Returns:
  - getSeconds
```
public long getSeconds()
```
    Converts this duration into a measurement of time in seconds.
    
    Returns:
    
    This duration measured in seconds as a long.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - isShorterThan
```
public boolean isShorterThan(Duration duration)
```
    Test to see if this Duration is less than the specified duration
    
    Parameters:
    
    duration - The duration for comparison
    
    Returns:
    
    true if this duration is less than the specified duration. false if it is the same or longer.
  - isLongerThan
```
public boolean isLongerThan(Duration duration)
```
    Test to see if this Duration is more than the specified duration
    
    Parameters:
    
    duration - The duration for comparison
    
    Returns:
    
    true if this duration is more than the specified duration. false if it is the same or less.
  - isNegative
```
public boolean isNegative()
```
    Test to see if this Duration measures a negative time interval. In other words, the duration is less than zero seconds in length
    
    Returns:
    
    true if the length of this duration is less than 0 seconds. false if it is zero or positive
  - isPositive
```
public boolean isPositive()
```
    Test to see if this Duration measures a positive time interval. In other words, the duration is less than zero seconds in length
    
    Returns:
    
    true if the length of this duration is greater or equal to 0 seconds. false if it is negative
  - toString
```
public java.lang.String toString()
```
    Returns this duration represented as a string in seconds. If this duration is accurate to less than one second, the value will be represented a a floating point number. If not, the value will be represented as an integer
    
    Overrides:
    
    toString in class java.lang.Object
  - add
```
public Duration add(Duration duration)
```
    Returns a new Duration object that is equivalent to this duration and the specified duration added together. Nether this object nor duration will be altered by this method
    
    Parameters:
    
    duration - The Duration that will be added with this Duration to form a new Duration.
    
    Returns:
    
    A new Duration that is the sum of this Duration and Duration
  - multiply
```
public Duration multiply(long factor)
```
    Returns a new Duration object that is equivalent to this duration multiplied by the specified factor.
    
    Parameters:
    
    factor - The quantity to multiply the length of this duration with
    
    Returns:
    
    A new Duration that is factor times bigger than this Duration.
  - multiply
```
public Duration multiply(double factor)
```
    Returns a new Duration object that is equivalent to this duration multiplied by the specified factor. TThe double argument allows factor to be less than zero, allowing division to be indirectly performed
    
    Parameters:
    
    factor - The quantity to multiply the length of this duration with
    
    Returns:
    
    A new Duration that is factor times bigger than this Duration.
  - negate
```
public Duration negate()
```
    Returns:
    
    the negative form of this Duration.
  - subtract
```
public Duration subtract(Duration duration)
```
    Returns a new Duration object that is equivalent to this Duration with the specified Duration subtracted from it. Nether this object nor duration will be altered by this method
    
    Parameters:
    
    duration - The Duration that will be subtracted from this Duration to form a new Duration.
    
    Returns:
    
    A new Duration that is equivalent to this Duration less duration
  - doubleValue
```
public double doubleValue()
```
    Specified by:
    
    doubleValue in class java.lang.Number
  - floatValue
```
public float floatValue()
```
    Specified by:
    
    floatValue in class java.lang.Number
  - intValue
```
public int intValue()
```
    Specified by:
    
    intValue in class java.lang.Number
  - longValue
```
public long longValue()
```
    Specified by:
    
    longValue in class java.lang.Number
  - compareTo
```
public int compareTo(Duration o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Duration>

Class Duration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

SCALE

Constructor Detail

Duration

Duration

Duration

Duration

Duration

Duration

Duration

Duration

Method Detail

equals

equals

getMilliseconds

getTime

getSeconds

hashCode

isShorterThan

isLongerThan

isNegative

isPositive

toString

add

multiply

multiply

negate

subtract

doubleValue

floatValue

intValue

longValue

compareTo