public static class Calendar.Builder extends Object
Calendar.Builder is used for creating a Calendar from
various date-time parameters.
There are two ways to set a Calendar to a date-time value. One
is to set the instant parameter to a millisecond offset from the Epoch. The other is to set individual
field parameters, such as YEAR, to their desired
values. These two ways can't be mixed. Trying to set both the instant and
individual fields will cause an IllegalStateException to be
thrown. However, it is permitted to override previous values of the
instant or field parameters.
If no enough field parameters are given for determining date and/or
time, calendar specific default values are used when building a
Calendar. For example, if the YEAR value
isn't given for the Gregorian calendar, 1970 will be used. If there are
any conflicts among field parameters, the resolution rules are applied.
Therefore, the order of field setting matters.
In addition to the date-time parameters, the locale, time zone, week definition, and leniency mode parameters can be set.
Examples
The following are sample usages. Sample code assumes that the
Calendar constants are statically imported.
The following code produces a Calendar with date 2012-12-31
(Gregorian) because Monday is the first day of a week with the ISO 8601
compatible week parameters.
Calendar cal = new Calendar.Builder().setCalendarType("iso8601")
.setWeekDate(2013, 1, MONDAY).build();
The following code produces a Japanese Calendar with date
1989-01-08 (Gregorian), assuming that the default ERA
is Heisei that started on that day.
Calendar cal = new Calendar.Builder().setCalendarType("japanese")
.setFields(YEAR, 1, DAY_OF_YEAR, 1).build();Calendar.getInstance(TimeZone, Locale),
Calendar.fields| Constructor and Description |
|---|
Builder()
Constructs a
Calendar.Builder. |
| Modifier and Type | Method and Description |
|---|---|
Calendar |
build()
Returns a
Calendar built from the parameters set by the
setter methods. |
Calendar.Builder |
set(int field,
int value)
Sets the
field parameter to the given value. |
Calendar.Builder |
setCalendarType(String type)
Sets the calendar type parameter to the given
type. |
Calendar.Builder |
setDate(int year,
int month,
int dayOfMonth)
Sets the date field parameters to the values given by
year,
month, and dayOfMonth. |
Calendar.Builder |
setFields(int... fieldValuePairs)
Sets field parameters to their values given by
fieldValuePairs that are pairs of a field and its value. |
Calendar.Builder |
setInstant(Date instant)
Sets the instant parameter to the
instant value given by a
Date. |
Calendar.Builder |
setInstant(long instant)
Sets the instant parameter to the given
instant value that is
a millisecond offset from the
Epoch. |
Calendar.Builder |
setLenient(boolean lenient)
Sets the lenient mode parameter to the value given by
lenient. |
Calendar.Builder |
setLocale(Locale locale)
Sets the locale parameter to the given
locale. |
Calendar.Builder |
setTimeOfDay(int hourOfDay,
int minute,
int second)
Sets the time of day field parameters to the values given by
hourOfDay, minute, and second. |
Calendar.Builder |
setTimeOfDay(int hourOfDay,
int minute,
int second,
int millis)
Sets the time of day field parameters to the values given by
hourOfDay, minute, second, and
millis. |
Calendar.Builder |
setTimeZone(TimeZone zone)
Sets the time zone parameter to the given
zone. |
Calendar.Builder |
setWeekDate(int weekYear,
int weekOfYear,
int dayOfWeek)
Sets the week-based date parameters to the values with the given
date specifiers - week year, week of year, and day of week.
|
Calendar.Builder |
setWeekDefinition(int firstDayOfWeek,
int minimalDaysInFirstWeek)
Sets the week definition parameters to the values given by
firstDayOfWeek and minimalDaysInFirstWeek that are
used to determine the first
week of a year. |
public Calendar.Builder setInstant(long instant)
instant value that is
a millisecond offset from the
Epoch.instant - a millisecond offset from the EpochCalendar.BuilderIllegalStateException - if any of the field parameters have
already been setCalendar.setTime(Date),
Calendar.setTimeInMillis(long),
Calendar.timepublic Calendar.Builder setInstant(Date instant)
instant value given by a
Date. This method is equivalent to a call to
setInstant(instant.getTime()).instant - a Date representing a millisecond offset from
the EpochCalendar.BuilderNullPointerException - if instant is nullIllegalStateException - if any of the field parameters have
already been setCalendar.setTime(Date),
Calendar.setTimeInMillis(long),
Calendar.timepublic Calendar.Builder set(int field, int value)
field parameter to the given value.
field is an index to the Calendar.fields, such as
DAY_OF_MONTH. Field value validation is
not performed in this method. Any out of range values are either
normalized in lenient mode or detected as an invalid value in
non-lenient mode when building a Calendar.field - an index to the Calendar fieldsvalue - the field valueCalendar.BuilderIllegalArgumentException - if field is invalidIllegalStateException - if the instant value has already been set,
or if fields have been set too many
(approximately Integer.MAX_VALUE) times.Calendar.set(int, int)public Calendar.Builder setFields(int... fieldValuePairs)
fieldValuePairs that are pairs of a field and its value.
For example,
setFeilds(Calendar.YEAR, 2013,
Calendar.MONTH, Calendar.DECEMBER,
Calendar.DAY_OF_MONTH, 23);
is equivalent to the sequence of the following
set calls:
set(Calendar.YEAR, 2013) .set(Calendar.MONTH, Calendar.DECEMBER) .set(Calendar.DAY_OF_MONTH, 23);
fieldValuePairs - field-value pairsCalendar.BuilderNullPointerException - if fieldValuePairs is nullIllegalArgumentException - if any of fields are invalid,
or if fieldValuePairs.length is an odd number.IllegalStateException - if the instant value has been set,
or if fields have been set too many (approximately
Integer.MAX_VALUE) times.public Calendar.Builder setDate(int year, int month, int dayOfMonth)
year,
month, and dayOfMonth. This method is equivalent to
a call to:
setFields(Calendar.YEAR, year,
Calendar.MONTH, month,
Calendar.DAY_OF_MONTH, dayOfMonth);year - the YEAR valuemonth - the MONTH value
(the month numbering is 0-based).dayOfMonth - the DAY_OF_MONTH valueCalendar.Builderpublic Calendar.Builder setTimeOfDay(int hourOfDay, int minute, int second)
hourOfDay, minute, and second. This method is
equivalent to a call to:
setTimeOfDay(hourOfDay, minute, second, 0);
hourOfDay - the HOUR_OF_DAY value
(24-hour clock)minute - the MINUTE valuesecond - the SECOND valueCalendar.Builderpublic Calendar.Builder setTimeOfDay(int hourOfDay, int minute, int second, int millis)
hourOfDay, minute, second, and
millis. This method is equivalent to a call to:
setFields(Calendar.HOUR_OF_DAY, hourOfDay,
Calendar.MINUTE, minute,
Calendar.SECOND, second,
Calendar.MILLISECOND, millis);hourOfDay - the HOUR_OF_DAY value
(24-hour clock)minute - the MINUTE valuesecond - the SECOND valuemillis - the MILLISECOND valueCalendar.Builderpublic Calendar.Builder setWeekDate(int weekYear, int weekOfYear, int dayOfWeek)
If the specified calendar doesn't support week dates, the
build method will throw an IllegalArgumentException.
weekYear - the week yearweekOfYear - the week number based on weekYeardayOfWeek - the day of week value: one of the constants
for the DAY_OF_WEEK field:
SUNDAY, ..., SATURDAY.Calendar.BuilderCalendar.setWeekDate(int, int, int),
Calendar.isWeekDateSupported()public Calendar.Builder setTimeZone(TimeZone zone)
zone. If no time
zone parameter is given to this Caledar.Builder, the
default
TimeZone will be used in the build
method.zone - the TimeZoneCalendar.BuilderNullPointerException - if zone is nullCalendar.setTimeZone(TimeZone)public Calendar.Builder setLenient(boolean lenient)
lenient.
If no lenient parameter is given to this Calendar.Builder,
lenient mode will be used in the build method.lenient - true for lenient mode;
false for non-lenient modeCalendar.BuilderCalendar.setLenient(boolean)public Calendar.Builder setCalendarType(String type)
type. The
calendar type given by this method has precedence over any explicit
or implicit calendar type given by the
locale.
In addition to the available calendar types returned by the
Calendar.getAvailableCalendarTypes
method, "gregorian" and "iso8601" as aliases of
"gregory" can be used with this method.
type - the calendar typeCalendar.BuilderNullPointerException - if type is nullIllegalArgumentException - if type is unknownIllegalStateException - if another calendar type has already been setCalendar.getCalendarType(),
Calendar.getAvailableCalendarTypes()public Calendar.Builder setLocale(Locale locale)
locale. If no locale
is given to this Calendar.Builder, the default Locale
for Locale.Category.FORMAT will be used.
If no calendar type is explicitly given by a call to the
setCalendarType method,
the Locale value is used to determine what type of
Calendar to be built.
If no week definition parameters are explicitly given by a call to
the setWeekDefinition method, the
Locale's default values are used.
locale - the LocaleCalendar.BuilderNullPointerException - if locale is nullCalendar.getInstance(Locale)public Calendar.Builder setWeekDefinition(int firstDayOfWeek, int minimalDaysInFirstWeek)
firstDayOfWeek and minimalDaysInFirstWeek that are
used to determine the first
week of a year. The parameters given by this method have
precedence over the default values given by the
locale.firstDayOfWeek - the first day of a week; one of
Calendar.SUNDAY to Calendar.SATURDAYminimalDaysInFirstWeek - the minimal number of days in the first
week (1..7)Calendar.BuilderIllegalArgumentException - if firstDayOfWeek or
minimalDaysInFirstWeek is invalidCalendar.getFirstDayOfWeek(),
Calendar.getMinimalDaysInFirstWeek()public Calendar build()
Calendar built from the parameters set by the
setter methods. The calendar type given by the setCalendarType method or the locale is
used to determine what Calendar to be created. If no explicit
calendar type is given, the locale's default calendar is created.
If the calendar type is "iso8601", the
Gregorian change date
of a GregorianCalendar is set to Date(Long.MIN_VALUE)
to be the proleptic Gregorian calendar. Its week definition
parameters are also set to be compatible
with the ISO 8601 standard. Note that the
getCalendarType method of
a GregorianCalendar created with "iso8601" returns
"gregory".
The default values are used for locale and time zone if these parameters haven't been given explicitly.
Any out of range field values are either normalized in lenient mode or detected as an invalid value in non-lenient mode.
Calendar built with parameters of this Calendar.BuilderIllegalArgumentException - if the calendar type is unknown, or
if any invalid field values are given in non-lenient mode, or
if a week date is given for the calendar type that doesn't
support week dates.Calendar.getInstance(TimeZone, Locale),
Locale.getDefault(Locale.Category),
TimeZone.getDefault() Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved.