| java.lang.Object
 java.util.Calendar
All known Subclasses: java.util.GregorianCalendar, com.sun.cldc.util.j2me.CalendarImpl,
| Calendar | | abstract public class Calendar (Code) | | Calendar is an abstract base class for converting between
a Date object and a set of integer fields such as
YEAR, MONTH, DAY, HOUR,
and so on. (A Date object represents a specific instant in
time with millisecond precision. See
Date for information about the Date class.)
Subclasses of Calendar interpret a Date
according to the rules of a specific calendar system.
Like other locale-sensitive classes, Calendar provides a
class method, getInstance, for getting a generally useful
object of this type.
Calendar rightNow = Calendar.getInstance();
A Calendar object can produce all the time field values
needed to implement the date-time formatting for a particular language
and calendar style (for example, Japanese-Gregorian, Japanese-Traditional).
When computing a Date from time fields,
there may be insufficient information to compute the
Date (such as only year and month but no day in the month).
Insufficient information. The calendar will use default
information to specify the missing fields. This may vary by calendar; for
the Gregorian calendar, the default for a field is the same as that of the
start of the epoch: i.e., YEAR = 1970, MONTH = JANUARY, DATE = 1, etc.
Note: The ambiguity in interpretation of what day midnight
belongs to, is resolved as so: midnight "belongs" to the following day.
23:59 on Dec 31, 1969 < 00:00 on Jan 1, 1970.
12:00 PM is midday, and 12:00 AM is midnight.
11:59 PM on Jan 1 < 12:00 AM on Jan 2 < 12:01 AM on Jan 2.
11:59 AM on Mar 10 < 12:00 PM on Mar 10 < 12:01 PM on Mar 10.
24:00 or greater are invalid.
Hours greater than 12 are invalid in AM/PM mode.
Setting the time will never change the date.
If equivalent times are entered in AM/PM or 24 hour mode, equality will be
determined by the actual time rather than the entered time.
This class has been subset for J2ME based on the JDK 1.3 Calendar class.
Many methods and variables have been pruned, and other methods
simplified, in an effort to reduce the size of this class.
See Also: java.util.Date
See Also: java.util.TimeZone
version:
CLDC 1.1 02/01/2002 (based on JDK 1.3) |
| Field Summary | |
| final public static int | AM
Value of the AM_PM field indicating the
period of the day from midnight to just before noon. | | final public static int | AM_PM
Field number for get and set indicating
whether the HOUR is before or after noon. | | final public static int | APRIL
Value of the MONTH field indicating the
fourth month of the year. | | final public static int | AUGUST
Value of the MONTH field indicating the
eighth month of the year. | | final public static int | DATE
Field number for get and set indicating the
day of the month. | | final public static int | DAY_OF_MONTH
Field number for get and set indicating the
day of the month. | | final public static int | DAY_OF_WEEK
Field number for get and set indicating the
day of the week. | | final public static int | DECEMBER
Value of the MONTH field indicating the
twelfth month of the year. | | final public static int | FEBRUARY
Value of the MONTH field indicating the
second month of the year. | | final public static int | FRIDAY
Value of the DAY_OF_WEEK field indicating
Friday. | | final public static int | HOUR
Field number for get and set indicating the
hour of the morning or afternoon. | | final public static int | HOUR_OF_DAY
Field number for get and set indicating the
hour of the day. | | final public static int | JANUARY
Value of the MONTH field indicating the
first month of the year. | | final public static int | JULY
Value of the MONTH field indicating the
seventh month of the year. | | final public static int | JUNE
Value of the MONTH field indicating the
sixth month of the year. | | final public static int | MARCH
Value of the MONTH field indicating the
third month of the year. | | final public static int | MAY
Value of the MONTH field indicating the
fifth month of the year. | | final public static int | MILLISECOND
Field number for get and set indicating the
millisecond within the second. | | final public static int | MINUTE
Field number for get and set indicating the
minute within the hour. | | final public static int | MONDAY
Value of the DAY_OF_WEEK field indicating
Monday. | | final public static int | MONTH
Field number for get and set indicating the
month. | | final public static int | NOVEMBER
Value of the MONTH field indicating the
eleventh month of the year. | | final public static int | OCTOBER
Value of the MONTH field indicating the
tenth month of the year. | | final public static int | PM
Value of the AM_PM field indicating the
period of the day from noon to just before midnight. | | final public static int | SATURDAY
Value of the DAY_OF_WEEK field indicating
Saturday. | | final public static int | SECOND
Field number for get and set indicating the
second within the minute. | | final public static int | SEPTEMBER
Value of the MONTH field indicating the
ninth month of the year. | | final public static int | SUNDAY
Value of the DAY_OF_WEEK field indicating
Sunday. | | final public static int | THURSDAY
Value of the DAY_OF_WEEK field indicating
Thursday. | | final public static int | TUESDAY
Value of the DAY_OF_WEEK field indicating
Tuesday. | | final public static int | WEDNESDAY
Value of the DAY_OF_WEEK field indicating
Wednesday. | | final public static int | YEAR
Field number for get and set indicating the
year. | | protected int | fields
The field values for the currently set time for this calendar. | | protected boolean | isSet
The flags which tell if a specified time field for the calendar is set. | | protected long | time
The currently set time for this calendar, expressed in milliseconds after
January 1, 1970, 0:00:00 GMT. |
| Constructor Summary | |
| protected | Calendar()
Constructs a Calendar with the default time zone. |
| Method Summary | |
| public boolean | after(Object when)
Compares the time field records.
Equivalent to comparing result of conversion to UTC.
Parameters:
when - the Calendar to be compared with this Calendar. | | public boolean | before(Object when)
Compares the time field records.
Equivalent to comparing result of conversion to UTC.
Parameters:
when - the Calendar to be compared with this Calendar. | | abstract protected void | computeFields()
Converts
the current millisecond time value
time
to field values in fields[]. | | abstract protected void | computeTime()
Converts the current field values in fields[]
to the millisecond time value
time. | | public boolean | equals(Object obj)
Compares this calendar to the specified object.
The result is true if and only if the argument is
not null and is a Calendar object that
represents the same calendar as this object.
Parameters:
obj - the object to compare with. | | final public int | get(int field)
Gets the value for a given time field. | | public static synchronized Calendar | getInstance()
Gets a calendar using the default time zone. | | public static synchronized Calendar | getInstance(TimeZone zone)
Gets a calendar using the specified time zone. | | final public Date | getTime()
Gets this Calendar's current time. | | protected long | getTimeInMillis()
Gets this Calendar's current time as a long expressed in milliseconds
after January 1, 1970, 0:00:00 GMT (the epoch). | | public TimeZone | getTimeZone()
Gets the time zone. | | final public void | set(int field, int value)
Sets the time field with the given value. | | final public void | setTime(Date date)
Sets this Calendar's current time with the given Date. | | protected void | setTimeInMillis(long millis)
Sets this Calendar's current time from the given long value. | | public void | setTimeZone(TimeZone value)
Sets the time zone with the given time zone value. |
| AM | | final public static int AM(Code) | | Value of the AM_PM field indicating the
period of the day from midnight to just before noon.
|
| AM_PM | | final public static int AM_PM(Code) | | 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.
See Also: Calendar.AM
See Also: Calendar.PM
See Also: Calendar.HOUR |
| APRIL | | final public static int APRIL(Code) | | Value of the MONTH field indicating the
fourth month of the year.
|
| AUGUST | | final public static int AUGUST(Code) | | Value of the MONTH field indicating the
eighth month of the year.
|
| DATE | | final public static int DATE(Code) | | Field number for get and set indicating the
day of the month. This is a synonym for DAY_OF_MONTH.
See Also: Calendar.DAY_OF_MONTH |
| DAY_OF_MONTH | | final public static int DAY_OF_MONTH(Code) | | Field number for get and set indicating the
day of the month. This is a synonym for DATE.
See Also: Calendar.DATE |
| DAY_OF_WEEK | | final public static int DAY_OF_WEEK(Code) | | Field number for get and set indicating the
day of the week.
|
| DECEMBER | | final public static int DECEMBER(Code) | | Value of the MONTH field indicating the
twelfth month of the year.
|
| FEBRUARY | | final public static int FEBRUARY(Code) | | Value of the MONTH field indicating the
second month of the year.
|
| FRIDAY | | final public static int FRIDAY(Code) | | Value of the DAY_OF_WEEK field indicating
Friday.
|
| HOUR | | final public static int HOUR(Code) | | Field number for get and set indicating the
hour of the morning or afternoon. HOUR is used for the
12-hour clock.
E.g., at 10:04:15.250 PM the HOUR is 10.
See Also: Calendar.AM_PM
See Also: Calendar.HOUR_OF_DAY |
| HOUR_OF_DAY | | final public static int HOUR_OF_DAY(Code) | | 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.
|
| JANUARY | | final public static int JANUARY(Code) | | Value of the MONTH field indicating the
first month of the year.
|
| JULY | | final public static int JULY(Code) | | Value of the MONTH field indicating the
seventh month of the year.
|
| JUNE | | final public static int JUNE(Code) | | Value of the MONTH field indicating the
sixth month of the year.
|
| MARCH | | final public static int MARCH(Code) | | Value of the MONTH field indicating the
third month of the year.
|
| MAY | | final public static int MAY(Code) | | Value of the MONTH field indicating the
fifth month of the year.
|
| MILLISECOND | | final public static int MILLISECOND(Code) | | Field number for get and set indicating the
millisecond within the second.
E.g., at 10:04:15.250 PM the MILLISECOND is 250.
|
| MINUTE | | final public static int MINUTE(Code) | | Field number for get and set indicating the
minute within the hour.
E.g., at 10:04:15.250 PM the MINUTE is 4.
|
| MONDAY | | final public static int MONDAY(Code) | | Value of the DAY_OF_WEEK field indicating
Monday.
|
| MONTH | | final public static int MONTH(Code) | | Field number for get and set indicating the
month. This is a calendar-specific value.
|
| NOVEMBER | | final public static int NOVEMBER(Code) | | Value of the MONTH field indicating the
eleventh month of the year.
|
| OCTOBER | | final public static int OCTOBER(Code) | | Value of the MONTH field indicating the
tenth month of the year.
|
| PM | | final public static int PM(Code) | | Value of the AM_PM field indicating the
period of the day from noon to just before midnight.
|
| SATURDAY | | final public static int SATURDAY(Code) | | Value of the DAY_OF_WEEK field indicating
Saturday.
|
| SECOND | | final public static int SECOND(Code) | | Field number for get and set indicating the
second within the minute.
E.g., at 10:04:15.250 PM the SECOND is 15.
|
| SEPTEMBER | | final public static int SEPTEMBER(Code) | | Value of the MONTH field indicating the
ninth month of the year.
|
| SUNDAY | | final public static int SUNDAY(Code) | | Value of the DAY_OF_WEEK field indicating
Sunday.
|
| THURSDAY | | final public static int THURSDAY(Code) | | Value of the DAY_OF_WEEK field indicating
Thursday.
|
| TUESDAY | | final public static int TUESDAY(Code) | | Value of the DAY_OF_WEEK field indicating
Tuesday.
|
| WEDNESDAY | | final public static int WEDNESDAY(Code) | | Value of the DAY_OF_WEEK field indicating
Wednesday.
|
| YEAR | | final public static int YEAR(Code) | | Field number for get and set indicating the
year. This is a calendar-specific value.
|
| fields | | protected int fields(Code) | | The field values for the currently set time for this calendar.
|
| isSet | | protected boolean isSet(Code) | | The flags which tell if a specified time field for the calendar is set.
This is an array of FIELD_COUNT booleans,
|
| time | | protected long time(Code) | | The currently set time for this calendar, expressed in milliseconds after
January 1, 1970, 0:00:00 GMT.
|
| after | | public boolean after(Object when)(Code) | | Compares the time field records.
Equivalent to comparing result of conversion to UTC.
Parameters:
when - the Calendar to be compared with this Calendar. true if the current time of this Calendar is afterthe time of Calendar when; false otherwise. |
| before | | public boolean before(Object when)(Code) | | Compares the time field records.
Equivalent to comparing result of conversion to UTC.
Parameters:
when - the Calendar to be compared with this Calendar. true if the current time of this Calendar is beforethe time of Calendar when; false otherwise. |
| computeFields | | abstract protected void computeFields()(Code) | | Converts
the current millisecond time value
time
to field values in fields[].
This allows you to sync up the time field values with
a new time that is set for the calendar.
|
| computeTime | | abstract protected void computeTime()(Code) | | Converts the current field values in fields[]
to the millisecond time value
time.
|
| equals | | public boolean equals(Object obj)(Code) | | Compares this calendar to the specified object.
The result is true if and only if the argument is
not null and is a Calendar object that
represents the same calendar as this object.
Parameters:
obj - the object to compare with. true if the objects are the same;false otherwise. |
| get | | final public int get(int field)(Code) | | Gets the value for a given time field.
Parameters:
field - the given time field (either YEAR, MONTH, DATE, DAY_OF_WEEK,HOUR_OF_DAY, HOUR, AM_PM, MINUTE,SECOND, or MILLISECOND the value for the given time field.
exception:
ArrayIndexOutOfBoundsException - if the parameter is notone of the above. |
| getInstance | | public static synchronized Calendar getInstance()(Code) | | Gets a calendar using the default time zone.
a Calendar. |
| getInstance | | public static synchronized Calendar getInstance(TimeZone zone)(Code) | | Gets a calendar using the specified time zone.
Parameters:
zone - the time zone to use a Calendar. |
| getTimeInMillis | | protected long getTimeInMillis()(Code) | | Gets this Calendar's current time as a long expressed in milliseconds
after January 1, 1970, 0:00:00 GMT (the epoch).
the current time as UTC milliseconds from the epoch.
See Also: Calendar.setTimeInMillis |
| set | | final public void set(int field, int value)(Code) | | Sets the time field with the given value.
Parameters:
field - the given time field.
Parameters:
value - the value to be set for the given time field.
exception:
ArrayIndexOutOfBoundsException - if an illegal fieldparameter is received. |
| setTime | | final public void setTime(Date date)(Code) | | Sets this Calendar's current time with the given Date.
Note: Calling setTime() with
Date(Long.MAX_VALUE) or Date(Long.MIN_VALUE)
may yield incorrect field values from get().
Parameters:
date - the given Date.
See Also: Calendar.getTime |
| setTimeInMillis | | protected void setTimeInMillis(long millis)(Code) | | Sets this Calendar's current time from the given long value.
Parameters:
millis - the new time in UTC milliseconds from the epoch.
See Also: Calendar.getTimeInMillis |
| setTimeZone | | public void setTimeZone(TimeZone value)(Code) | | Sets the time zone with the given time zone value.
Parameters:
value - the given time zone.
See Also: Calendar.getTimeZone |
|
|