java.lang.Objectjava.util.Calendar
All Implemented Interfaces:
Cloneable, Comparable, java$io$Serializable
Direct Known Subclasses:
JapaneseImperialCalendar, GregorianCalendar
Calendar
class is an abstract class that provides methods
for converting between a specific instant in time and a set of calendar fields such as YEAR
, MONTH
,
DAY_OF_MONTH
, HOUR
, and so on, and for
manipulating the calendar fields, such as getting the date of the next
week. An instant in time can be represented by a millisecond value that is
an offset from the Epoch, January 1, 1970
00:00:00.000 GMT (Gregorian).
The class also provides additional fields and methods for
implementing a concrete calendar system outside the package. Those
fields and methods are defined as protected
.
Like other locale-sensitive classes, Calendar
provides a
class method, getInstance
, for getting a generally useful
object of this type. Calendar
's getInstance
method
returns a Calendar
object whose
calendar fields have been initialized with the current date and time:
Calendar rightNow = Calendar.getInstance();
A Calendar
object can produce all the calendar field values
needed to implement the date-time formatting for a particular language and
calendar style (for example, Japanese-Gregorian, Japanese-Traditional).
Calendar
defines the range of values returned by
certain calendar fields, as well as their meaning. For example,
the first month of the calendar system has value MONTH ==
JANUARY
for all calendars. Other values are defined by the
concrete subclass, such as ERA
. See individual field
documentation and subclass documentation for details.
The calendar field values can be set by calling the set
methods. Any field values set in a Calendar
will not be
interpreted until it needs to calculate its time value (milliseconds from
the Epoch) or values of the calendar fields. Calling the
get
, getTimeInMillis
, getTime
,
add
and roll
involves such calculation.
Calendar
has two modes for interpreting the calendar
fields, lenient and non-lenient. When a
Calendar
is in lenient mode, it accepts a wider range of
calendar field values than it produces. When a Calendar
recomputes calendar field values for return by get()
, all of
the calendar fields are normalized. For example, a lenient
GregorianCalendar
interprets MONTH == JANUARY
,
DAY_OF_MONTH == 32
as February 1.
When a Calendar
is in non-lenient mode, it throws an
exception if there is any inconsistency in its calendar fields. For
example, a GregorianCalendar
always produces
DAY_OF_MONTH
values between 1 and the length of the month. A
non-lenient GregorianCalendar
throws an exception upon
calculating its time or calendar field values if any out-of-range field
value has been set.
Calendar
defines a locale-specific seven day week using two
parameters: the first day of the week and the minimal days in first week
(from 1 to 7). These numbers are taken from the locale resource data when a
Calendar
is constructed. They may also be specified explicitly
through the methods for setting their values.
When setting or getting the WEEK_OF_MONTH
or
WEEK_OF_YEAR
fields, Calendar
must determine the
first week of the month or year as a reference point. The first week of a
month or year is defined as the earliest seven day period beginning on
getFirstDayOfWeek()
and containing at least
getMinimalDaysInFirstWeek()
days of that month or year. Weeks
numbered ..., -1, 0 precede the first week; weeks numbered 2, 3,... follow
it. Note that the normalized numbering returned by get()
may be
different. For example, a specific Calendar
subclass may
designate the week before week 1 of a year as week n
of
the previous year.
Calendar
will resolve
calendar field values to determine the date and time in the
following way.
If there is any conflict in calendar field values,
Calendar
gives priorities to calendar fields that have been set
more recently. The following are the default combinations of the
calendar fields. The most recent combination, as determined by the
most recently set single field, will be used.
For the time of day fields:YEAR + MONTH + DAY_OF_MONTH YEAR + MONTH + WEEK_OF_MONTH + DAY_OF_WEEK YEAR + MONTH + DAY_OF_WEEK_IN_MONTH + DAY_OF_WEEK YEAR + DAY_OF_YEAR YEAR + DAY_OF_WEEK + WEEK_OF_YEAR
HOUR_OF_DAY AM_PM + HOUR
If there are any calendar fields whose values haven't been set in the selected
field combination, Calendar
uses their default values. The default
value of each field may vary by concrete calendar systems. For example, in
GregorianCalendar
, the default of a field is the same as that
of the start of the Epoch: i.e., YEAR = 1970
, MONTH =
JANUARY
, DAY_OF_MONTH = 1
, etc.
Note: There are certain possible ambiguities in interpretation of certain singular times, which are resolved in the following ways:
The date or time format strings are not part of the definition of a calendar, as those must be modifiable or overridable by the user at runtime. Use DateFormat to format dates.
set()
, add()
, and roll()
.
set(f, value)
changes calendar field
f
to value
. In addition, it sets an
internal member variable to indicate that calendar field f
has
been changed. Although calendar field f
is changed immediately,
the calendar's time value in milliseconds is not recomputed until the next call to
get()
, getTime()
, getTimeInMillis()
,
add()
, or roll()
is made. Thus, multiple calls to
set()
do not trigger multiple, unnecessary
computations. As a result of changing a calendar field using
set()
, other calendar fields may also change, depending on the
calendar field, the calendar field value, and the calendar system. In addition,
get(f)
will not necessarily return value
set by
the call to the set
method
after the calendar fields have been recomputed. The specifics are determined by
the concrete calendar class.
Example: Consider a GregorianCalendar
originally set to August 31, 1999. Calling set(Calendar.MONTH,
Calendar.SEPTEMBER)
sets the date to September 31,
1999. This is a temporary internal representation that resolves to
October 1, 1999 if getTime()
is then called. However, a
call to set(Calendar.DAY_OF_MONTH, 30)
before the call to
getTime()
sets the date to September 30, 1999, since
no recomputation occurs after set()
itself.
add(f, delta)
adds delta
to field f
. This is equivalent to calling set(f,
get(f) + delta)
with two adjustments:
Add rule 1. The value of field
f
after the call minus the value of fieldf
before the call isdelta
, modulo any overflow that has occurred in fieldf
. Overflow occurs when a field value exceeds its range and, as a result, the next larger field is incremented or decremented and the field value is adjusted back into its range.Add rule 2. If a smaller field is expected to be invariant, but it is impossible for it to be equal to its prior value because of changes in its minimum or maximum after field
f
is changed or other constraints, such as time zone offset changes, then its value is adjusted to be as close as possible to its expected value. A smaller field represents a smaller unit of time.HOUR
is a smaller field thanDAY_OF_MONTH
. No adjustment is made to smaller fields that are not expected to be invariant. The calendar system determines what fields are expected to be invariant.
In addition, unlike set()
, add()
forces
an immediate recomputation of the calendar's milliseconds and all
fields.
Example: Consider a GregorianCalendar
originally set to August 31, 1999. Calling add(Calendar.MONTH,
13)
sets the calendar to September 30, 2000. Add rule
1 sets the MONTH
field to September, since
adding 13 months to August gives September of the next year. Since
DAY_OF_MONTH
cannot be 31 in September in a
GregorianCalendar
, add rule 2 sets the
DAY_OF_MONTH
to 30, the closest possible value. Although
it is a smaller field, DAY_OF_WEEK
is not adjusted by
rule 2, since it is expected to change when the month changes in a
GregorianCalendar
.
roll(f, delta)
adds
delta
to field f
without changing larger
fields. This is equivalent to calling add(f, delta)
with
the following adjustment:
Roll rule. Larger fields are unchanged after the call. A larger field represents a larger unit of time.
DAY_OF_MONTH
is a larger field thanHOUR
.
Example: See java.util.GregorianCalendar#roll(int, int) .
Usage model. To motivate the behavior of
add()
and roll()
, consider a user interface
component with increment and decrement buttons for the month, day, and
year, and an underlying GregorianCalendar
. If the
interface reads January 31, 1999 and the user presses the month
increment button, what should it read? If the underlying
implementation uses set()
, it might read March 3, 1999. A
better result would be February 28, 1999. Furthermore, if the user
presses the month increment button again, it should read March 31,
1999, not March 28, 1999. By saving the original date and using either
add()
or roll()
, depending on whether larger
fields should be affected, the user interface can behave as most users
will intuitively expect.
Mark
- Davis, David Goldsmith, Chen-Lieh Huang, Alan LiuJDK1.1
- Field Summary | ||
---|---|---|
public static final int | ERA | Field number for get and set indicating the
era, e.g., AD or BC in the Julian calendar. This is a calendar-specific
value; see subclass documentation.
|
public static final int | YEAR | Field number for get and set indicating the
year. This is a calendar-specific value; see subclass documentation. |
public static final int | MONTH | Field number for get and set indicating the
month. This is a calendar-specific value. The first month of
the year in the Gregorian and Julian calendars is
JANUARY which is 0; the last depends on the number
of months in a year. |
public static final int | WEEK_OF_YEAR | Field number for get and set indicating the
week number within the current year. The first week of the year, as
defined by getFirstDayOfWeek() and
getMinimalDaysInFirstWeek() , has value 1. Subclasses define
the value of WEEK_OF_YEAR for days before the first week of
the year. |
public static final int | WEEK_OF_MONTH | Field number for get and set indicating the
week number within the current month. The first week of the month, as
defined by getFirstDayOfWeek() and
getMinimalDaysInFirstWeek() , has value 1. Subclasses define
the value of WEEK_OF_MONTH for days before the first week of
the month. |
public static final int | DATE | Field number for get and set indicating the
day of the month. This is a synonym for DAY_OF_MONTH .
The first day of the month has value 1.
|
public static final int | DAY_OF_MONTH | Field number for get and set indicating the
day of the month. This is a synonym for DATE .
The first day of the month has value 1.
|
public static final int | DAY_OF_YEAR | Field number for get and set indicating the day
number within the current year. The first day of the year has value 1. |
public static final int | DAY_OF_WEEK | Field number for get and set indicating the day
of the week. This field takes values SUNDAY ,
MONDAY , TUESDAY , WEDNESDAY ,
THURSDAY , FRIDAY , and SATURDAY . |
public static final int | DAY_OF_WEEK_IN_MONTH | Field number for get and set indicating the
ordinal number of the day of the week within the current month. Together
with the DAY_OF_WEEK field, this uniquely specifies a day
within a month. Unlike WEEK_OF_MONTH and
WEEK_OF_YEAR , this field's value does not depend on
getFirstDayOfWeek() or
getMinimalDaysInFirstWeek() . DAY_OF_MONTH 1
through 7 always correspond to DAY_OF_WEEK_IN_MONTH
1 ; 8 through 14 correspond to
DAY_OF_WEEK_IN_MONTH 2 , and so on.
DAY_OF_WEEK_IN_MONTH 0 indicates the week before
DAY_OF_WEEK_IN_MONTH 1 . Negative values count back from the
end of the month, so the last Sunday of a month is specified as
DAY_OF_WEEK = SUNDAY, DAY_OF_WEEK_IN_MONTH = -1 . Because
negative values count backward they will usually be aligned differently
within the month than positive values. For example, if a month has 31
days, DAY_OF_WEEK_IN_MONTH -1 will overlap
DAY_OF_WEEK_IN_MONTH 5 and the end of 4 .
|
public static final int | AM_PM | Field number for get and set indicating
whether the HOUR is before or after noon.
E.g., at 10:04:15.250 PM the AM_PM is PM . |
public static final int | HOUR | Field number for get and set indicating the
hour of the morning or afternoon. HOUR is used for the
12-hour clock (0 - 11). Noon and midnight are represented by 0, not by 12.
E.g., at 10:04:15.250 PM the HOUR is 10.
|
public static final int | HOUR_OF_DAY | Field number for get and set indicating the
hour of the day. HOUR_OF_DAY is used for the 24-hour clock.
E.g., at 10:04:15.250 PM the HOUR_OF_DAY is 22.
|
public static final int | MINUTE | Field number for get and set indicating the
minute within the hour.
E.g., at 10:04:15.250 PM the MINUTE is 4. |
public static final int | SECOND | Field number for get and set indicating the
second within the minute.
E.g., at 10:04:15.250 PM the SECOND is 15. |
public static final int | MILLISECOND | Field number for get and set indicating the
millisecond within the second.
E.g., at 10:04:15.250 PM the MILLISECOND is 250. |
public static final int | ZONE_OFFSET | Field number for get and set
indicating the raw offset from GMT in milliseconds.
This field reflects the correct GMT offset value of the time
zone of this |
public static final int | DST_OFFSET | Field number for get and set indicating the
daylight saving offset in milliseconds.
This field reflects the correct daylight saving offset value of
the time zone of this |
public static final int | FIELD_COUNT | The number of distinct fields recognized by get and set .
Field numbers range from 0..FIELD_COUNT-1 . |
public static final int | SUNDAY | Value of the #DAY_OF_WEEK field indicating Sunday. |
public static final int | MONDAY | Value of the #DAY_OF_WEEK field indicating Monday. |
public static final int | TUESDAY | Value of the #DAY_OF_WEEK field indicating Tuesday. |
public static final int | WEDNESDAY | Value of the #DAY_OF_WEEK field indicating Wednesday. |
public static final int | THURSDAY | Value of the #DAY_OF_WEEK field indicating Thursday. |
public static final int | FRIDAY | Value of the #DAY_OF_WEEK field indicating Friday. |
public static final int | SATURDAY | Value of the #DAY_OF_WEEK field indicating Saturday. |
public static final int | JANUARY | Value of the #MONTH field indicating the first month of the year in the Gregorian and Julian calendars. |
public static final int | FEBRUARY | Value of the #MONTH field indicating the second month of the year in the Gregorian and Julian calendars. |
public static final int | MARCH | Value of the #MONTH field indicating the third month of the year in the Gregorian and Julian calendars. |
public static final int | APRIL | Value of the #MONTH field indicating the fourth month of the year in the Gregorian and Julian calendars. |
public static final int | MAY | Value of the #MONTH field indicating the fifth month of the year in the Gregorian and Julian calendars. |
public static final int | JUNE | Value of the #MONTH field indicating the sixth month of the year in the Gregorian and Julian calendars. |
public static final int | JULY | Value of the #MONTH field indicating the seventh month of the year in the Gregorian and Julian calendars. |
public static final int | AUGUST | Value of the #MONTH field indicating the eighth month of the year in the Gregorian and Julian calendars. |
public static final int | SEPTEMBER | Value of the #MONTH field indicating the ninth month of the year in the Gregorian and Julian calendars. |
public static final int | OCTOBER | Value of the #MONTH field indicating the tenth month of the year in the Gregorian and Julian calendars. |
public static final int | NOVEMBER | Value of the #MONTH field indicating the eleventh month of the year in the Gregorian and Julian calendars. |
public static final int | DECEMBER | Value of the #MONTH field indicating the twelfth month of the year in the Gregorian and Julian calendars. |
public static final int | UNDECIMBER | Value of the #MONTH field indicating the
thirteenth month of the year. Although GregorianCalendar
does not use this value, lunar calendars do. |
public static final int | AM | Value of the #AM_PM field indicating the period of the day from midnight to just before noon. |
public static final int | PM | Value of the #AM_PM field indicating the period of the day from noon to just before midnight. |
public static final int | ALL_STYLES | A style specifier for int, Locale) getDisplayNames indicating names in all styles, such as "January" and "Jan". |
public static final int | SHORT | A style specifier for int, Locale)
getDisplayName and int, Locale)
getDisplayNames indicating a short name, such as "Jan".
|
public static final int | LONG | A style specifier for int, Locale)
getDisplayName and int, Locale)
getDisplayNames indicating a long name, such as "January".
|
protected int[] | fields | The calendar field values for the currently set time for this calendar.
This is an array of FIELD_COUNT integers, with index values
ERA through DST_OFFSET .
|
protected boolean[] | isSet | The flags which tell if a specified calendar field for the calendar is set.
A new object has no fields set. After the first call to a method
which generates the fields, they all remain set after that.
This is an array of FIELD_COUNT booleans, with index values
ERA through DST_OFFSET .
|
protected long | time | The currently set time for this calendar, expressed in milliseconds after
January 1, 1970, 0:00:00 GMT.
|
protected boolean | isTimeSet | True if then the value of time is valid.
The time is made invalid by a change to an item of field[] .
|
protected boolean | areFieldsSet | True if fields[] are in sync with the currently set time.
If false, then the next attempt to get the value of a field will
force a recomputation of all fields from the current value of
time .
|
transient boolean | areAllFieldsSet | True if all fields have been set.
|
static final int | ALL_FIELDS | The mask value that represents all of the fields. |
static final int | currentSerialVersion | |
static final long | serialVersionUID | |
static final int | ERA_MASK | |
static final int | YEAR_MASK | |
static final int | MONTH_MASK | |
static final int | WEEK_OF_YEAR_MASK | |
static final int | WEEK_OF_MONTH_MASK | |
static final int | DAY_OF_MONTH_MASK | |
static final int | DATE_MASK | |
static final int | DAY_OF_YEAR_MASK | |
static final int | DAY_OF_WEEK_MASK | |
static final int | DAY_OF_WEEK_IN_MONTH_MASK | |
static final int | AM_PM_MASK | |
static final int | HOUR_MASK | |
static final int | HOUR_OF_DAY_MASK | |
static final int | MINUTE_MASK | |
static final int | SECOND_MASK | |
static final int | MILLISECOND_MASK | |
static final int | ZONE_OFFSET_MASK | |
static final int | DST_OFFSET_MASK |
Constructor: |
---|
|
|
Methods from java.lang.Object: |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method from java.util.Calendar Detail: |
---|
|
Calendar represents a time
after the time represented by the specified
Object . This method is equivalent to:
if and only ifcompareTo(when) > 0 when is a Calendar
instance. Otherwise, the method returns false . |
Calendar represents a time
before the time represented by the specified
Object . This method is equivalent to:
if and only ifcompareTo(when) < 0 when is a Calendar
instance. Otherwise, the method returns false . |
|
Calendar undefined. This means that isSet() will return false for all the
calendar fields, and the date and time calculations will treat
the fields as if they had never been set. A
Calendar implementation class may use its specific
default field values for date/time calculations. For example,
GregorianCalendar uses 1970 if the
YEAR field value is undefined. |
Calendar undefined. This means that isSet(field) will return false , and
the date and time calculations will treat the field as if it
had never been set. A Calendar implementation
class may use the field's specific default value for date and
time calculations.
The #HOUR_OF_DAY , #HOUR and #AM_PM
fields are handled independently and the the resolution rule for the time of
day is applied. Clearing one of the fields doesn't reset
the hour of day value of this |
|
Calendar objects. |
|
|
|
Calendar to the specified
Object . The result is true if and only if
the argument is a Calendar object of the same calendar
system that represents the same time value (millisecond offset from the
Epoch) under the same
Calendar parameters as this object.
The Use the compareTo method to compare only the time values. |
|
Calendar . For example, the actual maximum value of
the MONTH field is 12 in some years, and 13 in
other years in the Hebrew calendar system.
The default implementation of this method uses an iterative algorithm to determine the actual maximum value for the calendar field. Subclasses should, if possible, override this with a more efficient implementation. |
Calendar .
The default implementation of this method uses an iterative
algorithm to determine the actual minimum value for the
calendar field. Subclasses should, if possible, override this
with a more efficient implementation - in many cases, they can
simply return |
getInstance
methods of this class can return localized instances.
The array returned must contain at least a Locale
instance equal to Locale.US . |
field value in the given style and
locale . If no string representation is
applicable, null is returned. This method calls
get(field) to get the calendar
field value if the string representation is
applicable to the given calendar field .
For example, if this The default implementation supports the calendar fields for
which a DateFormatSymbols has names in the given
|
Map containing all names of the calendar
field in the given style and
locale and their corresponding field values. For
example, if this Calendar is a GregorianCalendar , the returned map would contain "Jan" to
#JANUARY , "Feb" to #FEBRUARY , and so on, in the
{@linkplain #SHORT short} style in an English locale.
The values of other calendar fields may be taken into
account to determine a set of display names. For example, if
this The default implementation supports display names contained in
a DateFormatSymbols . For example, if |
|
SUNDAY in the U.S.,
MONDAY in France. |
Calendar instance. The highest minimum
value is defined as the largest value returned by #getActualMinimum(int) for any possible time value. The
greatest minimum value depends on calendar system specific
parameters of the instance. |
Calendar returned is based on the current time
in the default time zone with the default locale. |
Calendar returned is based on the current time
in the given time zone with the default locale. |
Calendar returned is based on the current time
in the default time zone with the given locale. |
Calendar returned is based on the current time
in the given time zone with the given locale. |
Calendar instance. The lowest maximum
value is defined as the smallest value returned by #getActualMaximum(int) for any possible time value. The least
maximum value depends on calendar system specific parameters of
the instance. For example, a Calendar for the
Gregorian calendar system returns 28 for the
DAY_OF_MONTH field, because the 28th is the last
day of the shortest month of this calendar, February in a
common year. |
Calendar instance. The maximum value is defined as
the largest value returned by the get method
for any possible time value. The maximum value depends on
calendar system specific parameters of the instance. |
|
Calendar instance. The minimum value is defined as
the smallest value returned by the get method
for any possible time value. The minimum value depends on
calendar system specific parameters of the instance. |
|
Date object representing this
Calendar 's time value (millisecond offset from the Epoch"). |
|
|
The default implementation of this method throws an UnsupportedOperationException . |
The default implementation of this method throws an {@code UnsupportedOperationException}. |
|
|
|
Calendar instance. |
|
field is on in the
fieldMask . |
|
|
|
get method call. |
The default implementation of this method returns {@code false}. |
roll(Calendar.DATE, true).
When rolling on the year or Calendar.YEAR field, it will roll the year
value in the range between 1 and the value returned by calling
|
NOTE: This default implementation on |
field is (1 <<
field) . For example, 0x26 represents the YEAR ,
MONTH , and DAY_OF_MONTH fields (i.e., 0x26 is
equal to
(1<<YEAR)|(1<<MONTH)|(1<<DAY_OF_MONTH)) .
This method supports the calendar fields resolution as described in
the class description. If the bit mask for a given field is on and its
field has not been set (i.e., |
|
YEAR ,
MONTH , and DAY_OF_MONTH .
Previous values of other calendar fields are retained. If this is not desired,
call #clear() first. |
YEAR ,
MONTH , DAY_OF_MONTH ,
HOUR_OF_DAY , and MINUTE .
Previous values of other fields are retained. If this is not desired,
call #clear() first. |
YEAR , MONTH ,
DAY_OF_MONTH , HOUR , MINUTE , and
SECOND .
Previous values of other fields are retained. If this is not desired,
call #clear() first. |
|
fieldMask to unset. If fieldMask
specifies all the calendar fields, then the state of this
Calendar becomes that all the calendar fields are in sync
with the time value (millisecond offset from the Epoch). |
SUNDAY in the U.S.,
MONDAY in France. |
|
|
Date .
Note: Calling |
|
|
|
Unlike the {@code set} method, all of the calendar fields and {@code time} values are calculated upon return. If {@code weekOfYear} is out of the valid week-of-year range in {@code weekYear}, the {@code weekYear} and {@code weekOfYear} values are adjusted in lenient mode, or an {@code IllegalArgumentException} is thrown in non-lenient mode. The default implementation of this method throws an {@code UnsupportedOperationException}. |
shared . |
null . |