Language

Calendar.Builder Class

Definition

Calendar.Builder is used for creating a Calendar from various date-time parameters.

[Android.Runtime.Register("java/util/Calendar$Builder", ApiSince=26, DoNotGenerateAcw=true)]
public class Calendar.Builder : Java.Lang.Object
[<Android.Runtime.Register("java/util/Calendar$Builder", ApiSince=26, DoNotGenerateAcw=true)>]
type Calendar.Builder = class
    inherit Object
Inheritance
Calendar.Builder
Attributes

Remarks

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 Calendar#YEAR 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 Calendar#YEAR 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 #setLocale(Locale) locale, #setTimeZone(TimeZone) time zone, #setWeekDefinition(int, int) week definition, and #setLenient(boolean) leniency mode parameters can be set.

<b>Examples</b>

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 Calendar#ERA ERA is <em>Heisei</em> that started on that day.

Calendar cal = new Calendar.Builder().setCalendarType("japanese")
                                   .setFields(YEAR, 1, DAY_OF_YEAR, 1).build();

Added in 1.8.

Java documentation for java.util.Calendar.Builder.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Name Description
Calendar.Builder()

Constructs a Calendar.Builder.

Calendar.Builder(IntPtr, JniHandleOwnership)

Creates a managed instance that represents an existing Java object.

Properties

Name Description
Class

Returns the runtime class of this Object.

(Inherited from Object)
Handle

The handle to the underlying Android instance.

(Inherited from Object)
JniIdentityHashCode

Gets the identity hash code assigned to this Java peer by the interop runtime.

(Inherited from Object)
JniManagedPeerState

Gets the state flags last assigned by the runtime.

(Inherited from JavaObject)
JniPeerMembers

Gets the JNI metadata used to access members of this Java binding.

PeerReference

Gets the JNI object reference for this Java peer.

(Inherited from Object)
ThresholdClass

Gets the Java class used for virtual method dispatch.

ThresholdType

Gets the managed type that declares this Java binding.

Methods

Name Description
Build()

Returns a Calendar built from the parameters set by the setter methods.

Clone()

Creates and returns a copy of this object.

(Inherited from Object)
Construct(JniObjectReference, JniObjectReferenceOptions)

Delegates construction of this peer to the runtime's value manager.

(Inherited from JavaObject)
Dispose()

Releases the resources held by this Java peer.

(Inherited from Object)
Dispose(Boolean)

Releases the resources held by this Java peer.

(Inherited from Object)
DisposeUnlessReferenced()

Asks the value manager to dispose this peer unless its mapping retains this same managed instance.

(Inherited from JavaObject)
Equals(Object)

Tests whether another managed peer refers to the same Java object.

(Inherited from JavaObject)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
JavaFinalize()
Obsolete.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
Set(CalendarField, Int32)

Sets the field parameter to the given value.

SetCalendarType(String)

Sets the calendar type parameter to the given type.

SetDate(Int32, Int32, Int32)

Sets the date field parameters to the values given by year, month, and dayOfMonth.

SetFields(Int32[])

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

SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
SetInstant(Date)

Sets the instant parameter to the instant value given by a Date.

SetInstant(Int64)

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

SetLenient(Boolean)

Sets the lenient mode parameter to the value given by lenient.

SetLocale(Locale)

Sets the locale parameter to the given locale.

SetPeerReference(JniObjectReference, JniObjectReferenceOptions)

Stores a reference value in the control block without creating a JNI reference copy.

(Inherited from JavaObject)
SetTimeOfDay(Int32, Int32, Int32, Int32)

Sets the time of day field parameters to the values given by hourOfDay, minute, second, and millis.

SetTimeOfDay(Int32, Int32, Int32)

Sets the time of day field parameters to the values given by hourOfDay, minute, and second.

SetTimeZone(TimeZone)

Sets the time zone parameter to the given zone.

SetWeekDate(Int32, Int32, Int32)

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

SetWeekDefinition(Int32, Int32)

Sets the week definition parameters to the values given by firstDayOfWeek and minimalDaysInFirstWeek that are used to determine the first week of a year.

ToArray<T>()

Creates a managed array from this Java array wrapper.

(Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime()

Unregisters this Java peer from the interop runtime.

(Inherited from Object)
Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)

Explicit Interface Implementations

Name Description
IJavaPeerable.Disposed()

Marks this peer as disposed and calls Dispose with disposing set to true.

(Inherited from JavaObject)
IJavaPeerable.Finalized()

Marks this peer as disposed and calls Dispose with disposing set to false.

(Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock

Gets the native control-block pointer used by this peer.

(Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)

Stores the identity hash code supplied by the runtime.

(Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)

Replaces the stored managed peer state flags.

(Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)

Updates the peer reference and releases a disposed peer's control block when the reference is invalid.

(Inherited from JavaObject)

Extension Methods

Name Description
GetJniTypeName(IJavaPeerable)

Gets the JNI name of the type of the instance self.

JavaAs<TResult>(IJavaPeerable)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)

Reuses a compatible managed peer or obtains a wrapper of the requested type.

TryJavaCast<TResult>(IJavaPeerable, TResult)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

Applies to