edu.ucla.sspace.util

Class TimeSpan

java.lang.Object

edu.ucla.sspace.util.TimeSpan

public class TimeSpan
extends Object

A utility class for representing a span of time. Instance of this class can be used to determine whether two moments fall within the time span.

Time spans are expressed as a combination of time units and their associated amounts. Each amount may add up to be more than one of a larger time unit. For example a time unit may be expressed as 1 month and 6 weeks. Time amounts that are not used should be set to 0, e.g. a time span representing a single day would have only days set to 1 and all other time units as 0.

Note that when the overloaded Date and long methods are used, the instances are converted to the JVM's current calendar system. This may have a slight, noticeable affect due to daylight savings or any other calendar-specific differences to how a date is calculated.

See Also:

Calendar, Date

Constructor Summary

Constructors

Constructor and Description
TimeSpan(int years, int months, int weeks, int days, int hours) Creates a time span for the specified duration.
TimeSpan(String timespan) Creates a time span using the date string to specify the time units and amounts.

Method Summary

Methods

Modifier and Type	Method and Description
int	getDays() Returns the day component of this time span.
int	getHours() Returns the hour component of this time span.
int	getMonths() Returns the month component of this time span.
int	getWeeks() Returns the week component of this time span.
int	getYears() Returns the year component of this time span.
boolean	insideRange(Calendar startDate, Calendar endDate) Returns true if the end date occurs after the start date during the period of time represented by this time span.
boolean	insideRange(Date startDate, Date endDate) Returns true if the end date occurs after the start date during the period of time represented by this time span.
boolean	insideRange(long startDate, long endDate) Returns true if the end date occurs after the start date during the period of time represented by this time span.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeSpan

public TimeSpan(String timespan)

Creates a time span using the date string to specify the time units and amounts. Time units are specified using a single lower case letter of the word for the time unit, e.g. y for year, m for month.

Parameters:

timespan - a string containing numbers each followed by a single character to denote the time unit

Throws:

IllegalArgumentException - if

• any of the parameters are negative
• if any of the time units are specified more than once

TimeSpan

public TimeSpan(int years,
        int months,
        int weeks,
        int days,
        int hours)

Creates a time span for the specified duration.

Parameters:

years - the number of years for this time span

months - the number of years for this time span

weeks - the number of years for this time span

days - the number of years for this time span

hours - the number of years for this time span

Throws:

IllegalArgumentException - if any of the parameters are negative

Method Detail

getDays

public int getDays()

Returns the day component of this time span. This value does not reflect the total number of days that make up this time span, but rather how many days were specified in addition to the other time components to comprise the total duration.

Returns:

the day component of this time span

getHours

public int getHours()

Returns the hour component of this time span. This value does not reflect the total number of hours that make up this time span, but rather how many hours were specified in addition to the other time components to comprise the total duration.

Returns:

the hour component of this time span

getMonths

public int getMonths()

Returns the month component of this time span. This value does not reflect the total number of months that make up this time span, but rather how many months were specified in addition to the other time components to comprise the total duration.

Returns:

the month component of this time span

getWeeks

public int getWeeks()

Returns the week component of this time span. This value does not reflect the total number of weeks that make up this time span, but rather how many weeks were specified in addition to the other time components to comprise the total duration.

Returns:

the week component of this time span

getYears

public int getYears()

Returns the year component of this time span. This value does not reflect the total number of years that make up this time span, but rather how many years were specified in addition to the other time components to comprise the total duration.

Returns:

the year component of this time span

insideRange

public boolean insideRange(Calendar startDate,
                  Calendar endDate)

Returns true if the end date occurs after the start date during the period of time represented by this time span.

insideRange

public boolean insideRange(Date startDate,
                  Date endDate)

Returns true if the end date occurs after the start date during the period of time represented by this time span.

insideRange

public boolean insideRange(long startDate,
                  long endDate)

Returns true if the end date occurs after the start date during the period of time represented by this time span.

toString

public String toString()

Overrides:

toString in class Object