DateTimeFormatter.ParsedExcessDays Method

  • Reference

Definition

Namespace:
Java.Time.Format
Assembly:
Mono.Android.dll

A query that provides access to the excess days that were parsed.

[Android.Runtime.Register("parsedExcessDays", "()Ljava/time/temporal/TemporalQuery;", "", ApiSince=26)]
public static Java.Time.Temporal.ITemporalQuery? ParsedExcessDays ();
[<Android.Runtime.Register("parsedExcessDays", "()Ljava/time/temporal/TemporalQuery;", "", ApiSince=26)>]
static member ParsedExcessDays : unit -> Java.Time.Temporal.ITemporalQuery

Returns

ITemporalQuery

a query that provides access to the excess days that were parsed

Attributes
RegisterAttribute

Remarks

A query that provides access to the excess days that were parsed.

This returns a singleton TemporalQuery query that provides access to additional information from the parse. The query always returns a non-null period, with a zero period returned instead of null.

There are two situations where this query may return a non-zero period. <ul> <li>If the ResolverStyle is LENIENT and a time is parsed without a date, then the complete result of the parse consists of a LocalTime and an excess Period in days.

<li>If the ResolverStyle is SMART and a time is parsed without a date where the time is 24:00:00, then the complete result of the parse consists of a LocalTime of 00:00:00 and an excess Period of one day. </ul>

In both cases, if a complete ChronoLocalDateTime or Instant is parsed, then the excess days are added to the date part. As a result, this query will return a zero period.

The SMART behaviour handles the common "end of day" 24:00 value. Processing in LENIENT mode also produces the same result:

Text to parse        Parsed object                         Excess days
             "2012-12-03T00:00"   LocalDateTime.of(2012, 12, 3, 0, 0)   ZERO
             "2012-12-03T24:00"   LocalDateTime.of(2012, 12, 4, 0, 0)   ZERO
             "00:00"              LocalTime.of(0, 0)                    ZERO
             "24:00"              LocalTime.of(0, 0)                    Period.ofDays(1)

The query can be used as follows:

TemporalAccessor parsed = formatter.parse(str);
             LocalTime time = parsed.query(LocalTime::from);
             Period extraDays = parsed.query(DateTimeFormatter.parsedExcessDays());

Java documentation for java.time.format.DateTimeFormatter.parsedExcessDays().

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.

Applies to