|
Préférences
Moteurs de recherche
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JavaTM 2 Platform Std. Ed. v1.6.0
java.util
|
Field Summary | |
---|---|
static int |
ALL_STYLES
A style specifier for getDisplayNames indicating names in all styles, such as
"January" and "Jan". |
static int |
AM
Value of the AM_PM field indicating the
period of the day from midnight to just before noon. |
static int |
AM_PM
Field number for get and set indicating
whether the HOUR is before or after noon. |
static int |
APRIL
Value of the MONTH field indicating the
fourth month of the year in the Gregorian and Julian calendars. |
protected boolean |
areFieldsSet
True if fields[] are in sync with the currently set time. |
static int |
AUGUST
Value of the MONTH field indicating the
eighth month of the year in the Gregorian and Julian calendars. |
static int |
DATE
Field number for get and set indicating the
day of the month. |
static int |
DAY_OF_MONTH
Field number for get and set indicating the
day of the month. |
static int |
DAY_OF_WEEK
Field number for get and set indicating the day
of the week. |
static 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. |
static int |
DAY_OF_YEAR
Field number for get and set indicating the day
number within the current year. |
static int |
DECEMBER
Value of the MONTH field indicating the
twelfth month of the year in the Gregorian and Julian calendars. |
static int |
DST_OFFSET
Field number for get and set indicating the
daylight savings offset in milliseconds. |
static int |
ERA
Field number for get and set indicating the
era, e.g., AD or BC in the Julian calendar. |
static int |
FEBRUARY
Value of the MONTH field indicating the
second month of the year in the Gregorian and Julian calendars. |
static int |
FIELD_COUNT
The number of distinct fields recognized by get and set . |
protected int[] |
fields
The calendar field values for the currently set time for this calendar. |
static int |
FRIDAY
Value of the DAY_OF_WEEK field indicating
Friday. |
static int |
HOUR
Field number for get and set indicating the
hour of the morning or afternoon. |
static int |
HOUR_OF_DAY
Field number for get and set indicating the
hour of the day. |
protected boolean[] |
isSet
The flags which tell if a specified calendar field for the calendar is set. |
protected boolean |
isTimeSet
True if then the value of time is valid. |
static int |
JANUARY
Value of the MONTH field indicating the
first month of the year in the Gregorian and Julian calendars. |
static int |
JULY
Value of the MONTH field indicating the
seventh month of the year in the Gregorian and Julian calendars. |
static int |
JUNE
Value of the MONTH field indicating the
sixth month of the year in the Gregorian and Julian calendars. |
static int |
LONG
A style specifier for getDisplayName and getDisplayNames indicating a long name, such as "January". |
static int |
MARCH
Value of the MONTH field indicating the
third month of the year in the Gregorian and Julian calendars. |
static int |
MAY
Value of the MONTH field indicating the
fifth month of the year in the Gregorian and Julian calendars. |
static int |
MILLISECOND
Field number for get and set indicating the
millisecond within the second. |
static int |
MINUTE
Field number for get and set indicating the
minute within the hour. |
static int |
MONDAY
Value of the DAY_OF_WEEK field indicating
Monday. |
static int |
MONTH
Field number for get and set indicating the
month. |
static int |
NOVEMBER
Value of the MONTH field indicating the
eleventh month of the year in the Gregorian and Julian calendars. |
static int |
OCTOBER
Value of the MONTH field indicating the
tenth month of the year in the Gregorian and Julian calendars. |
static int |
PM
Value of the AM_PM field indicating the
period of the day from noon to just before midnight. |
static int |
SATURDAY
Value of the DAY_OF_WEEK field indicating
Saturday. |
static int |
SECOND
Field number for get and set indicating the
second within the minute. |
static int |
SEPTEMBER
Value of the MONTH field indicating the
ninth month of the year in the Gregorian and Julian calendars. |
static int |
SHORT
A style specifier for getDisplayName and getDisplayNames indicating a short name, such as "Jan". |
static int |
SUNDAY
Value of the DAY_OF_WEEK field indicating
Sunday. |
static int |
THURSDAY
Value of the DAY_OF_WEEK field indicating
Thursday. |
protected long |
time
The currently set time for this calendar, expressed in milliseconds after January 1, 1970, 0:00:00 GMT. |
static int |
TUESDAY
Value of the DAY_OF_WEEK field indicating
Tuesday. |
static int |
UNDECIMBER
Value of the MONTH field indicating the
thirteenth month of the year. |
static int |
WEDNESDAY
Value of the DAY_OF_WEEK field indicating
Wednesday. |
static int |
WEEK_OF_MONTH
Field number for get and set indicating the
week number within the current month. |
static int |
WEEK_OF_YEAR
Field number for get and set indicating the
week number within the current year. |
static int |
YEAR
Field number for get and set indicating the
year. |
static int |
ZONE_OFFSET
Field number for get and set
indicating the raw offset from GMT in milliseconds. |
Constructor Summary | |
---|---|
protected |
Calendar()
Constructs a Calendar with the default time zone and locale. |
protected |
Calendar(TimeZone zone,
Locale aLocale)
Constructs a calendar with the specified time zone and locale. |
Method Summary | |
---|---|
abstract void |
add(int field,
int amount)
Adds or subtracts the specified amount of time to the given calendar field, based on the calendar's rules. |
boolean |
after(Object when)
Returns whether this Calendar represents a time
after the time represented by the specified
Object . |
boolean |
before(Object when)
Returns whether this Calendar represents a time
before the time represented by the specified
Object . |
void |
clear()
Sets all the calendar field values and the time value (millisecond offset from the Epoch) of this Calendar undefined. |
void |
clear(int field)
Sets the given calendar field value and the time value (millisecond offset from the Epoch) of this Calendar undefined. |
Object |
clone()
Creates and returns a copy of this object. |
int |
compareTo(Calendar anotherCalendar)
Compares the time values (millisecond offsets from the Epoch) represented by two Calendar objects. |
protected void |
complete()
Fills in any unset fields in the calendar fields. |
protected abstract void |
computeFields()
Converts the current millisecond time value time
to calendar field values in fields[] . |
protected abstract void |
computeTime()
Converts the current calendar field values in fields[]
to the millisecond time value
time . |
boolean |
equals(Object obj)
Compares this Calendar to the specified
Object . |
int |
get(int field)
Returns the value of the given calendar field. |
int |
getActualMaximum(int field)
Returns the maximum value that the specified calendar field could have, given the time value of this Calendar . |
int |
getActualMinimum(int field)
Returns the minimum value that the specified calendar field could have, given the time value of this Calendar . |
static Locale[] |
getAvailableLocales()
Returns an array of all locales for which the getInstance
methods of this class can return localized instances. |
String |
getDisplayName(int field,
int style,
Locale locale)
Returns the string representation of the calendar field value in the given style and
locale . |
Map<String,Integer> |
getDisplayNames(int field,
int style,
Locale locale)
Returns a Map containing all names of the calendar
field in the given style and
locale and their corresponding field values. |
int |
getFirstDayOfWeek()
Gets what the first day of the week is; e.g., SUNDAY in the U.S.,
MONDAY in France. |
abstract int |
getGreatestMinimum(int field)
Returns the highest minimum value for the given calendar field of this Calendar instance. |
static Calendar |
getInstance()
Gets a calendar using the default time zone and locale. |
static Calendar |
getInstance(Locale aLocale)
Gets a calendar using the default time zone and specified locale. |
static Calendar |
getInstance(TimeZone zone)
Gets a calendar using the specified time zone and default locale. |
static Calendar |
getInstance(TimeZone zone,
Locale aLocale)
Gets a calendar with the specified time zone and locale. |
abstract int |
getLeastMaximum(int field)
Returns the lowest maximum value for the given calendar field of this Calendar instance. |
abstract int |
getMaximum(int field)
Returns the maximum value for the given calendar field of this Calendar instance. |
int |
getMinimalDaysInFirstWeek()
Gets what the minimal days required in the first week of the year are; e.g., if the first week is defined as one that contains the first day of the first month of a year, this method returns 1. |
abstract int |
getMinimum(int field)
Returns the minimum value for the given calendar field of this Calendar instance. |
Date |
getTime()
Returns a Date object representing this
Calendar 's time value (millisecond offset from the Epoch"). |
long |
getTimeInMillis()
Returns this Calendar's time value in milliseconds. |
TimeZone |
getTimeZone()
Gets the time zone. |
int |
hashCode()
Returns a hash code for this calendar. |
protected int |
internalGet(int field)
Returns the value of the given calendar field. |
boolean |
isLenient()
Tells whether date/time interpretation is to be lenient. |
boolean |
isSet(int field)
Determines if the given calendar field has a value set, including cases that the value has been set by internal fields calculations triggered by a get method call. |
abstract void |
roll(int field,
boolean up)
Adds or subtracts (up/down) a single unit of time on the given time field without changing larger fields. |
void |
roll(int field,
int amount)
Adds the specified (signed) amount to the specified calendar field without changing larger fields. |
void |
set(int field,
int value)
Sets the given calendar field to the given value. |
void |
set(int year,
int month,
int date)
Sets the values for the calendar fields YEAR ,
MONTH , and DAY_OF_MONTH . |
void |
set(int year,
int month,
int date,
int hourOfDay,
int minute)
Sets the values for the calendar fields YEAR ,
MONTH , DAY_OF_MONTH ,
HOUR_OF_DAY , and MINUTE . |
void |
set(int year,
int month,
int date,
int hourOfDay,
int minute,
int second)
Sets the values for the fields YEAR , MONTH ,
DAY_OF_MONTH , HOUR , MINUTE , and
SECOND . |
void |
setFirstDayOfWeek(int value)
Sets what the first day of the week is; e.g., SUNDAY in the U.S.,
MONDAY in France. |
void |
setLenient(boolean lenient)
Specifies whether or not date/time interpretation is to be lenient. |
void |
setMinimalDaysInFirstWeek(int value)
Sets what the minimal days required in the first week of the year are; For example, if the first week is defined as one that contains the first day of the first month of a year, call this method with value 1. |
void |
setTime(Date date)
Sets this Calendar's time with the given Date . |
void |
setTimeInMillis(long millis)
Sets this Calendar's current time from the given long value. |
void |
setTimeZone(TimeZone value)
Sets the time zone with the given time zone value. |
String |
toString()
Return a string representation of this calendar. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int ERA
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
get
and set
indicating the
year. This is a calendar-specific value; see subclass documentation.
public static final int MONTH
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
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
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
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.
DAY_OF_MONTH
,
Constant Field Valuespublic static final int DAY_OF_MONTH
get
and set
indicating the
day of the month. This is a synonym for DATE
.
The first day of the month has value 1.
DATE
,
Constant Field Valuespublic static final int DAY_OF_YEAR
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
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
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
.
DAY_OF_WEEK
,
WEEK_OF_MONTH
,
Constant Field Valuespublic static final int AM_PM
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
.
AM
,
PM
,
HOUR
,
Constant Field Valuespublic static final int HOUR
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.
AM_PM
,
HOUR_OF_DAY
,
Constant Field Valuespublic static final int HOUR_OF_DAY
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.
HOUR
,
Constant Field Valuespublic static final int MINUTE
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
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
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
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 Calendar
if the
TimeZone
implementation subclass supports
historical GMT offset changes.
public static final int DST_OFFSET
get
and set
indicating the
daylight savings offset in milliseconds.
This field reflects the correct daylight saving offset value of
the time zone of this Calendar
if the
TimeZone
implementation subclass supports
historical Daylight Saving Time schedule changes.
public static final int FIELD_COUNT
get
and set
.
Field numbers range from 0..FIELD_COUNT-1
.
public static final int SUNDAY
DAY_OF_WEEK
field indicating
Sunday.
public static final int MONDAY
DAY_OF_WEEK
field indicating
Monday.
public static final int TUESDAY
DAY_OF_WEEK
field indicating
Tuesday.
public static final int WEDNESDAY
DAY_OF_WEEK
field indicating
Wednesday.
public static final int THURSDAY
DAY_OF_WEEK
field indicating
Thursday.
public static final int FRIDAY
DAY_OF_WEEK
field indicating
Friday.
public static final int SATURDAY
DAY_OF_WEEK
field indicating
Saturday.
public static final int JANUARY
MONTH
field indicating the
first month of the year in the Gregorian and Julian calendars.
public static final int FEBRUARY
MONTH
field indicating the
second month of the year in the Gregorian and Julian calendars.
public static final int MARCH
MONTH
field indicating the
third month of the year in the Gregorian and Julian calendars.
public static final int APRIL
MONTH
field indicating the
fourth month of the year in the Gregorian and Julian calendars.
public static final int MAY
MONTH
field indicating the
fifth month of the year in the Gregorian and Julian calendars.
public static final int JUNE
MONTH
field indicating the
sixth month of the year in the Gregorian and Julian calendars.
public static final int JULY
MONTH
field indicating the
seventh month of the year in the Gregorian and Julian calendars.
public static final int AUGUST
MONTH
field indicating the
eighth month of the year in the Gregorian and Julian calendars.
public static final int SEPTEMBER
MONTH
field indicating the
ninth month of the year in the Gregorian and Julian calendars.
public static final int OCTOBER
MONTH
field indicating the
tenth month of the year in the Gregorian and Julian calendars.
public static final int NOVEMBER
MONTH
field indicating the
eleventh month of the year in the Gregorian and Julian calendars.
public static final int DECEMBER
MONTH
field indicating the
twelfth month of the year in the Gregorian and Julian calendars.
public static final int UNDECIMBER
MONTH
field indicating the
thirteenth month of the year. Although GregorianCalendar
does not use this value, lunar calendars do.
public static final int AM
AM_PM
field indicating the
period of the day from midnight to just before noon.
public static final int PM
AM_PM
field indicating the
period of the day from noon to just before midnight.
public static final int ALL_STYLES
getDisplayNames
indicating names in all styles, such as
"January" and "Jan".
SHORT
,
LONG
,
Constant Field Valuespublic static final int SHORT
getDisplayName
and getDisplayNames
indicating a short name, such as "Jan".
LONG
,
Constant Field Valuespublic static final int LONG
getDisplayName
and getDisplayNames
indicating a long name, such as "January".
SHORT
,
Constant Field Valuesprotected int[] fields
FIELD_COUNT
integers, with index values
ERA
through DST_OFFSET
.
protected boolean[] isSet
FIELD_COUNT
booleans, with index values
ERA
through DST_OFFSET
.
protected long time
isTimeSet
protected boolean isTimeSet
time
is valid.
The time is made invalid by a change to an item of field[]
.
time
protected boolean areFieldsSet
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
.
Constructor Detail |
---|
protected Calendar()
TimeZone.getDefault()
protected Calendar(TimeZone zone, Locale aLocale)
zone
- the time zone to useaLocale
- the locale for the week dataMethod Detail |
---|
public static Calendar getInstance()
Calendar
returned is based on the current time
in the default time zone with the default locale.
public static Calendar getInstance(TimeZone zone)
Calendar
returned is based on the current time
in the given time zone with the default locale.
zone
- the time zone to use
public static Calendar getInstance(Locale aLocale)
Calendar
returned is based on the current time
in the default time zone with the given locale.
aLocale
- the locale for the week data
public static Calendar getInstance(TimeZone zone, Locale aLocale)
Calendar
returned is based on the current time
in the given time zone with the given locale.
zone
- the time zone to useaLocale
- the locale for the week data
public static Locale[] getAvailableLocales()
getInstance
methods of this class can return localized instances.
The array returned must contain at least a Locale
instance equal to Locale.US
.
Calendar
instances are available.protected abstract void computeTime()
fields[]
to the millisecond time value
time
.
complete()
,
computeFields()
protected abstract void computeFields()
time
to calendar field values in fields[]
.
This allows you to sync up the calendar field values with
a new time that is set for the calendar. The time is not
recomputed first; to recompute the time, then the fields, call the
complete()
method.
computeTime()
public final Date getTime()
Date
object representing this
Calendar
's time value (millisecond offset from the Epoch").
Date
representing the time value.setTime(Date)
,
getTimeInMillis()
public final void setTime(Date date)
Date
.
Note: Calling setTime()
with
Date(Long.MAX_VALUE)
or Date(Long.MIN_VALUE)
may yield incorrect field values from get()
.
date
- the given Date.getTime()
,
setTimeInMillis(long)
public long getTimeInMillis()
getTime()
,
setTimeInMillis(long)
public void setTimeInMillis(long millis)
millis
- the new time in UTC milliseconds from the epoch.setTime(Date)
,
getTimeInMillis()
public int get(int field)
complete()
method, which process is calendar
system dependent.
field
- the given calendar field.
ArrayIndexOutOfBoundsException
- if the specified field is out of range
(field < 0 || field >= FIELD_COUNT
).set(int,int)
,
complete()
protected final int internalGet(int field)
field
- the given calendar field.
get(int)
public void set(int field, int value)
field
- the given calendar field.value
- the value to be set for the given calendar field.
ArrayIndexOutOfBoundsException
- if the specified field is out of range
(field < 0 || field >= FIELD_COUNT
).
in non-lenient mode.set(int,int,int)
,
set(int,int,int,int,int)
,
set(int,int,int,int,int,int)
,
get(int)
public final void set(int year, int month, int date)
YEAR
,
MONTH
, and DAY_OF_MONTH
.
Previous values of other calendar fields are retained. If this is not desired,
call clear()
first.
year
- the value used to set the YEAR
calendar field.month
- the value used to set the MONTH
calendar field.
Month value is 0-based. e.g., 0 for January.date
- the value used to set the DAY_OF_MONTH
calendar field.set(int,int)
,
set(int,int,int,int,int)
,
set(int,int,int,int,int,int)
public final void set(int year, int month, int date, int hourOfDay, int minute)
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
- the value used to set the YEAR
calendar field.month
- the value used to set the MONTH
calendar field.
Month value is 0-based. e.g., 0 for January.date
- the value used to set the DAY_OF_MONTH
calendar field.hourOfDay
- the value used to set the HOUR_OF_DAY
calendar field.minute
- the value used to set the MINUTE
calendar field.set(int,int)
,
set(int,int,int)
,
set(int,int,int,int,int,int)
public final void set(int year, int month, int date, int hourOfDay, int minute, int second)
YEAR
, MONTH
,
DAY_OF_MONTH
, HOUR
, MINUTE
, and
SECOND
.
Previous values of other fields are retained. If this is not desired,
call clear()
first.
year
- the value used to set the YEAR
calendar field.month
- the value used to set the MONTH
calendar field.
Month value is 0-based. e.g., 0 for January.date
- the value used to set the DAY_OF_MONTH
calendar field.hourOfDay
- the value used to set the HOUR_OF_DAY
calendar field.minute
- the value used to set the MINUTE
calendar field.second
- the value used to set the SECOND
calendar field.set(int,int)
,
set(int,int,int)
,
set(int,int,int,int,int)
public final void clear()
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.
clear(int)
public final void clear(int field)
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
. Use set(Calendar.HOUR_OF_DAY, 0)
to reset the hour
value.
field
- the calendar field to be cleared.clear()
public final boolean isSet(int field)
get
method call.
true
if the given calendar field has a value set;
false
otherwise.public String getDisplayName(int field, int style, Locale locale)
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 Calendar
is a
GregorianCalendar
and its date is 2005-01-01, then
the string representation of the MONTH
field would be
"January" in the long style in an English locale or "Jan" in
the short style. However, no string representation would be
available for the DAY_OF_MONTH
field, and this method
would return null
.
The default implementation supports the calendar fields for
which a DateFormatSymbols
has names in the given
locale
.
field
- the calendar field for which the string representation
is returnedstyle
- the style applied to the string representation; one of
SHORT
or LONG
.locale
- the locale for the string representation
field
in the given style
, or
null
if no string representation is
applicable.
IllegalArgumentException
- if field
or style
is invalid,
or if this Calendar
is non-lenient and any
of the calendar fields have invalid values
NullPointerException
- if locale
is nullpublic Map<String,Integer> getDisplayNames(int field, int style, Locale locale)
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
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 Calendar
is a lunisolar calendar system and
the year value given by the YEAR
field has a leap
month, this method would return month names containing the leap
month name, and month names are mapped to their values specific
for the year.
The default implementation supports display names contained in
a DateFormatSymbols
. For example, if field
is MONTH
and style
is ALL_STYLES
, this method returns a Map
containing
all strings returned by DateFormatSymbols.getShortMonths()
and DateFormatSymbols.getMonths()
.
field
- the calendar field for which the display names are returnedstyle
- the style applied to the display names; one of SHORT
, LONG
, or ALL_STYLES
.locale
- the locale for the display names
Map
containing all display names in
style
and locale
and their
field values, or null
if no display names
are defined for field
IllegalArgumentException
- if field
or style
is invalid,
or if this Calendar
is non-lenient and any
of the calendar fields have invalid values
NullPointerException
- if locale
is nullprotected void complete()
computeTime()
method is called if the time value (millisecond offset
from the Epoch) has not been calculated from
calendar field values. Then, the computeFields()
method is
called to calculate all calendar field values.
public boolean equals(Object obj)
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 Calendar
parameters are the values represented
by the isLenient
, getFirstDayOfWeek
,
getMinimalDaysInFirstWeek
and getTimeZone
methods. If there is any difference in those parameters
between the two Calendar
s, this method returns
false
.
Use the compareTo
method to
compare only the time values.
obj
- the object to compare with.
true
if this object is equal to obj
;
false
otherwise.Object.hashCode()
,
Hashtable
public int hashCode()
Object.equals(java.lang.Object)
,
Hashtable
public boolean before(Object when)
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
.
when
- the Object
to be compared
true
if the time of this
Calendar
is before the time represented by
when
; false
otherwise.compareTo(Calendar)
public boolean after(Object when)
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
.
when
- the Object
to be compared
true
if the time of this Calendar
is
after the time represented by when
; false
otherwise.compareTo(Calendar)
public int compareTo(Calendar anotherCalendar)
Calendar
objects.
compareTo
in interface Comparable<Calendar>
anotherCalendar
- the Calendar
to be compared.
0
if the time represented by the argument
is equal to the time represented by this Calendar
; a value
less than 0
if the time of this Calendar
is
before the time represented by the argument; and a value greater than
0
if the time of this Calendar
is after the
time represented by the argument.
NullPointerException
- if the specified Calendar
is
null
.
IllegalArgumentException
- if the time value of the
specified Calendar
object can't be obtained due to
any invalid calendar values.public abstract void add(int field, int amount)
add(Calendar.DAY_OF_MONTH, -5)
.
field
- the calendar field.amount
- the amount of date or time to be added to the field.roll(int,int)
,
set(int,int)
public abstract void roll(int field, boolean up)
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
getMaximum(Calendar.YEAR)
.
When rolling on the month or Calendar.MONTH field, other fields like
date might conflict and, need to be changed. For instance,
rolling the month on the date 01/31/96 will result in 02/29/96.
When rolling on the hour-in-day or Calendar.HOUR_OF_DAY field, it will
roll the hour value in the range between 0 and 23, which is zero-based.
field
- the time field.up
- indicates if the value of the specified time field is to be
rolled up or rolled down. Use true if rolling up, false otherwise.add(int,int)
,
set(int,int)
public void roll(int field, int amount)
NOTE: This default implementation on Calendar
just repeatedly calls the
version of roll()
that rolls by one unit. This may not
always do the right thing. For example, if the DAY_OF_MONTH
field is 31,
rolling through February will leave it set to 28. The GregorianCalendar
version of this function takes care of this problem. Other subclasses
should also provide overrides of this function that do the right thing.
field
- the calendar field.amount
- the signed amount to add to the calendar field
.roll(int,boolean)
,
add(int,int)
,
set(int,int)
public void setTimeZone(TimeZone value)
value
- the given time zone.public TimeZone getTimeZone()
public void setLenient(boolean lenient)
lenient
- true
if the lenient mode is to be turned
on; false
if it is to be turned off.isLenient()
,
DateFormat.setLenient(boolean)
public boolean isLenient()
true
if the interpretation mode of this calendar is lenient;
false
otherwise.setLenient(boolean)
public void setFirstDayOfWeek(int value)
SUNDAY
in the U.S.,
MONDAY
in France.
value
- the given first day of the week.getFirstDayOfWeek()
,
getMinimalDaysInFirstWeek()
public int getFirstDayOfWeek()
SUNDAY
in the U.S.,
MONDAY
in France.
setFirstDayOfWeek(int)
,
getMinimalDaysInFirstWeek()
public void setMinimalDaysInFirstWeek(int value)
value
- the given minimal days required in the first week
of the year.getMinimalDaysInFirstWeek()
public int getMinimalDaysInFirstWeek()
setMinimalDaysInFirstWeek(int)
public abstract int getMinimum(int field)
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.
field
- the calendar field.
getMaximum(int)
,
getGreatestMinimum(int)
,
getLeastMaximum(int)
,
getActualMinimum(int)
,
getActualMaximum(int)
public abstract int getMaximum(int field)
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.
field
- the calendar field.
getMinimum(int)
,
getGreatestMinimum(int)
,
getLeastMaximum(int)
,
getActualMinimum(int)
,
getActualMaximum(int)
public abstract int getGreatestMinimum(int field)
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.
field
- the calendar field.
getMinimum(int)
,
getMaximum(int)
,
getLeastMaximum(int)
,
getActualMinimum(int)
,
getActualMaximum(int)
public abstract int getLeastMaximum(int field)
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.
field
- the calendar field.
getMinimum(int)
,
getMaximum(int)
,
getGreatestMinimum(int)
,
getActualMinimum(int)
,
getActualMaximum(int)
public int getActualMinimum(int field)
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 getMinimum()
.
field
- the calendar field
Calendar
getMinimum(int)
,
getMaximum(int)
,
getGreatestMinimum(int)
,
getLeastMaximum(int)
,
getActualMaximum(int)
public int getActualMaximum(int field)
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.
field
- the calendar field
Calendar
getMinimum(int)
,
getMaximum(int)
,
getGreatestMinimum(int)
,
getLeastMaximum(int)
,
getActualMinimum(int)
public Object clone()
Cloneable
public String toString()
null
.