org.jfree.data.time
public class Week extends RegularTimePeriod implements Serializable
GregorianCalendar
class).
This class is immutable, which is a requirement for all RegularTimePeriod 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. |
Constructor Summary | |
---|---|
Week()
Creates a new time period for the week in which the current system
date/time falls. | |
Week(int week, int year)
Creates a time period representing the week in the specified year.
| |
Week(int week, Year year)
Creates a time period representing the week in the specified year.
| |
Week(Date time)
Creates a time period for the week in which the specified date/time
falls.
| |
Week(Date time, TimeZone zone)
Creates a time period for the week in which the specified date/time
falls, calculated relative to the specified time zone.
| |
Week(Date time, TimeZone zone, Locale locale)
Creates a time period for the week in which the specified date/time
falls, calculated relative to the specified time zone.
|
Method Summary | |
---|---|
int | compareTo(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(Object obj)
Tests the equality of this Week object to an arbitrary object. |
long | getFirstMillisecond()
Returns the first millisecond of the week. |
long | getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the week, evaluated using the supplied
calendar (which determines the time zone).
|
long | getLastMillisecond()
Returns the last millisecond of the week. |
long | getLastMillisecond(Calendar calendar)
Returns the last millisecond of the week, evaluated using the supplied
calendar (which determines the time zone).
|
long | getSerialIndex()
Returns a serial index number for the week.
|
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.
|
int | hashCode()
Returns a hash code for this object instance. |
RegularTimePeriod | next()
Returns the week following this one. |
static Week | parseWeek(String s)
Parses the string argument as a week.
|
void | peg(Calendar calendar)
Recalculates the start date/time and end date/time for this time period
relative to the supplied calendar (which incorporates a time zone).
|
RegularTimePeriod | previous()
Returns the week preceding this one. |
String | toString()
Returns a string representing the week (e.g. |
Parameters: week the week (1 to 53). year the year (1900 to 9999).
Parameters: week the week (1 to 53). year the year (1900 to 9999).
Parameters: time the time (null
not permitted).
Deprecated: As of 1.0.7, use Week.
Creates a time period for the week in which the specified date/time falls, calculated relative to the specified time zone.Parameters: time the date/time (null
not permitted). zone the time zone (null
not permitted).
Parameters: time the date/time (null
not permitted). zone the time zone (null
not permitted). locale the locale (null
not permitted).
Since: 1.0.7
Parameters: o1 the object to compare.
Returns: negative == before, zero == same, positive == after.
Parameters: obj the object (null
permitted).
Returns: true
if week and year of this and object are the
same.
Returns: The first millisecond of the week.
See Also: getLastMillisecond
Parameters: calendar the calendar (null
not permitted).
Returns: The first millisecond of the week.
Throws: NullPointerException if calendar
is
null
.
Returns: The last millisecond of the week.
See Also: getFirstMillisecond
Parameters: calendar the calendar (null
not permitted).
Returns: The last millisecond of the week.
Throws: NullPointerException if calendar
is
null
.
Returns: The serial index number.
Returns: The week.
Returns: The year (never null
).
Returns: The year.
http://developer.java.sun.com/developer/Books/effectivejava
/Chapter3.pdf
Returns: A hash code.
null
for some upper limit on the range of weeks (currently
week 53, 9999). For week 52 of any year, the following week is always
week 53, but week 53 may not contain any days (you should check for
this).
Returns: The following week (possibly null
).
This method is required to accept the format "YYYY-Wnn". It will also accept "Wnn-YYYY". Anything else, at the moment, is a bonus.
Parameters: s string to parse.
Returns: null
if the string is not parseable, the week
otherwise.
Parameters: calendar the calendar (null
not permitted).
Since: 1.0.3
null
for some lower limit on the range of weeks (currently
week 1, 1900). For week 1 of any year, the previous week is always week
53, but week 53 may not contain any days (you should check for this).
Returns: The preceding week (possibly null
).
Returns: A string representing the week.