RelativeDateTimeFormatter Class

Definition

Namespace:: Android.Icu.Text

Assembly:: Mono.Android.dll

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.

Formats simple relative dates.

[Android.Runtime.Register("android/icu/text/RelativeDateTimeFormatter", ApiSince=24, DoNotGenerateAcw=true)]
public sealed class RelativeDateTimeFormatter : Java.Lang.Object

[<Android.Runtime.Register("android/icu/text/RelativeDateTimeFormatter", ApiSince=24, DoNotGenerateAcw=true)>]
type RelativeDateTimeFormatter = class
    inherit Object

Inheritance: Object

JavaObject

Object
RelativeDateTimeFormatter

Attributes: RegisterAttribute

Remarks

Formats simple relative dates. There are two types of relative dates that it handles: <ul> <li>relative dates with a quantity e.g "in 5 days"</li> <li>relative dates without a quantity e.g "next Tuesday"</li> </ul>

This API is very basic and is intended to be a building block for more fancy APIs. The caller tells it exactly what to display in a locale independent way. While this class automatically provides the correct plural forms, the grammatical form is otherwise as neutral as possible. It is the caller's responsibility to handle cut-off logic such as deciding between displaying "in 7 days" or "in 1 week." This API supports relative dates involving one single unit. This API does not support relative dates involving compound units. e.g "in 5 days and 4 hours" nor does it support parsing. This class is both immutable and thread-safe.

Here are some examples of use: <blockquote>

RelativeDateTimeFormatter fmt = RelativeDateTimeFormatter.getInstance();
            fmt.format(1, Direction.NEXT, RelativeUnit.DAYS); // "in 1 day"
            fmt.format(3, Direction.NEXT, RelativeUnit.DAYS); // "in 3 days"
            fmt.format(3.2, Direction.LAST, RelativeUnit.YEARS); // "3.2 years ago"

            fmt.format(Direction.LAST, AbsoluteUnit.SUNDAY); // "last Sunday"
            fmt.format(Direction.THIS, AbsoluteUnit.SUNDAY); // "this Sunday"
            fmt.format(Direction.NEXT, AbsoluteUnit.SUNDAY); // "next Sunday"
            fmt.format(Direction.PLAIN, AbsoluteUnit.SUNDAY); // "Sunday"

            fmt.format(Direction.LAST, AbsoluteUnit.DAY); // "yesterday"
            fmt.format(Direction.THIS, AbsoluteUnit.DAY); // "today"
            fmt.format(Direction.NEXT, AbsoluteUnit.DAY); // "tomorrow"

            fmt.format(Direction.PLAIN, AbsoluteUnit.NOW); // "now"

</blockquote>

The Style parameter allows selection of different length styles: LONG ("3 seconds ago"), SHORT ("3 sec. ago"), NARROW ("3s ago"). In the future, we may add more forms, such as relative day periods ("yesterday afternoon"), etc.

Java documentation for android.icu.text.RelativeDateTimeFormatter.

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.

Properties

Name	Description
CapitalizationContext	Return capitalization context.
Class	Returns the runtime class of this `Object`. (Inherited from Object)
FormatStyle	Return style
Handle	The handle to the underlying Android instance. (Inherited from Object)
Instance	Returns a RelativeDateTimeFormatter for the default locale.
JniIdentityHashCode	Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object)
JniManagedPeerState	(Inherited from JavaObject)
JniPeerMembers
NumberFormat	Returns a copy of the NumberFormat this object is using.
PeerReference	Gets the JNI object reference for this Java peer. (Inherited from Object)
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)

Methods

Name	Description
Clone()	Creates and returns a copy of this object. (Inherited from Object)
CombineDateAndTime(String, String)	Combines a relative date string and a time string in this object's locale.
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)
Format(Double, RelativeDateTimeFormatter+Direction, RelativeDateTimeFormatter+RelativeUnit)	Formats a relative date with a quantity such as "in 5 days" or "3 months ago".
Format(Double, RelativeDateTimeFormatter+RelativeDateTimeUnit)	Format a combination of RelativeDateTimeUnit and numeric offset using a text style if possible, e.g. "last week", "this week", "next week", "yesterday", "tomorrow".
Format(RelativeDateTimeFormatter+Direction, RelativeDateTimeFormatter+AbsoluteUnit)	Formats a relative date without a quantity.
FormatNumeric(Double, RelativeDateTimeFormatter+RelativeDateTimeUnit)	Format a combination of RelativeDateTimeUnit and numeric offset using a numeric style, e.g. "1 week ago", "in 1 week", "5 weeks ago", "in 5 weeks".
FormatNumericToValue(Double, RelativeDateTimeFormatter+RelativeDateTimeUnit)	Format a combination of RelativeDateTimeUnit and numeric offset using a numeric style, e.g. "1 week ago", "in 1 week", "5 weeks ago", "in 5 weeks".
FormatToValue(Double, RelativeDateTimeFormatter+Direction, RelativeDateTimeFormatter+RelativeUnit)	Formats a relative date with a quantity such as "in 5 days" or "3 months ago".
FormatToValue(Double, RelativeDateTimeFormatter+RelativeDateTimeUnit)	Format a combination of RelativeDateTimeUnit and numeric offset using a text style if possible, e.g. "last week", "this week", "next week", "yesterday", "tomorrow".
FormatToValue(RelativeDateTimeFormatter+Direction, RelativeDateTimeFormatter+AbsoluteUnit)	Formats a relative date without a quantity.
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
GetInstance(Locale, NumberFormat)	Returns a RelativeDateTimeFormatter for a particular `java.util.Locale` that uses a particular NumberFormat object.
GetInstance(Locale)	Returns a RelativeDateTimeFormatter for a particular `java.util.Locale`.
GetInstance(ULocale, NumberFormat, RelativeDateTimeFormatter+Style, DisplayContext)	Returns a RelativeDateTimeFormatter for a particular locale that uses a particular NumberFormat object, style, and capitalization context
GetInstance(ULocale, NumberFormat)	Returns a RelativeDateTimeFormatter for a particular locale that uses a particular NumberFormat object.
GetInstance(ULocale)	Returns a RelativeDateTimeFormatter for a particular locale.
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)
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)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)	(Inherited from JavaObject)
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()	(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)

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)
TryJavaCast<TResult>(IJavaPeerable, TResult)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.

Applies to