| public class java.util GregorianCalendar
|
Java SE 6 |
GregorianCalendar is a concrete subclass of
Calendar and provides the standard calendar system
used by most of the world.
GregorianCalendar is a hybrid calendar that
supports both the Julian and Gregorian calendar systems with the
support of a single discontinuity, which corresponds by default to
the Gregorian date when the Gregorian calendar was instituted
(October 15, 1582 in some countries, later in others). The cutover
date may be changed by the caller by calling setGregorianChange().
Historically, in those countries which adopted the Gregorian calendar first,
October 4, 1582 (Julian) was thus followed by October 15, 1582 (Gregorian). This calendar models
this correctly. Before the Gregorian cutover, GregorianCalendar
implements the Julian calendar. The only difference between the Gregorian
and the Julian calendar is the leap year rule. The Julian calendar specifies
leap years every four years, whereas the Gregorian calendar omits century
years which are not divisible by 400.
GregorianCalendar implements proleptic Gregorian and
Julian calendars. That is, dates are computed by extrapolating the current
rules indefinitely far backward and forward in time. As a result,
GregorianCalendar may be used for all years to generate
meaningful and consistent results. However, dates obtained using
GregorianCalendar are historically accurate only from March 1, 4
AD onward, when modern Julian calendar rules were adopted. Before this date,
leap year rules were applied irregularly, and before 45 BC the Julian
calendar did not even exist.
Prior to the institution of the Gregorian calendar, New Year's Day was March 25. To avoid confusion, this calendar always uses January 1. A manual adjustment may be made if desired for dates that are prior to the Gregorian changeover and which fall between January 1 and March 24.
Values calculated for the WEEK_OF_YEAR field range from 1 to
53. Week 1 for a year is the earliest seven day period starting on
getFirstDayOfWeek() that contains at least
getMinimalDaysInFirstWeek() days from that year. It thus
depends on the values of getMinimalDaysInFirstWeek(),
getFirstDayOfWeek(), and the day of the week of January 1.
Weeks between week 1 of one year and week 1 of the following year are
numbered sequentially from 2 to 52 or 53 (as needed).
For example, January 1, 1998 was a Thursday. If
getFirstDayOfWeek() is MONDAY and
getMinimalDaysInFirstWeek() is 4 (these are the values
reflecting ISO 8601 and many national standards), then week 1 of 1998 starts
on December 29, 1997, and ends on January 4, 1998. If, however,
getFirstDayOfWeek() is SUNDAY, then week 1 of 1998
starts on January 4, 1998, and ends on January 10, 1998; the first three days
of 1998 then are part of week 53 of 1997.
Values calculated for the WEEK_OF_MONTH field range from 0
to 6. Week 1 of a month (the days with WEEK_OF_MONTH =
1) is the earliest set of at least
getMinimalDaysInFirstWeek() contiguous days in that month,
ending on the day before getFirstDayOfWeek(). Unlike
week 1 of a year, week 1 of a month may be shorter than 7 days, need
not start on getFirstDayOfWeek(), and will not include days of
the previous month. Days of a month before week 1 have a
WEEK_OF_MONTH of 0.
For example, if getFirstDayOfWeek() is SUNDAY
and getMinimalDaysInFirstWeek() is 4, then the first week of
January 1998 is Sunday, January 4 through Saturday, January 10. These days
have a WEEK_OF_MONTH of 1. Thursday, January 1 through
Saturday, January 3 have a WEEK_OF_MONTH of 0. If
getMinimalDaysInFirstWeek() is changed to 3, then January 1
through January 3 have a WEEK_OF_MONTH of 1.
The clear methods set calendar field(s)
undefined. GregorianCalendar uses the following
default value for each calendar field if its value is undefined.
| Field |
Default Value |
|---|---|
ERA
|
AD
|
YEAR
|
1970
|
MONTH
|
JANUARY
|
DAY_OF_MONTH
|
1
|
DAY_OF_WEEK
|
the first day of week
|
WEEK_OF_MONTH
|
0
|
DAY_OF_WEEK_IN_MONTH
|
1
|
AM_PM
|
AM
|
HOUR, HOUR_OF_DAY, MINUTE, SECOND, MILLISECOND
|
0
|
Example:
// get the supported ids for GMT-08:00 (Pacific Standard Time)
String[] ids = TimeZone.getAvailableIDs(-8 * 60 * 60 * 1000);
// if no ids were returned, something is wrong. get out.
if (ids.length == 0)
System.exit(0);
// begin output
System.out.println("Current Time");
// create a Pacific Standard Time time zone
SimpleTimeZone pdt = new SimpleTimeZone(-8 * 60 * 60 * 1000, ids[0]);
// set up rules for daylight savings time
pdt.setStartRule(Calendar.APRIL, 1, Calendar.SUNDAY, 2 * 60 * 60 * 1000);
pdt.setEndRule(Calendar.OCTOBER, -1, Calendar.SUNDAY, 2 * 60 * 60 * 1000);
// create a GregorianCalendar with the Pacific Daylight time zone
// and the current date and time
Calendar calendar = new GregorianCalendar(pdt);
Date trialTime = new Date();
calendar.setTime(trialTime);
// print out a bunch of interesting things
System.out.println("ERA: " + calendar.get(Calendar.ERA));
System.out.println("YEAR: " + calendar.get(Calendar.YEAR));
System.out.println("MONTH: " + calendar.get(Calendar.MONTH));
System.out.println("WEEK_OF_YEAR: " + calendar.get(Calendar.WEEK_OF_YEAR));
System.out.println("WEEK_OF_MONTH: " + calendar.get(Calendar.WEEK_OF_MONTH));
System.out.println("DATE: " + calendar.get(Calendar.DATE));
System.out.println("DAY_OF_MONTH: " + calendar.get(Calendar.DAY_OF_MONTH));
System.out.println("DAY_OF_YEAR: " + calendar.get(Calendar.DAY_OF_YEAR));
System.out.println("DAY_OF_WEEK: " + calendar.get(Calendar.DAY_OF_WEEK));
System.out.println("DAY_OF_WEEK_IN_MONTH: "
+ calendar.get(Calendar.DAY_OF_WEEK_IN_MONTH));
System.out.println("AM_PM: " + calendar.get(Calendar.AM_PM));
System.out.println("HOUR: " + calendar.get(Calendar.HOUR));
System.out.println("HOUR_OF_DAY: " + calendar.get(Calendar.HOUR_OF_DAY));
System.out.println("MINUTE: " + calendar.get(Calendar.MINUTE));
System.out.println("SECOND: " + calendar.get(Calendar.SECOND));
System.out.println("MILLISECOND: " + calendar.get(Calendar.MILLISECOND));
System.out.println("ZONE_OFFSET: "
+ (calendar.get(Calendar.ZONE_OFFSET)/(60*60*1000)));
System.out.println("DST_OFFSET: "
+ (calendar.get(Calendar.DST_OFFSET)/(60*60*1000)));
System.out.println("Current Time, with hour reset to 3");
calendar.clear(Calendar.HOUR_OF_DAY); // so doesn't override
calendar.set(Calendar.HOUR, 3);
System.out.println("ERA: " + calendar.get(Calendar.ERA));
System.out.println("YEAR: " + calendar.get(Calendar.YEAR));
System.out.println("MONTH: " + calendar.get(Calendar.MONTH));
System.out.println("WEEK_OF_YEAR: " + calendar.get(Calendar.WEEK_OF_YEAR));
System.out.println("WEEK_OF_MONTH: " + calendar.get(Calendar.WEEK_OF_MONTH));
System.out.println("DATE: " + calendar.get(Calendar.DATE));
System.out.println("DAY_OF_MONTH: " + calendar.get(Calendar.DAY_OF_MONTH));
System.out.println("DAY_OF_YEAR: " + calendar.get(Calendar.DAY_OF_YEAR));
System.out.println("DAY_OF_WEEK: " + calendar.get(Calendar.DAY_OF_WEEK));
System.out.println("DAY_OF_WEEK_IN_MONTH: "
+ calendar.get(Calendar.DAY_OF_WEEK_IN_MONTH));
System.out.println("AM_PM: " + calendar.get(Calendar.AM_PM));
System.out.println("HOUR: " + calendar.get(Calendar.HOUR));
System.out.println("HOUR_OF_DAY: " + calendar.get(Calendar.HOUR_OF_DAY));
System.out.println("MINUTE: " + calendar.get(Calendar.MINUTE));
System.out.println("SECOND: " + calendar.get(Calendar.SECOND));
System.out.println("MILLISECOND: " + calendar.get(Calendar.MILLISECOND));
System.out.println("ZONE_OFFSET: "
+ (calendar.get(Calendar.ZONE_OFFSET)/(60*60*1000))); // in hours
System.out.println("DST_OFFSET: "
+ (calendar.get(Calendar.DST_OFFSET)/(60*60*1000))); // in hours
| version | 1.92 |
| since | JDK1.1 |
| See also | java.util.TimeZone |
| Fields | |||
|---|---|---|---|
| final public static int | BC Details
Value of the ERA field indicating
the period before the common era (before Christ), also known as BCE.
The sequence of years at the transition from BC to AD is
..., 2 BC, 1 BC, 1 AD, 2 AD,...
| ||
| final public static int | AD Details
Value of the ERA field indicating
the common era (Anno Domini), also known as CE.
The sequence of years at the transition from BC to AD is
..., 2 BC, 1 BC, 1 AD, 2 AD,...
| ||
| Constructors | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| public | GregorianCalendar() Constructs a default GregorianCalendar using the current time
in the default time zone with the default locale.
| ||||||||||||
| public | GregorianCalendar(TimeZone zone) Details
Constructs a GregorianCalendar based on the current time
in the given time zone with the default locale.
| ||||||||||||
| public | GregorianCalendar(Locale aLocale) Details
Constructs a GregorianCalendar based on the current time
in the default time zone with the given locale.
| ||||||||||||
| public | GregorianCalendar(TimeZone zone, Locale aLocale) Details
Constructs a GregorianCalendar based on the current time
in the given time zone with the given locale.
| ||||||||||||
| public | GregorianCalendar(int year, int month, int dayOfMonth) Details
Constructs a GregorianCalendar with the given date set
in the default time zone with the default locale.
| ||||||||||||
| public | GregorianCalendar(int year, int month, int dayOfMonth, int hourOfDay, int minute) Details
Constructs a GregorianCalendar with the given date
and time set for the default time zone with the default locale.
| ||||||||||||
| public | GregorianCalendar(int year, int month, int dayOfMonth, int hourOfDay, int minute, int second) Details
Constructs a GregorianCalendar with the given date
and time set for the default time zone with the default locale.
| ||||||||||||
| Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public void | add(int field, int amount) Details
Adds the specified (signed) amount of time to the given calendar field,
based on the calendar's rules.
Add rule 1. The value of 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
| ||||||||||
| public Object | clone() | ||||||||||
| protected void | computeFields() Details
| ||||||||||
| protected void | computeTime() Details
Converts calendar field values to the time value (millisecond
offset from the Epoch).
| ||||||||||
| public boolean | equals(Object obj) Details
Compares this GregorianCalendar to the specified
Object. The result is true if and
only if the argument is a GregorianCalendar object
that represents the same time value (millisecond offset from
the Epoch) under the same
Calendar parameters and Gregorian change date as
this object.
| ||||||||||
| public int | hashCode() Generates the hash code for this GregorianCalendar object.
| ||||||||||
| public void | roll(int field, boolean up) Details
Adds or subtracts (up/down) a single unit of time on the given time
field without changing larger fields.
Example: Consider a
| ||||||||||
| public void | roll(int field, int amount) Details
Adds a signed amount to the specified calendar field without changing larger fields.
A negative roll amount means to subtract from field without changing
larger fields. If the specified amount is 0, this method performs nothing.
This method calls
Example: Consider a
Example: Consider a
| ||||||||||
| Properties | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| public int | getActualMaximum(int field) Details
Returns the maximum value that this calendar field could have,
taking into consideration the given time value and the current
values of the
getFirstDayOfWeek,
getMinimalDaysInFirstWeek,
getGregorianChange and
getTimeZone methods.
For example, if the date of this instance is February 1, 2004,
the actual maximum value of the DAY_OF_MONTH field
is 29 because 2004 is a leap year, and if the date of this
instance is February 1, 2005, it's 28.
| ||||||||
| public int | getActualMinimum(int field) Details
Returns the minimum value that this calendar field could have,
taking into consideration the given time value and the current
values of the
getFirstDayOfWeek,
getMinimalDaysInFirstWeek,
getGregorianChange and
getTimeZone methods.
For example, if the Gregorian change date is January 10,
1970 and the date of this
| ||||||||
| public int | getGreatestMinimum(int field) Details
Returns the highest minimum value for the given calendar field
of this GregorianCalendar instance. The highest
minimum value is defined as the largest value returned by
#getActualMinimum(int) for any possible time value,
taking into consideration the current values of the
getFirstDayOfWeek,
getMinimalDaysInFirstWeek,
getGregorianChange and
getTimeZone methods.
| ||||||||
| public void | setGregorianChange(Date date) Details
Sets the GregorianCalendar change date. This is the point when the switch
from Julian dates to Gregorian dates occurred. Default is October 15,
1582 (Gregorian). Previous to this, dates will be in the Julian calendar.
To obtain a pure Julian calendar, set the change date to
| ||||||||
| final public Date | getGregorianChange() Details
Gets the Gregorian Calendar change date. This is the point when the
switch from Julian dates to Gregorian dates occurred. Default is
October 15, 1582 (Gregorian). Previous to this, dates will be in the Julian
calendar.
| ||||||||
| public boolean | isLeapYear(int year) Details
Determines if the given year is a leap year. Returns true if
the given year is a leap year. To specify BC year numbers,
1 - year number must be given. For example, year BC 4 is
specified as -3.
| ||||||||
| public int | getLeastMaximum(int field) Details
Returns the lowest maximum value for the given calendar field
of this GregorianCalendar instance. The lowest
maximum value is defined as the smallest value returned by
#getActualMaximum(int) for any possible time value,
taking into consideration the current values of the
getFirstDayOfWeek,
getMinimalDaysInFirstWeek,
getGregorianChange and
getTimeZone methods.
| ||||||||
| public int | getMaximum(int field) Details
Returns the maximum value for the given calendar field of this
GregorianCalendar instance. The maximum value is
defined as the largest value returned by the get method for any possible time value,
taking into consideration the current values of the
getFirstDayOfWeek,
getMinimalDaysInFirstWeek,
getGregorianChange and
getTimeZone methods.
| ||||||||
| public int | getMinimum(int field) Details
Returns the minimum value for the given calendar field of this
GregorianCalendar instance. The minimum value is
defined as the smallest value returned by the get method for any possible time value,
taking into consideration the current values of the
getFirstDayOfWeek,
getMinimalDaysInFirstWeek,
getGregorianChange and
getTimeZone methods.
| ||||||||
| public void | setTimeZone(TimeZone zone) | ||||||||
| public TimeZone | getTimeZone() | ||||||||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2009 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
![]() |
![]() |
|