Clock Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A clock providing access to the current instant, date and time using a time-zone.
[Android.Runtime.Register("java/time/Clock", ApiSince=26, DoNotGenerateAcw=true)]
public abstract class Clock : Java.Lang.Object, IDisposable, Java.Time.IInstantSource[<Android.Runtime.Register("java/time/Clock", ApiSince=26, DoNotGenerateAcw=true)>]
type Clock = class
inherit Object
interface IInstantSource
interface IJavaObject
interface IDisposable
interface IJavaPeerable- Inheritance
- Attributes
- Implements
Remarks
A clock providing access to the current instant, date and time using a time-zone.
Instances of this abstract class are used to access a pluggable representation of the current instant, which can be interpreted using the stored time-zone to find the current date and time. For example, Clock can be used instead of System#currentTimeMillis() and TimeZone#getDefault().
Use of a Clock is optional. All key date-time classes also have a now() factory method that uses the system clock in the default time zone. The primary purpose of this abstraction is to allow alternate clocks to be plugged in as and when required. Applications use an object to obtain the current time rather than a static method. This can simplify testing.
As such, this abstract class does not guarantee the result actually represents the current instant on the time-line. Instead, it allows the application to provide a controlled view as to what the current instant and time-zone are.
Best practice for applications is to pass a Clock into any method that requires the current instant and time-zone. A dependency injection framework is one way to achieve this:
public class MyBean {
private Clock clock; // dependency inject
...
public void process(LocalDate eventDate) {
if (eventDate.isBefore(LocalDate.now(clock)) {
...
}
}
}
This approach allows an alternative clock, such as #fixed(Instant, ZoneId) fixed or #offset(Clock, Duration) offset to be used during testing.
The system factory methods provide clocks based on the best available system clock. This may use System#currentTimeMillis(), or a higher resolution clock if one is available.
Added in 1.8.
Java documentation for java.time.Clock.
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 |
|---|---|
| Clock() |
Constructor accessible by subclasses. |
| Clock(IntPtr, JniHandleOwnership) | |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| 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 | (Inherited from JavaObject) |
| JniPeerMembers | |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| ThresholdClass | |
| ThresholdType | |
| Zone |
Gets the time-zone being used to create dates and times. |
Methods
| Name | Description |
|---|---|
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Construct(JniObjectReference, JniObjectReferenceOptions) | (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() | (Inherited from JavaObject) |
| Equals(Object) | (Inherited from JavaObject) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| Fixed(Instant, ZoneId) |
Obtains a clock that always returns the same instant. |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| Instant() |
Gets the current instant of the clock. |
| JavaFinalize() |
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Millis() |
Gets the current millisecond instant of the clock. |
| 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) |
| Offset(Clock, Duration) |
Obtains a clock that returns instants from the specified clock with the specified duration added. |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| System(ZoneId) |
Obtains a clock that returns the current instant using the best available system clock. |
| SystemDefaultZone() |
Obtains a clock that returns the current instant using the best available system clock, converting to date and time using the default time-zone. |
| SystemUTC() | |
| Tick(Clock, Duration) |
Obtains a clock that returns instants from the specified clock truncated to the nearest occurrence of the specified duration. |
| TickMillis(ZoneId) |
Obtains a clock that returns the current instant ticking in whole milliseconds using the best available system clock. |
| TickMinutes(ZoneId) |
Obtains a clock that returns the current instant ticking in whole minutes using the best available system clock. |
| TickSeconds(ZoneId) |
Obtains a clock that returns the current instant ticking in whole seconds using the best available system clock. |
| 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) |
| WithZone(ZoneId) |
Returns a copy of this clock with a different time-zone. |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() | (Inherited from JavaObject) |
| IJavaPeerable.Finalized() | (Inherited from JavaObject) |
| IJavaPeerable.JniObjectReferenceControlBlock | (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from JavaObject) |
| IJavaPeerable.UnregisterFromRuntime() | |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |