|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jfree.data.time.RegularTimePeriod
org.jfree.data.time.Week
A calendar week. All years are considered to have 53 weeks, numbered from 1 to
53, although in many cases the 53rd week is empty. Most of the time, the 1st week
of the year *begins* in the previous calendar year, but it always finishes in the current
year (this behaviour matches the workings of the 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. |
Fields inherited from class org.jfree.data.time.RegularTimePeriod |
DEFAULT_TIME_ZONE, WORKING_CALENDAR |
Constructor Summary | |
Week()
Creates a new time period for the week in which the current system date/time falls. |
|
Week(java.util.Date time)
Creates a time period for the week in which the specified date/time falls. |
|
Week(java.util.Date time,
java.util.TimeZone zone)
Creates a time period for the week in which the specified date/time falls, calculated relative to the specified time zone. |
|
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. |
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 |
getFirstMillisecond(java.util.Calendar calendar)
Returns the first millisecond of the week, evaluated using the supplied calendar (which determines the time zone). |
long |
getLastMillisecond(java.util.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(java.lang.String s)
Parses the string argument as a week. |
RegularTimePeriod |
previous()
Returns the week preceding this one. |
java.lang.String |
toString()
Returns a string representing the week (e.g. |
Methods inherited from class org.jfree.data.time.RegularTimePeriod |
createInstance, downsize, getEnd, getFirstMillisecond, getFirstMillisecond, getLastMillisecond, getLastMillisecond, getMiddleMillisecond, getMiddleMillisecond, getMiddleMillisecond, getStart |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int FIRST_WEEK_IN_YEAR
public static final int LAST_WEEK_IN_YEAR
Constructor Detail |
public Week()
public Week(int week, int year)
week
- the week (1 to 53).year
- the year (1900 to 9999).public Week(int week, Year year)
week
- the week (1 to 53).year
- the year (1900 to 9999).public Week(java.util.Date time)
time
- the time (null
not permitted).public Week(java.util.Date time, java.util.TimeZone zone)
time
- the date/time (null
not permitted).zone
- the time zone (null
not permitted).Method Detail |
public Year getYear()
null
).public int getYearValue()
public int getWeek()
public RegularTimePeriod previous()
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).
previous
in class RegularTimePeriod
null
).public RegularTimePeriod next()
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).
next
in class RegularTimePeriod
null
).public long getSerialIndex()
getSerialIndex
in class RegularTimePeriod
public long getFirstMillisecond(java.util.Calendar calendar)
getFirstMillisecond
in class RegularTimePeriod
calendar
- the calendar.
public long getLastMillisecond(java.util.Calendar calendar)
getLastMillisecond
in class RegularTimePeriod
calendar
- the calendar.
public java.lang.String toString()
toString
in class RegularTimePeriod
public boolean equals(java.lang.Object obj)
obj
- The object.
true
if week and year of this and object are the same.public int hashCode()
The approach described by Joshua Bloch in "Effective Java" has been used here:
http://developer.java.sun.com/developer/Books/effectivejava/Chapter3.pdf
public int compareTo(java.lang.Object o1)
compareTo
in interface java.lang.Comparable
o1
- the object to compare.
public static Week parseWeek(java.lang.String s)
This method is required to accept the format "YYYY-Wnn". It will also accept "Wnn-YYYY". Anything else, at the moment, is a bonus.
s
- string to parse.
null
if the string is not parseable, the week otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |