Builder

Builder

Builder()

Constructs a Calendar.Builder.

build

open fun build(): Calendar

Returns a 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.

Since Android 13, if the locale contains the time zone with "tz" Unicode extension, and time zone hasn't been given explicitly, time zone in the locale is used.

Any out of range field values are either normalized in lenient mode or detected as an invalid value in non-lenient mode.

set

open fun set(
    field: Int, 
    value: Int
): Calendar.Builder

Sets the 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.

setCalendarType

open fun setCalendarType(type: String): Calendar.Builder

Sets the calendar type parameter to the given 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.

setDate

open fun setDate(
    year: Int, 
    month: Int, 
    dayOfMonth: Int
): Calendar.Builder

Sets the date field parameters to the values given by year, month, and dayOfMonth. This method is equivalent to a call to:

setFields(Calendar.YEAR, year,
              Calendar.MONTH, month,
              Calendar.DAY_OF_MONTH, dayOfMonth);

setFields

open fun setFields(vararg fieldValuePairs: Int): Calendar.Builder

Sets field parameters to their values given by fieldValuePairs that are pairs of a field and its value. For example,

setFields(Calendar.YEAR, 2013,
              Calendar.MONTH, Calendar.DECEMBER,
              Calendar.DAY_OF_MONTH, 23);

set(Calendar.YEAR, 2013)
    .set(Calendar.MONTH, Calendar.DECEMBER)
    .set(Calendar.DAY_OF_MONTH, 23);

setInstant

open fun setInstant(instant: Long): Calendar.Builder

Sets the instant parameter to the given instant value that is a millisecond offset from the Epoch.

setInstant

open fun setInstant(instant: Date): Calendar.Builder

Sets the instant parameter to the instant value given by a Date. This method is equivalent to a call to setInstant(instant.getTime()).

setLenient

open fun setLenient(lenient: Boolean): Calendar.Builder

Sets the lenient mode parameter to the value given by lenient. If no lenient parameter is given to this Calendar.Builder, lenient mode will be used in the build method.

setLocale

open fun setLocale(locale: Locale): Calendar.Builder

Sets the locale parameter to the given locale. If no locale is given to this Calendar.Builder, the java.util.Locale#getDefault(java.util.Locale.Category)} 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.

setTimeOfDay

open fun setTimeOfDay(
    hourOfDay: Int, 
    minute: Int, 
    second: Int
): Calendar.Builder

Sets the time of day field parameters to the values given by hourOfDay, minute, and second. This method is equivalent to a call to:

setTimeOfDay(hourOfDay, minute, second, 0);

setTimeOfDay

open fun setTimeOfDay(
    hourOfDay: Int, 
    minute: Int, 
    second: Int, 
    millis: Int
): Calendar.Builder

Sets the time of day field parameters to the values given by 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);

setTimeZone

open fun setTimeZone(zone: TimeZone): Calendar.Builder

Sets the time zone parameter to the given zone. If no time zone parameter is given to this Calendar.Builder, the java.util.TimeZone#getDefault()} will be used in the build method.

setWeekDate

open fun setWeekDate(
    weekYear: Int, 
    weekOfYear: Int, 
    dayOfWeek: Int
): Calendar.Builder

Sets the week-based date parameters to the values with the given date specifiers - week year, week of year, and day of week.

If the specified calendar doesn't support week dates, the build method will throw an IllegalArgumentException.

setWeekDefinition

open fun setWeekDefinition(
    firstDayOfWeek: Int, 
    minimalDaysInFirstWeek: Int
): Calendar.Builder

Sets the week definition parameters to the values given by 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.