com.jrefinery.data
Class Week

java.lang.Object
  com.jrefinery.data.TimePeriod
      com.jrefinery.data.Week

All Implemented Interfaces:

MonthConstants, java.lang.Comparable

public class Week
extends TimePeriod

Represents a week within a particular year.

This class is immutable, which is a requirement for all TimePeriod subclasses.

Field Summary

static int	FIRST_WEEK_IN_YEAR Constant for the first week in the year.
static int	LAST_WEEK_IN_YEAR Constant for the last week in the year.
protected int	week The week (1-52).
protected Year	year The year in which the week falls.

Fields inherited from class com.jrefinery.data.TimePeriod

DEFAULT_TIME_ZONE, WORKING_CALENDAR

Fields inherited from interface com.jrefinery.date.MonthConstants

APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER

Constructor Summary

Week()
Constructs a Week, based on the system date/time.

Week(java.util.Date time)
Constructs a time period representing a week.

Week(java.util.Date time, java.util.TimeZone zone)
Constructs a Week, based on a date/time and a time zone.

Week(int week, int year)
Constructs a time period representing the week in the specified year.

Week(int week, Year year)
Constructs a time period representing the week in the specified year.

Method Summary

int	compareTo(java.lang.Object o1) Returns an integer indicating the order of this Week object relative to the specified object: negative == before, zero == same, positive == after.
boolean	equals(java.lang.Object obj) Tests the equality of this Week object to an arbitrary object.
long	getEnd(java.util.Calendar calendar) Returns the last millisecond of the week, evaluated using the supplied calendar (which determines the time zone).
long	getStart(java.util.Calendar calendar) Returns the first millisecond of the week, evaluated using the supplied calendar (which determines the time zone).
int	getWeek() Returns the week.
Year	getYear() Returns the year in which the week falls.
int	getYearValue() Returns the year in which the week falls, as an integer value.
static void	main(java.lang.String[] args) Test code - please ignore.
TimePeriod	next() Returns the week following this one.
static Week	parseWeek(java.lang.String s) Parses the string argument as a week.
TimePeriod	previous() Returns the week preceding this one.
java.lang.String	toString() Returns a string representing the week (e.g.

Methods inherited from class com.jrefinery.data.TimePeriod

getEnd, getEnd, getMiddle, getMiddle, getMiddle, getStart, getStart

Methods inherited from class java.lang.Object

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

Field Detail

FIRST_WEEK_IN_YEAR

public static int FIRST_WEEK_IN_YEAR

Constant for the first week in the year.

LAST_WEEK_IN_YEAR

public static int LAST_WEEK_IN_YEAR

Constant for the last week in the year.

year

protected Year year

The year in which the week falls.

week

protected int week

The week (1-52).

Constructor Detail

Week

public Week()

Constructs a Week, based on the system date/time.

Week

public Week(int week,
            int year)

Constructs a time period representing the week in the specified year.

Parameters:

week - The week (1 to 52).

year - The year (1900 to 9999).

Week

public Week(int week,
            Year year)

Constructs a time period representing the week in the specified year.

Parameters:

week - The week (1 to 52).

year - The year (1900 to 9999).

Week

public Week(java.util.Date time)

Constructs a time period representing a week.

Parameters:

time - The time.

Week

public Week(java.util.Date time,
            java.util.TimeZone zone)

Constructs a Week, based on a date/time and a time zone.

Parameters:

time - The date/time.

zone - The time zone.

Method Detail

getYear

public Year getYear()

Returns the year in which the week falls.

Returns:

The year.

getYearValue

public int getYearValue()

Returns the year in which the week falls, as an integer value.

Returns:

The year.

getWeek

public int getWeek()

Returns the week.

Returns:

The week.

previous

public TimePeriod previous()

Returns the week preceding this one.

Specified by:

previous in class TimePeriod

Returns:

The preceding week.

next

public TimePeriod next()

Returns the week following this one.

Specified by:

next in class TimePeriod

Returns:

The following week.

toString

public java.lang.String toString()

Returns a string representing the week (e.g. "Week 9, 2002").

To do: look at internationalisation.

Overrides:

toString in class java.lang.Object

Returns:

A string representing the week.

equals

public boolean equals(java.lang.Object obj)

Tests the equality of this Week object to an arbitrary object. Returns true if the target is a Week instance representing the same week as this object. In all other cases, returns false.

Overrides:

equals in class java.lang.Object

Parameters:

object - The object.

compareTo

public int compareTo(java.lang.Object o1)

Returns an integer indicating the order of this Week object relative to the specified object: negative == before, zero == same, positive == after.

getStart

public long getStart(java.util.Calendar calendar)

Returns the first millisecond of the week, evaluated using the supplied calendar (which determines the time zone).

Specified by:

getStart in class TimePeriod

Parameters:

calendar - The calendar.

Returns:

The first millisecond of the week.

getEnd

public long getEnd(java.util.Calendar calendar)

Returns the last millisecond of the week, evaluated using the supplied calendar (which determines the time zone).

Specified by:

getEnd in class TimePeriod

Parameters:

calendar - The calendar.

Returns:

The last millisecond of the week.

parseWeek

public static Week parseWeek(java.lang.String s)
                      throws TimePeriodFormatException

Parses the string argument as a week.

This method is required to accept the format "YYYY-Wnn". It will also accept "Wnn-YYYY". Anything else, at the moment, is a bonus.

Throws:

TimePeriodFormatException

main

public static void main(java.lang.String[] args)

Test code - please ignore.