Interval (OpenClover 4.5.2 API)

java.lang.Object
- com.atlassian.clover.cfg.Interval

```
public class Interval
extends Object
```
An interval represents a period of time.
An interval has two components - The magnitude of the interval and the units of the interval.
The class must be configured through a static method to define the acceptable units, the base unit and the relative size of the units.

Field Summary

Fields
Modifier and Type	Field and Description
`static Interval`	`DEFAULT_SPAN`
`static int`	`UNIT_DAY` Unit for Days
`static int`	`UNIT_HOUR` Unit for Hours
`static int`	`UNIT_MINUTE` Unit for Minutes
`static int`	`UNIT_MONTH` Unit for Months
`static int`	`UNIT_SECOND` Unit for Seconds
`static int`	`UNIT_WEEK` Unit for Weeks
`static int`	`UNIT_YEAR` Unit for Years
`static Interval`	`ZERO_INTERVAL` A Zero interval
`static Interval`	`ZERO_SECONDS`

Constructor Summary

Constructors
Constructor and Description
`Interval(BigDecimal magnitude, int unit)` Create an interval from a magnitude and a unit.
`Interval(double magnitude, int unit)` Create an interval from a magnitude and a unit.
`Interval(long magnitude, int unit)` Create an interval from a magnitude and a unit.
`Interval(String timeDescription)` Create an interval from a string description.
`Interval(String timeDescription, int defaultUnit)` Constructor for an Interval that takes a default time unit.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Interval`	`add(Interval rhs)` Add the given interval to this interval producing a new interval.
`int`	`compareTo(Interval rhs)` Compare two intervals - This will normalize the intervals to the same base unit and compare them
`boolean`	`equals(Object rhs)` Check this interval for equality to another object.
`BigDecimal`	`getMagnitude()` Get the magnitude of this interval
`int`	`getUnit()` Get the unit for this interval.
`long`	`getValueInMillis()`
`BigDecimal`	`getValueInUnits(int desiredUnit)` Get the magnitude of this interval in the given unit.
`int`	`hashCode()` Generate the hash code for this interval
`int`	`signum()` Indicate the sign of the Interval' magnitude component
`Interval`	`subtract(Interval rhs)` Subtract the given interval from this interval to produce a new interval.
`String`	`toIntString(int desiredUnit)`
`String`	`toSensibleString()` Convert to an string representation, choosing a sensible unit depending on the value of the interval
`String`	`toString()` Convert this interval to its string representation.
`String`	`toString(int desiredUnit)` Convert the interval to a string in the given unit

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

- Field Detail
  - UNIT_SECOND
```
public static final int UNIT_SECOND
```
    Unit for Seconds
    
    See Also:
    
    Constant Field Values
  - UNIT_MINUTE
```
public static final int UNIT_MINUTE
```
    Unit for Minutes
    
    See Also:
    
    Constant Field Values
  - UNIT_HOUR
```
public static final int UNIT_HOUR
```
    Unit for Hours
    
    See Also:
    
    Constant Field Values
  - UNIT_DAY
```
public static final int UNIT_DAY
```
    Unit for Days
    
    See Also:
    
    Constant Field Values
  - UNIT_WEEK
```
public static final int UNIT_WEEK
```
    Unit for Weeks
    
    See Also:
    
    Constant Field Values
  - UNIT_MONTH
```
public static final int UNIT_MONTH
```
    Unit for Months
    
    See Also:
    
    Constant Field Values
  - UNIT_YEAR
```
public static final int UNIT_YEAR
```
    Unit for Years
    
    See Also:
    
    Constant Field Values
  - ZERO_SECONDS
```
public static final Interval ZERO_SECONDS
```
  - DEFAULT_SPAN
```
public static final Interval DEFAULT_SPAN
```
  - ZERO_INTERVAL
```
public static final Interval ZERO_INTERVAL
```
    A Zero interval
- Constructor Detail
  - Interval
```
public Interval(BigDecimal magnitude,
                int unit)
```
    Create an interval from a magnitude and a unit.
    
    Parameters:
    
    magnitude - the interval's desired magnitude.
    
    unit - the desired unit for this interval.
  - Interval
```
public Interval(long magnitude,
                int unit)
```
    Create an interval from a magnitude and a unit.
    
    Parameters:
    
    magnitude - the interval's desired magnitude.
    
    unit - the desired unit for this interval.
  - Interval
```
public Interval(double magnitude,
                int unit)
```
    Create an interval from a magnitude and a unit.
    
    Parameters:
    
    magnitude - the interval's desired magnitude.
    
    unit - the desired unit for this interval.
  - Interval
```
public Interval(String timeDescription,
                int defaultUnit)
```
    Constructor for an Interval that takes a default time unit.
    
    Parameters:
    
    timeDescription - a string rep of the time interval
    
    defaultUnit - the unit to default to if timeDescription contains no unit
    
    Throws:
    
    NumberFormatException - if not a valid time
  - Interval
```
public Interval(String timeDescription)
```
    Create an interval from a string description.
    
    Parameters:
    
    timeDescription - The interval description consisting of a number, the magnitude of the interval, and a word describing the unit.
    
    Throws:
    
    NumberFormatException - if not a valid time
- Method Detail
  - getValueInUnits
```
public BigDecimal getValueInUnits(int desiredUnit)
```
    Get the magnitude of this interval in the given unit.
    
    Parameters:
    
    desiredUnit - the unit in which the interval's magnitude is desired.
    
    Returns:
    
    the magnitude of the interval in the given unit.
  - getValueInMillis
```
public long getValueInMillis()
```
    Returns:
    
    the interval in milliseconds. No overflow checks are done.
  - toString
```
public String toString(int desiredUnit)
```
    Convert the interval to a string in the given unit
    
    Parameters:
    
    desiredUnit - the unit in which the intervale is to be expressed.
    
    Returns:
    
    the string representation of the interval in the given unit.
  - toIntString
```
public String toIntString(int desiredUnit)
```
  - toString
```
public String toString()
```
    Convert this interval to its string representation.
    
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - toSensibleString
```
public String toSensibleString()
```
    Convert to an string representation, choosing a sensible unit depending on the value of the interval
  - getUnit
```
public int getUnit()
```
    Get the unit for this interval.
    
    Returns:
    
    the int representing the unit.
  - getMagnitude
```
public BigDecimal getMagnitude()
```
    Get the magnitude of this interval
    
    Returns:
    
    the magnitude of this interval - regardless of units
  - compareTo
```
public int compareTo(Interval rhs)
```
    Compare two intervals - This will normalize the intervals to the same base unit and compare them
    
    Parameters:
    
    rhs - the interval to be compared to this one
    
    Returns:
    
    -1, 0 or 1 indicating whether this intervale is less than, equal or greater than the given interval
  - equals
```
public boolean equals(Object rhs)
```
    Check this interval for equality to another object. This will only return true if the two intervals have the same magntiude and units. This includes the scales of the interval magnitudes.
    
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Generate the hash code for this interval
    
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - subtract
```
public Interval subtract(Interval rhs)
```
    Subtract the given interval from this interval to produce a new interval. The units of this interval are preferred to that of the rhs. If the magnitude of the result drops below 0.5, the smaller unit is then used.
    
    Parameters:
    
    rhs - the interval to be subracted from this interval.
    
    Returns:
    
    the result of subtracting the rhs from this interval.
  - add
```
public Interval add(Interval rhs)
```
    Add the given interval to this interval producing a new interval. The time unit's of this interval is retained in the result.
    
    Parameters:
    
    rhs - the Right Hand Side of the addtion
    
    Returns:
    
    an Intervale object being the addition of this interval and the rhs interval.
  - signum
```
public int signum()
```
    Indicate the sign of the Interval' magnitude component
    
    Returns:
    
    -1, 0, 1 indicating the sign of the magnitude

Class Interval

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNIT_SECOND

UNIT_MINUTE

UNIT_HOUR

UNIT_DAY

UNIT_WEEK

UNIT_MONTH

UNIT_YEAR

ZERO_SECONDS

DEFAULT_SPAN

ZERO_INTERVAL

Constructor Detail

Interval

Interval

Interval

Interval

Interval

Method Detail

getValueInUnits

getValueInMillis

toString

toIntString

toString

toSensibleString

getUnit

getMagnitude

compareTo

equals

hashCode

subtract

add

signum