TimeSpan (JHCaching 0.8 API)

java.lang.Object
- dk.heick.caching.utils.TimeSpan

All Implemented Interfaces:: Comparable<TimeSpan>

public class TimeSpan
extends Object
implements Comparable<TimeSpan>

TimeSpan holds a long value which a millisecond timespan in an immutable value class.

This can be created in multiple ways:

Milliseconds
Years, months, weeks, days, hours, minutes, seconds, milliseconds
The difference between two dates
The difference between a date and NOW.
As a special formatted text string the will be parsed.

Notes:

A name can be provided for the TimeSpan, otherwise a name will be generated in the form of parsable text for the Timespan. "(decimal[unit] |decimal )*".
Weeks will be converted into X*7 days.
Months will be converted into X*31 days.
A Timespan is converted into a value of milliseconds, which again is converted into milliseconds, seconds, minutes hours, days and years.
A Timespan can return a parsable text and readable caption of the timespan.

Text format:

Is a list of tokens, a double with a symbol at the end (no space between)
The tokens is divided by a space.
If a token has no symbol at the end, and is then just a double, it is considered as a milliseconds value.
A symbol can be list many times.

Time Unit	Unit symbol	Value in milliseconds	Examples
years	y or Y	365.252460601000	2y, 2Y,1.3y
months	M (casesensitive)	312460601000	2M,3.4M
weeks	w or W	72460601000	2W,3w,5.4w
days	d or D	246060*1000	14d,21D,12.34D
hours	h or H	60601000	14h,21H,12.34h
minutes	m (casesensitive)	60*1000	14m,21m,12.34m
seconds	s or S	1000	14s,21S,12.34s
milliseconds	(no symbol, default)	1	1,3453,343.43

Examples:

Text Value ="41y 84d 4h 48m 3s 1ms" , Caption="41 Years, 84 Days, 4 Hours, 48 Minutes, 3 Seconds, 1 Millisecond"

Author:: Frederik Heick
See Also:: TimeSpanUnit

Field Summary

Fields
Modifier and Type	Field and Description
`static TimeSpan`	`DAYS_01` 1 day
`static TimeSpan`	`DAYS_02` 2 days
`static TimeSpan`	`DAYS_03` 3 days
`static TimeSpan`	`DAYS_04` 4 days
`static TimeSpan`	`DAYS_05` 5 days
`static TimeSpan`	`DAYS_06` 6 days
`static TimeSpan`	`DAYS_07` 7 days
`static TimeSpan`	`DAYS_08` 8 days
`static TimeSpan`	`DAYS_09` 9 days
`static TimeSpan`	`DAYS_10` 10 days
`static TimeSpan`	`DAYS_11` 11 days
`static TimeSpan`	`DAYS_12` 12 days
`static TimeSpan`	`DAYS_13` 13 days
`static TimeSpan`	`DAYS_14` 14 days
`static TimeSpan`	`DAYS_15` 15 days
`static TimeSpan`	`DAYS_16` 16 days
`static TimeSpan`	`DAYS_17` 17 days
`static TimeSpan`	`DAYS_18` 18 days
`static TimeSpan`	`DAYS_19` 19 days
`static TimeSpan`	`DAYS_20` 20 days
`static TimeSpan`	`DAYS_21` 21 days
`static TimeSpan`	`DAYS_22` 22 days
`static TimeSpan`	`DAYS_23` 23 days
`static TimeSpan`	`DAYS_24` 24 days
`static TimeSpan`	`DAYS_25` 25 days
`static TimeSpan`	`DAYS_26` 26 days
`static TimeSpan`	`DAYS_27` 27 days
`static TimeSpan`	`DAYS_28` 28 days
`static TimeSpan`	`DAYS_29` 29 days
`static TimeSpan`	`DAYS_30` 30 days
`static TimeSpan`	`DAYS_31` 31 days
`static TimeSpan`	`HOURS_01` 1 hour
`static TimeSpan`	`HOURS_02` 2 hours
`static TimeSpan`	`HOURS_03` 3 hours
`static TimeSpan`	`HOURS_04` 4 hours
`static TimeSpan`	`HOURS_05` 5 hours
`static TimeSpan`	`HOURS_06` 6 hours
`static TimeSpan`	`HOURS_07` 7 hours
`static TimeSpan`	`HOURS_08` 8 hours
`static TimeSpan`	`HOURS_09` 9 hours
`static TimeSpan`	`HOURS_10` 10 hours
`static TimeSpan`	`HOURS_11` 11 hours
`static TimeSpan`	`HOURS_12` 12 hours
`static TimeSpan`	`HOURS_13` 13 hours
`static TimeSpan`	`HOURS_14` 14 hours
`static TimeSpan`	`HOURS_15` 15 hours
`static TimeSpan`	`HOURS_16` 16 hours
`static TimeSpan`	`HOURS_17` 17 hours
`static TimeSpan`	`HOURS_18` 18 hours
`static TimeSpan`	`HOURS_19` 19 hours
`static TimeSpan`	`HOURS_20` 20 hours
`static TimeSpan`	`HOURS_21` 21 hours
`static TimeSpan`	`HOURS_22` 22 hours
`static TimeSpan`	`HOURS_23` 23 hours
`static TimeSpan`	`HOURS_24` 24 hours
`static TimeSpan`	`MINUTES_01` 1 minut
`static TimeSpan`	`MINUTES_02` 2 minutes
`static TimeSpan`	`MINUTES_03` 3 minutes
`static TimeSpan`	`MINUTES_04` 4 minutes
`static TimeSpan`	`MINUTES_05` 5 minutes
`static TimeSpan`	`MINUTES_10` 10 minutes
`static TimeSpan`	`MINUTES_15` 15 minutes
`static TimeSpan`	`MINUTES_20` 20 minutes
`static TimeSpan`	`MINUTES_25` 25 minutes
`static TimeSpan`	`MINUTES_30` 30 minutes
`static TimeSpan`	`MINUTES_35` 35 minutes
`static TimeSpan`	`MINUTES_40` 40 minutes
`static TimeSpan`	`MINUTES_45` 45 minutes
`static TimeSpan`	`MINUTES_50` 50 minutes
`static TimeSpan`	`MINUTES_55` 55 minutes
`static TimeSpan`	`MINUTES_60` 60 minutes
`static TimeSpan`	`MONTHS_1` 1 month - 31 days
`static TimeSpan`	`MONTHS_12` 12 months - 12x 31 days
`static TimeSpan`	`MONTHS_2` 2 months - 2x 31 days
`static TimeSpan`	`MONTHS_3` 3 months - 3x 31 days
`static TimeSpan`	`MONTHS_6` 6 months - 6x 31 days
`static TimeSpan`	`MONTHS_9` 9 months - 9x 31 days
`static TimeSpan`	`SECONDS_01` 1 second
`static TimeSpan`	`SECONDS_15` 15 seconds
`static TimeSpan`	`SECONDS_30` 30 seconds
`static TimeSpan`	`SECONDS_45` 45 seconds
`static TimeSpan`	`SECONDS_60` 60seconds
`static long`	`UNIT_TIME_DAY`
`static long`	`UNIT_TIME_HOUR`
`static long`	`UNIT_TIME_MILLISECOND`
`static long`	`UNIT_TIME_MINUTE`
`static long`	`UNIT_TIME_MONTH`
`static long`	`UNIT_TIME_SECOND`
`static long`	`UNIT_TIME_WEEK`
`static long`	`UNIT_TIME_YEAR`
`static TimeSpan`	`WEEKS_1` 1 week - 7 days
`static TimeSpan`	`WEEKS_2` 2 weeks - 14 days
`static TimeSpan`	`WEEKS_3` 3 weeks - 21 days
`static TimeSpan`	`WEEKS_4` 4 weeks - 28 days
`static TimeSpan`	`YEARS_1` 1 year - 365 days
`static TimeSpan`	`YEARS_10` 10 years - 10x 365 days
`static TimeSpan`	`YEARS_100` 100 years - 100x 365 days
`static TimeSpan`	`YEARS_2` 2 years - 2x 365 days
`static TimeSpan`	`YEARS_25` 25 years - 25x 365 days
`static TimeSpan`	`YEARS_3` 3 years - 3x 365 days
`static TimeSpan`	`YEARS_5` 5 years - 5x 365 days
`static TimeSpan`	`YEARS_50` 50 years - 50x 365 days
`static TimeSpan`	`ZERO` 0 time

Constructor Summary

Constructors
Constructor and Description
`TimeSpan(int years, long months, long weeks, long days, long hours, long minutes, long seconds, long milliseconds)` Constructor using individual unit values, a name will be generated using the `getParsableText()` method.
`TimeSpan(long span)` Constructor, a name will be generated using the `getParsableText()` method.
`TimeSpan(String name, long span)` Constructor.
`TimeSpan(String name, long years, long months, long weeks, long days, long hours, long minutes, long seconds, long milliseconds)` Constructor using individual unit values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TimeSpan`	`add(long milliseconds)` Adds a milliseconds value to the current TimeSpan in a new TimeSpan instance.
`TimeSpan`	`add(TimeSpan value)` Adds a TimeSpan value to the current TimeSpan in a new TimeSpan instance.
`TimeSpan`	`add(TimeSpan value, int factor)` Adds a TimeSpan value, which is multiplied with a factor, to the current TimeSpan in a new TimeSpan instance.
`int`	`compareTo(TimeSpan o)` Compares this TimeSpan with another on the "getSpan()"
`static TimeSpan`	`diff(TimeSpan t1, TimeSpan t2)` The Math.abs() differences between two timespans.
`long`	`dueIn(Date from)` The number of milleseconds before a timespan is due for a date and NOW
`long`	`dueIn(Date from, Date to)` The number of milleseconds before a timespan is due for two dates
`boolean`	`equals(Object obj)` If the millisecond span "getSpan" is equal.
`String`	`getCaption()` Creates a readable text caption for the Timespan.
`long`	`getDays()` How many days the timespan covers, minus all the rest.
`static TimeSpan`	`getDays(int days)` Generates a Timespan of X days.
`long`	`getHours()` How many hours the timespan covers, minus all the rest.
`static TimeSpan`	`getHours(int hours)` Generates a Timespan of X hours.
`long`	`getMilliseconds()` How many milliseconds the timespan covers, minus all the rest.
`static TimeSpan`	`getMilliSeconds(int milliSeconds)` Generates a Timespan of X years.
`long`	`getMinutes()` How many minutes the timespan covers, minus all the rest.
`static TimeSpan`	`getMinutes(int minutes)` Generates a Timespan of X minutes.
`static TimeSpan`	`getMonths(int months)` Generates a Timespan of X months.
`String`	`getName()` The TimeSpan name
`String`	`getParsableText()` Using the `"milliseconds, seconds, minutes, hours, days, years"` values constructing a value which can be parsed by `TimeSpan.parse(String)`.
`long`	`getSeconds()` How many seconds the timespan covers, minus all the rest.
`static TimeSpan`	`getSeconds(int seconds)` Generates a Timespan of X years.
`long`	`getSpan()` The primary value, from which all other values eminates.
`static TimeSpan`	`getWeeks(int weeks)` Generates a Timespan of X weeks.
`long`	`getYears()` How many years the timespan covers, minus all the rest.
`static TimeSpan`	`getYears(int years)` Generates a Timespan of X years.
`int`	`hashCode()` The hashCode of the toString method.
`boolean`	`isGreatherThan(TimeSpan other)` Compares `this` with another TimeSpan, and determines if `this` is less than `other`.
`boolean`	`isLessThan(TimeSpan other)` Compares `this` with another TimeSpan, and determines if `this` is greather than `other`.
`boolean`	`isPastSpan(Date from)` Is the difference of a date and NOW larger than the timespan.
`boolean`	`isPastSpan(Date from, Date to)` Is the difference of two dates larger than the timespan.
`TimeSpan`	`multiply(double factor)` Multiplies the current Timespan with a double factor in a new TimeSpan instance.
`static TimeSpan`	`parse(Date from)` Constructs a TimeSpan instance on the basis of the difference between a date and the NOW date.
`static TimeSpan`	`parse(Date from, Date to)` Constructs a TimeSpan instance on the basis of the difference between to date instances.
`static TimeSpan`	`parse(String textValue)` Concstructs a TimeSpan instance of the basis string value parsing.
`TimeSpan`	`substract(long milliseconds)` Subtracts a milliseconds value to the current TimeSpan in a new TimeSpan instance.
`TimeSpan`	`substract(TimeSpan value)` Subtracts a TimeSpan value to the current in a new TimeSpan instance.
`TimeSpan`	`substract(TimeSpan value, int factor)` Subtracts a TimeSpan value, which is mulitiplied with a factor, to the current TimeSpan in a new TimeSpan instance.
`long`	`toMilliseconds()` Gets the timespan as milliseconds, the same as "getSpan()".
`String`	`toString()` Returns the `getParsableText()` value.

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

- Field Detail
  - UNIT_TIME_MILLISECOND
```
public static final long UNIT_TIME_MILLISECOND
```
    See Also:
    
    TimeSpanUnit.ms
  - UNIT_TIME_SECOND
```
public static final long UNIT_TIME_SECOND
```
    See Also:
    
    TimeSpanUnit.S
  - UNIT_TIME_MINUTE
```
public static final long UNIT_TIME_MINUTE
```
    See Also:
    
    TimeSpanUnit.m
  - UNIT_TIME_HOUR
```
public static final long UNIT_TIME_HOUR
```
    See Also:
    
    TimeSpanUnit.H
  - UNIT_TIME_DAY
```
public static final long UNIT_TIME_DAY
```
    See Also:
    
    TimeSpanUnit.D
  - UNIT_TIME_WEEK
```
public static final long UNIT_TIME_WEEK
```
    See Also:
    
    TimeSpanUnit.W
  - UNIT_TIME_MONTH
```
public static final long UNIT_TIME_MONTH
```
    See Also:
    
    TimeSpanUnit.M
  - UNIT_TIME_YEAR
```
public static final long UNIT_TIME_YEAR
```
    See Also:
    
    TimeSpanUnit.Y
  - ZERO
```
public static final TimeSpan ZERO
```
    0 time
  - SECONDS_01
```
public static final TimeSpan SECONDS_01
```
    1 second
  - SECONDS_15
```
public static final TimeSpan SECONDS_15
```
    15 seconds
  - SECONDS_30
```
public static final TimeSpan SECONDS_30
```
    30 seconds
  - SECONDS_45
```
public static final TimeSpan SECONDS_45
```
    45 seconds
  - SECONDS_60
```
public static final TimeSpan SECONDS_60
```
    60seconds
  - MINUTES_01
```
public static final TimeSpan MINUTES_01
```
    1 minut
  - MINUTES_02
```
public static final TimeSpan MINUTES_02
```
    2 minutes
  - MINUTES_03
```
public static final TimeSpan MINUTES_03
```
    3 minutes
  - MINUTES_04
```
public static final TimeSpan MINUTES_04
```
    4 minutes
  - MINUTES_05
```
public static final TimeSpan MINUTES_05
```
    5 minutes
  - MINUTES_10
```
public static final TimeSpan MINUTES_10
```
    10 minutes
  - MINUTES_15
```
public static final TimeSpan MINUTES_15
```
    15 minutes
  - MINUTES_20
```
public static final TimeSpan MINUTES_20
```
    20 minutes
  - MINUTES_25
```
public static final TimeSpan MINUTES_25
```
    25 minutes
  - MINUTES_30
```
public static final TimeSpan MINUTES_30
```
    30 minutes
  - MINUTES_35
```
public static final TimeSpan MINUTES_35
```
    35 minutes
  - MINUTES_40
```
public static final TimeSpan MINUTES_40
```
    40 minutes
  - MINUTES_45
```
public static final TimeSpan MINUTES_45
```
    45 minutes
  - MINUTES_50
```
public static final TimeSpan MINUTES_50
```
    50 minutes
  - MINUTES_55
```
public static final TimeSpan MINUTES_55
```
    55 minutes
  - MINUTES_60
```
public static final TimeSpan MINUTES_60
```
    60 minutes
  - HOURS_01
```
public static final TimeSpan HOURS_01
```
    1 hour
  - HOURS_02
```
public static final TimeSpan HOURS_02
```
    2 hours
  - HOURS_03
```
public static final TimeSpan HOURS_03
```
    3 hours
  - HOURS_04
```
public static final TimeSpan HOURS_04
```
    4 hours
  - HOURS_05
```
public static final TimeSpan HOURS_05
```
    5 hours
  - HOURS_06
```
public static final TimeSpan HOURS_06
```
    6 hours
  - HOURS_07
```
public static final TimeSpan HOURS_07
```
    7 hours
  - HOURS_08
```
public static final TimeSpan HOURS_08
```
    8 hours
  - HOURS_09
```
public static final TimeSpan HOURS_09
```
    9 hours
  - HOURS_10
```
public static final TimeSpan HOURS_10
```
    10 hours
  - HOURS_11
```
public static final TimeSpan HOURS_11
```
    11 hours
  - HOURS_12
```
public static final TimeSpan HOURS_12
```
    12 hours
  - HOURS_13
```
public static final TimeSpan HOURS_13
```
    13 hours
  - HOURS_14
```
public static final TimeSpan HOURS_14
```
    14 hours
  - HOURS_15
```
public static TimeSpan HOURS_15
```
    15 hours
  - HOURS_16
```
public static final TimeSpan HOURS_16
```
    16 hours
  - HOURS_17
```
public static final TimeSpan HOURS_17
```
    17 hours
  - HOURS_18
```
public static final TimeSpan HOURS_18
```
    18 hours
  - HOURS_19
```
public static final TimeSpan HOURS_19
```
    19 hours
  - HOURS_20
```
public static final TimeSpan HOURS_20
```
    20 hours
  - HOURS_21
```
public static final TimeSpan HOURS_21
```
    21 hours
  - HOURS_22
```
public static final TimeSpan HOURS_22
```
    22 hours
  - HOURS_23
```
public static final TimeSpan HOURS_23
```
    23 hours
  - HOURS_24
```
public static final TimeSpan HOURS_24
```
    24 hours
  - DAYS_01
```
public static final TimeSpan DAYS_01
```
    1 day
  - DAYS_02
```
public static final TimeSpan DAYS_02
```
    2 days
  - DAYS_03
```
public static final TimeSpan DAYS_03
```
    3 days
  - DAYS_04
```
public static final TimeSpan DAYS_04
```
    4 days
  - DAYS_05
```
public static final TimeSpan DAYS_05
```
    5 days
  - DAYS_06
```
public static final TimeSpan DAYS_06
```
    6 days
  - DAYS_07
```
public static final TimeSpan DAYS_07
```
    7 days
  - DAYS_08
```
public static final TimeSpan DAYS_08
```
    8 days
  - DAYS_09
```
public static final TimeSpan DAYS_09
```
    9 days
  - DAYS_10
```
public static final TimeSpan DAYS_10
```
    10 days
  - DAYS_11
```
public static final TimeSpan DAYS_11
```
    11 days
  - DAYS_12
```
public static final TimeSpan DAYS_12
```
    12 days
  - DAYS_13
```
public static final TimeSpan DAYS_13
```
    13 days
  - DAYS_14
```
public static final TimeSpan DAYS_14
```
    14 days
  - DAYS_15
```
public static final TimeSpan DAYS_15
```
    15 days
  - DAYS_16
```
public static final TimeSpan DAYS_16
```
    16 days
  - DAYS_17
```
public static final TimeSpan DAYS_17
```
    17 days
  - DAYS_18
```
public static TimeSpan DAYS_18
```
    18 days
  - DAYS_19
```
public static final TimeSpan DAYS_19
```
    19 days
  - DAYS_20
```
public static final TimeSpan DAYS_20
```
    20 days
  - DAYS_21
```
public static final TimeSpan DAYS_21
```
    21 days
  - DAYS_22
```
public static final TimeSpan DAYS_22
```
    22 days
  - DAYS_23
```
public static final TimeSpan DAYS_23
```
    23 days
  - DAYS_24
```
public static final TimeSpan DAYS_24
```
    24 days
  - DAYS_25
```
public static final TimeSpan DAYS_25
```
    25 days
  - DAYS_26
```
public static final TimeSpan DAYS_26
```
    26 days
  - DAYS_27
```
public static final TimeSpan DAYS_27
```
    27 days
  - DAYS_28
```
public static final TimeSpan DAYS_28
```
    28 days
  - DAYS_29
```
public static final TimeSpan DAYS_29
```
    29 days
  - DAYS_30
```
public static final TimeSpan DAYS_30
```
    30 days
  - DAYS_31
```
public static final TimeSpan DAYS_31
```
    31 days
  - WEEKS_1
```
public static final TimeSpan WEEKS_1
```
    1 week - 7 days
  - WEEKS_2
```
public static final TimeSpan WEEKS_2
```
    2 weeks - 14 days
  - WEEKS_3
```
public static final TimeSpan WEEKS_3
```
    3 weeks - 21 days
  - WEEKS_4
```
public static final TimeSpan WEEKS_4
```
    4 weeks - 28 days
  - MONTHS_1
```
public static final TimeSpan MONTHS_1
```
    1 month - 31 days
  - MONTHS_2
```
public static final TimeSpan MONTHS_2
```
    2 months - 2x 31 days
  - MONTHS_3
```
public static final TimeSpan MONTHS_3
```
    3 months - 3x 31 days
  - MONTHS_6
```
public static final TimeSpan MONTHS_6
```
    6 months - 6x 31 days
  - MONTHS_9
```
public static final TimeSpan MONTHS_9
```
    9 months - 9x 31 days
  - MONTHS_12
```
public static final TimeSpan MONTHS_12
```
    12 months - 12x 31 days
  - YEARS_1
```
public static final TimeSpan YEARS_1
```
    1 year - 365 days
  - YEARS_2
```
public static final TimeSpan YEARS_2
```
    2 years - 2x 365 days
  - YEARS_3
```
public static final TimeSpan YEARS_3
```
    3 years - 3x 365 days
  - YEARS_5
```
public static final TimeSpan YEARS_5
```
    5 years - 5x 365 days
  - YEARS_10
```
public static final TimeSpan YEARS_10
```
    10 years - 10x 365 days
  - YEARS_25
```
public static final TimeSpan YEARS_25
```
    25 years - 25x 365 days
  - YEARS_50
```
public static final TimeSpan YEARS_50
```
    50 years - 50x 365 days
  - YEARS_100
```
public static final TimeSpan YEARS_100
```
    100 years - 100x 365 days
- Constructor Detail
  - TimeSpan
```
public TimeSpan(long span)
         throws IllegalArgumentException
```
    Constructor, a name will be generated using the getParsableText() method.
    
    Parameters:
    
    span - the timespan in milliseconds.
    
    Throws:
    
    IllegalArgumentException - if span is less than zero.
    
    See Also:
    
    getParsableText()
  - TimeSpan
```
public TimeSpan(String name,
                long span)
         throws IllegalArgumentException
```
    Constructor.
    
    Parameters:
    
    name - the name of the timespan.
    
    span - the timespan in milliseconds.
    
    Throws:
    
    IllegalArgumentException - if span is less than zero.
  - TimeSpan
```
public TimeSpan(String name,
                long years,
                long months,
                long weeks,
                long days,
                long hours,
                long minutes,
                long seconds,
                long milliseconds)
```
    Constructor using individual unit values.
    
    Parameters:
    
    name - the name of the timespan.
    
    years - the number of years. If less or equal to zero, the value is ignored.
    
    months - the number of months, will be converted to days, by multiplying by 31. If less or equal to zero, the value is ignored.
    
    weeks - the number of weeks, will be converted to days, by multiplying by 7. If less or equal to zero, the value is ignored.
    
    days - the number of days. If less or equal to zero, the value is ignored.
    
    hours - the number of hours. If less or equal to zero, the value is ignored.
    
    minutes - the number of minutes. If less or equal to zero, the value is ignored.
    
    seconds - the number of seconds. If less or equal to zero, the value is ignored.
    
    milliseconds - the number of milliseconds. If less or equal to zero, the value is ignored.
  - TimeSpan
```
public TimeSpan(int years,
                long months,
                long weeks,
                long days,
                long hours,
                long minutes,
                long seconds,
                long milliseconds)
```
    Constructor using individual unit values, a name will be generated using the getParsableText() method.
    
    Parameters:
    
    years - the number of years. If less or equal to zero, the value is ignored.
    
    months - the number of months, will be converted to days, by multiplying by 31. If less or equal to zero, the value is ignored.
    
    weeks - the number of weeks, will be converted to days, by multiplying by 7. If less or equal to zero, the value is ignored.
    
    days - the number of days. If less or equal to zero, the value is ignored.
    
    hours - the number of hours. If less or equal to zero, the value is ignored.
    
    minutes - the number of minutes. If less or equal to zero, the value is ignored.
    
    seconds - the number of seconds. If less or equal to zero, the value is ignored.
    
    milliseconds - the number of milliseconds. If less or equal to zero, the value is ignored.
    
    See Also:
    
    getParsableText()
- Method Detail
  - getYears
```
public static final TimeSpan getYears(int years)
                               throws IllegalArgumentException
```
    Generates a Timespan of X years.
    
    Parameters:
    
    years - the number of years
    
    Returns:
    
    a TimeSpan with X number of years as value.
    
    Throws:
    
    IllegalArgumentException - if years is less than zero.
    
    Since:
    
    2.1
    
    See Also:
    
    add(TimeSpan), substract(TimeSpan)
  - getMonths
```
public static final TimeSpan getMonths(int months)
                                throws IllegalArgumentException
```
    Generates a Timespan of X months.
    
    Parameters:
    
    months - the number of months
    
    Returns:
    
    a TimeSpan with X number of years as value.
    
    Throws:
    
    IllegalArgumentException - if months is less than zero.
    
    Since:
    
    2.1
    
    See Also:
    
    add(TimeSpan), substract(TimeSpan)
  - getWeeks
```
public static final TimeSpan getWeeks(int weeks)
                               throws IllegalArgumentException
```
    Generates a Timespan of X weeks.
    
    Parameters:
    
    weeks - the number of weeks
    
    Returns:
    
    a TimeSpan with X number of weeks as value.
    
    Throws:
    
    IllegalArgumentException - if weeks is less than zero.
    
    Since:
    
    2.1
    
    See Also:
    
    add(TimeSpan), substract(TimeSpan)
  - getDays
```
public static final TimeSpan getDays(int days)
                              throws IllegalArgumentException
```
    Generates a Timespan of X days.
    
    Parameters:
    
    days - the number of days
    
    Returns:
    
    a TimeSpan with X number of days as value.
    
    Throws:
    
    IllegalArgumentException - if days is less than zero.
    
    Since:
    
    2.1
    
    See Also:
    
    add(TimeSpan), substract(TimeSpan)
  - getHours
```
public static final TimeSpan getHours(int hours)
                               throws IllegalArgumentException
```
    Generates a Timespan of X hours.
    
    Parameters:
    
    hours - the number of hours
    
    Returns:
    
    a TimeSpan with X number of hours as value.
    
    Throws:
    
    IllegalArgumentException - if hours is less than zero.
    
    Since:
    
    2.1
    
    See Also:
    
    add(TimeSpan), substract(TimeSpan)
  - getMinutes
```
public static final TimeSpan getMinutes(int minutes)
                                 throws IllegalArgumentException
```
    Generates a Timespan of X minutes.
    
    Parameters:
    
    minutes - the number of minutes
    
    Returns:
    
    a TimeSpan with X number of minutes as value.
    
    Throws:
    
    IllegalArgumentException - if minutes is less than zero.
    
    Since:
    
    2.1
    
    See Also:
    
    add(TimeSpan), substract(TimeSpan)
  - getSeconds
```
public static final TimeSpan getSeconds(int seconds)
                                 throws IllegalArgumentException
```
    Generates a Timespan of X years.
    
    Parameters:
    
    seconds - the number of seconds
    
    Returns:
    
    a TimeSpan with X number of seconds as value.
    
    Throws:
    
    IllegalArgumentException - if seconds is less than zero.
    
    Since:
    
    2.1
    
    See Also:
    
    add(TimeSpan), substract(TimeSpan)
  - getMilliSeconds
```
public static final TimeSpan getMilliSeconds(int milliSeconds)
                                      throws IllegalArgumentException
```
    Generates a Timespan of X years.
    
    Parameters:
    
    milliSeconds - the number of milliSeconds
    
    Returns:
    
    a TimeSpan with X number of years as value.
    
    Throws:
    
    IllegalArgumentException - if milliSeconds is less than zero.
    
    Since:
    
    2.1
    
    See Also:
    
    add(TimeSpan), substract(TimeSpan)
  - parse
```
public static final TimeSpan parse(String textValue)
                            throws Exception
```
    Concstructs a TimeSpan instance of the basis string value parsing.
    
    Parameters:
    
    textValue - the string value using the TimeSpan text format convention.
    
    Returns:
    
    a Timespan instance
    
    Throws:
    
    PropertyException - if for any reason the string value is invalid or unparseable.
    
    Exception
  - parse
```
public static final TimeSpan parse(Date from,
                                   Date to)
                            throws Exception
```
    Constructs a TimeSpan instance on the basis of the difference between to date instances.
    
    Parameters:
    
    from - the from date.
    
    to - the to date.
    
    Returns:
    
    A TimeSpan instane using the absolute value between to dates.
    
    Throws:
    
    PropertyException - if either dates is null.
    
    Exception
  - parse
```
public static final TimeSpan parse(Date from)
                            throws Exception
```
    Constructs a TimeSpan instance on the basis of the difference between a date and the NOW date.
    
    Parameters:
    
    from - the from date
    
    Returns:
    
    A TimeSpan instane using the absolute value between a date and NOW.
    
    Throws:
    
    PropertyException - if from date is null.
    
    Exception
  - diff
```
public static final TimeSpan diff(TimeSpan t1,
                                  TimeSpan t2)
                           throws NullPointerException
```
    The Math.abs() differences between two timespans.
    
    Parameters:
    
    t1 - a timeSpan
    
    t2 - a timeSpan
    
    Returns:
    
    a new TimeSpan between two timespans, new TimeSpan(Math.abs(o1.getSpan()-o2.getSpan())).
    
    Throws:
    
    NullPointerException - if either t1 or t2 is null.
    
    Since:
    
    2.1
  - add
```
public TimeSpan add(TimeSpan value)
             throws IllegalArgumentException,
                    NullPointerException
```
    Adds a TimeSpan value to the current TimeSpan in a new TimeSpan instance.
    
    Parameters:
    
    value - the Timespan value
    
    Returns:
    
    the current value added the TimeSpan value, in a new TimeSpan instance.
    
    Throws:
    
    IllegalArgumentException - if the new value is less than zero.
    
    NullPointerException - if the TimeSpan value is null.
  - substract
```
public TimeSpan substract(TimeSpan value)
                   throws IllegalArgumentException,
                          NullPointerException
```
    Subtracts a TimeSpan value to the current in a new TimeSpan instance.
    
    Parameters:
    
    value - the Timespan value
    
    Returns:
    
    the current value substracted the TimeSpan value, in a new TimeSpan instance.
    
    Throws:
    
    IllegalArgumentException - if the new value is less than zero.
    
    NullPointerException - if the TimeSpan value is null.
  - add
```
public TimeSpan add(TimeSpan value,
                    int factor)
             throws IllegalArgumentException,
                    NullPointerException
```
    Adds a TimeSpan value, which is multiplied with a factor, to the current TimeSpan in a new TimeSpan instance.
    
    Parameters:
    
    value - the Timespan value
    
    factor - the factor which the TimeSpan value will be multiplied
    
    Returns:
    
    the current value added the TimeSpan value,multiplied with the factor, in a new TimeSpan instance.
    
    Throws:
    
    IllegalArgumentException - if the new value is less than zero.
    
    NullPointerException - if the TimeSpan value is null.
  - substract
```
public TimeSpan substract(TimeSpan value,
                          int factor)
                   throws IllegalArgumentException,
                          NullPointerException
```
    Subtracts a TimeSpan value, which is mulitiplied with a factor, to the current TimeSpan in a new TimeSpan instance.
    
    Parameters:
    
    value - the Timespan value
    
    factor - the factor which the TimeSpan value will be multiplied
    
    Returns:
    
    the current value substracted the TimeSpan value,multiplied with the factor, in a new TimeSpan instance.
    
    Throws:
    
    IllegalArgumentException - if the new value is less than zero.
    
    NullPointerException - if the TimeSpan value is null.
  - add
```
public TimeSpan add(long milliseconds)
             throws IllegalArgumentException
```
    Adds a milliseconds value to the current TimeSpan in a new TimeSpan instance.
    
    Parameters:
    
    milliseconds - a value in milliseconds.
    
    Returns:
    
    the current value added the millisecond value in a new TimeSpan instance.
    
    Throws:
    
    IllegalArgumentException - if the new value is less than zero.
  - substract
```
public TimeSpan substract(long milliseconds)
                   throws IllegalArgumentException
```
    Subtracts a milliseconds value to the current TimeSpan in a new TimeSpan instance.
    
    Parameters:
    
    milliseconds - a value in milliseconds.
    
    Returns:
    
    the current value substracted the millisecond value in a new TimeSpan instance.
    
    Throws:
    
    IllegalArgumentException - if the new value is less than zero.
  - multiply
```
public TimeSpan multiply(double factor)
                  throws IllegalArgumentException
```
    Multiplies the current Timespan with a double factor in a new TimeSpan instance.
    
    Parameters:
    
    factor - the factor to multiply with, has to greather than zero.
    
    Returns:
    
    the current TimeSpan in milliseconds, multiplied with a factor and returned in a new TimeSpan instance.
    
    Throws:
    
    IllegalArgumentException - if factor is less or equal to zero.
  - getParsableText
```
public String getParsableText()
```
    Using the "milliseconds, seconds, minutes, hours, days, years" values constructing a value which can be parsed by TimeSpan.parse(String).
    
    Returns:
    
    a parseable TimeSpan string.
    
    See Also:
    
    parse(String)
  - toString
```
public String toString()
```
    Returns the getParsableText() value.
    
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    The hashCode of the toString method.
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    If the millisecond span "getSpan" is equal.
    
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(TimeSpan o)
```
    Compares this TimeSpan with another on the "getSpan()"
    
    Specified by:
    
    compareTo in interface Comparable<TimeSpan>
  - getName
```
public String getName()
```
    The TimeSpan name
    
    Returns:
    
    the name of the TimeSpan, either provided or generated.
  - getSpan
```
public long getSpan()
```
    The primary value, from which all other values eminates.
    
    Returns:
    
    the span value in milliseconds.
  - getYears
```
public long getYears()
```
    How many years the timespan covers, minus all the rest.
    
    Returns:
    
    the years
  - getDays
```
public long getDays()
```
    How many days the timespan covers, minus all the rest.
    
    Returns:
    
    the days
  - getHours
```
public long getHours()
```
    How many hours the timespan covers, minus all the rest.
    
    Returns:
    
    the hours
  - getMinutes
```
public long getMinutes()
```
    How many minutes the timespan covers, minus all the rest.
    
    Returns:
    
    the minutes
  - getSeconds
```
public long getSeconds()
```
    How many seconds the timespan covers, minus all the rest.
    
    Returns:
    
    the seconds
  - getMilliseconds
```
public long getMilliseconds()
```
    How many milliseconds the timespan covers, minus all the rest.
    
    Returns:
    
    the milliseconds
  - getCaption
```
public String getCaption()
```
    Creates a readable text caption for the Timespan.
    
    Returns:
    
    a readable caption for the TimeSpan.
  - isPastSpan
```
public boolean isPastSpan(Date from,
                          Date to)
```
    Is the difference of two dates larger than the timespan.
    
    Parameters:
    
    from - the from date
    
    to - the to date
    
    Returns:
    
    if either from or to is null then false is returned, otherwise true of the milliseconds difference between to and from is greather than the timespan; else false.
  - isPastSpan
```
public boolean isPastSpan(Date from)
```
    Is the difference of a date and NOW larger than the timespan.
    
    Parameters:
    
    from - the from date
    
    Returns:
    
    if from is null then false is returned, otherwise true of the milliseconds difference between NOW and from is greather than the timespan; else false.
  - dueIn
```
public long dueIn(Date from,
                  Date to)
```
    The number of milleseconds before a timespan is due for two dates
    
    Parameters:
    
    from - the from date
    
    to - the to date
    
    Returns:
    
    if either from or to is null then 0 is returned, otherwise the timespan in milliseconds minus the difference of the two dates. If negative than it is past due time.
  - dueIn
```
public long dueIn(Date from)
```
    The number of milleseconds before a timespan is due for a date and NOW
    
    Parameters:
    
    from - the from date
    
    Returns:
    
    if fromis null then 0 is returned, otherwise the timespan in milliseconds minus the difference of the date and NOW. If negative than it is past due time.
  - isLessThan
```
public boolean isLessThan(TimeSpan other)
                   throws NullPointerException
```
    Compares this with another TimeSpan, and determines if this is greather than other.
    
    Parameters:
    
    other - another instance of TimeSpan.
    
    Returns:
    
    true if this is less than other, otherwise false.
    
    Throws:
    
    NullPointerException - if other is null.
  - isGreatherThan
```
public boolean isGreatherThan(TimeSpan other)
                       throws NullPointerException
```
    Compares this with another TimeSpan, and determines if this is less than other.
    
    Parameters:
    
    other - another instance of TimeSpan.
    
    Returns:
    
    true if this is greather than other, otherwise false.
    
    Throws:
    
    NullPointerException - if other is null.
  - toMilliseconds
```
public final long toMilliseconds()
```
    Gets the timespan as milliseconds, the same as "getSpan()".
    
    Returns:
    
    the time span in milliseconds.
    
    See Also:
    
    getSpan()

Class TimeSpan

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNIT_TIME_MILLISECOND

UNIT_TIME_SECOND

UNIT_TIME_MINUTE

UNIT_TIME_HOUR

UNIT_TIME_DAY

UNIT_TIME_WEEK

UNIT_TIME_MONTH

UNIT_TIME_YEAR

ZERO

SECONDS_01

SECONDS_15

SECONDS_30

SECONDS_45

SECONDS_60

MINUTES_01

MINUTES_02

MINUTES_03

MINUTES_04

MINUTES_05

MINUTES_10

MINUTES_15

MINUTES_20

MINUTES_25

MINUTES_30

MINUTES_35

MINUTES_40

MINUTES_45

MINUTES_50

MINUTES_55

MINUTES_60

HOURS_01

HOURS_02

HOURS_03

HOURS_04

HOURS_05

HOURS_06

HOURS_07

HOURS_08

HOURS_09

HOURS_10

HOURS_11

HOURS_12

HOURS_13

HOURS_14

HOURS_15

HOURS_16

HOURS_17

HOURS_18

HOURS_19

HOURS_20

HOURS_21

HOURS_22

HOURS_23

HOURS_24

DAYS_01

DAYS_02

DAYS_03

DAYS_04

DAYS_05

DAYS_06

DAYS_07

DAYS_08

DAYS_09

DAYS_10

DAYS_11

DAYS_12

DAYS_13

DAYS_14

DAYS_15

DAYS_16

DAYS_17

DAYS_18

DAYS_19

DAYS_20