1 /*
2 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 /*
27 * This file is available under and governed by the GNU General Public
28 * License version 2 only, as published by the Free Software Foundation.
29 * However, the following notice accompanied the original version of this
30 * file:
31 *
32 * Copyright (c) 2008-2012, Stephen Colebourne & Michael Nascimento Santos
33 *
34 * All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions are met:
38 *
39 * * Redistributions of source code must retain the above copyright notice,
40 * this list of conditions and the following disclaimer.
41 *
42 * * Redistributions in binary form must reproduce the above copyright notice,
43 * this list of conditions and the following disclaimer in the documentation
44 * and/or other materials provided with the distribution.
45 *
46 * * Neither the name of JSR-310 nor the names of its contributors
47 * may be used to endorse or promote products derived from this software
48 * without specific prior written permission.
49 *
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
54 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
55 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
56 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
57 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
58 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
59 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
60 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61 */
62 package java.time.format;
63
64 import static java.time.temporal.ChronoField.DAY_OF_MONTH;
65 import static java.time.temporal.ChronoField.HOUR_OF_DAY;
66 import static java.time.temporal.ChronoField.INSTANT_SECONDS;
67 import static java.time.temporal.ChronoField.MINUTE_OF_HOUR;
68 import static java.time.temporal.ChronoField.MONTH_OF_YEAR;
69 import static java.time.temporal.ChronoField.NANO_OF_SECOND;
70 import static java.time.temporal.ChronoField.OFFSET_SECONDS;
71 import static java.time.temporal.ChronoField.SECOND_OF_MINUTE;
72 import static java.time.temporal.ChronoField.YEAR;
73 import static java.time.temporal.ChronoField.ERA;
74
75 import java.lang.ref.SoftReference;
76 import java.math.BigDecimal;
77 import java.math.BigInteger;
78 import java.math.RoundingMode;
79 import java.text.ParsePosition;
80 import java.time.DateTimeException;
81 import java.time.Instant;
82 import java.time.LocalDate;
83 import java.time.LocalDateTime;
84 import java.time.ZoneId;
85 import java.time.ZoneOffset;
86 import java.time.chrono.ChronoLocalDate;
87 import java.time.chrono.Chronology;
88 import java.time.chrono.Era;
89 import java.time.chrono.IsoChronology;
90 import java.time.format.DateTimeTextProvider.LocaleStore;
91 import java.time.temporal.ChronoField;
92 import java.time.temporal.IsoFields;
93 import java.time.temporal.TemporalAccessor;
94 import java.time.temporal.TemporalField;
95 import java.time.temporal.TemporalQueries;
96 import java.time.temporal.TemporalQuery;
97 import java.time.temporal.ValueRange;
98 import java.time.temporal.WeekFields;
99 import java.time.zone.ZoneRulesProvider;
100 import java.util.AbstractMap.SimpleImmutableEntry;
101 import java.util.ArrayList;
102 import java.util.Arrays;
103 import java.util.Collections;
104 import java.util.Comparator;
105 import java.util.HashMap;
106 import java.util.HashSet;
107 import java.util.Iterator;
108 import java.util.LinkedHashMap;
109 import java.util.List;
110 import java.util.Locale;
111 import java.util.Map;
112 import java.util.Map.Entry;
113 import java.util.Objects;
114 import java.util.Set;
115 import java.util.TimeZone;
116 import java.util.concurrent.ConcurrentHashMap;
117 import java.util.concurrent.ConcurrentMap;
118
119 import sun.util.locale.provider.LocaleProviderAdapter;
120 import sun.util.locale.provider.LocaleResources;
121 import sun.util.locale.provider.TimeZoneNameUtility;
122
123 /**
124 * Builder to create date-time formatters.
125 * <p>
126 * This allows a {@code DateTimeFormatter} to be created.
127 * All date-time formatters are created ultimately using this builder.
128 * <p>
129 * The basic elements of date-time can all be added:
130 * <ul>
131 * <li>Value - a numeric value</li>
132 * <li>Fraction - a fractional value including the decimal place. Always use this when
133 * outputting fractions to ensure that the fraction is parsed correctly</li>
134 * <li>Text - the textual equivalent for the value</li>
135 * <li>OffsetId/Offset - the {@linkplain ZoneOffset zone offset}</li>
136 * <li>ZoneId - the {@linkplain ZoneId time-zone} id</li>
137 * <li>ZoneText - the name of the time-zone</li>
138 * <li>ChronologyId - the {@linkplain Chronology chronology} id</li>
139 * <li>ChronologyText - the name of the chronology</li>
140 * <li>Literal - a text literal</li>
141 * <li>Nested and Optional - formats can be nested or made optional</li>
142 * </ul>
143 * In addition, any of the elements may be decorated by padding, either with spaces or any other character.
144 * <p>
145 * Finally, a shorthand pattern, mostly compatible with {@code java.text.SimpleDateFormat SimpleDateFormat}
146 * can be used, see {@link #appendPattern(String)}.
147 * In practice, this simply parses the pattern and calls other methods on the builder.
148 *
149 * @implSpec
150 * This class is a mutable builder intended for use from a single thread.
151 *
152 * @since 1.8
153 */
154 public final class DateTimeFormatterBuilder {
155
156 /**
157 * Query for a time-zone that is region-only.
158 */
159 private static final TemporalQuery<ZoneId> QUERY_REGION_ONLY = (temporal) -> {
160 ZoneId zone = temporal.query(TemporalQueries.zoneId());
161 return (zone != null && zone instanceof ZoneOffset == false ? zone : null);
162 };
163
164 /**
165 * The currently active builder, used by the outermost builder.
166 */
167 private DateTimeFormatterBuilder active = this;
168 /**
169 * The parent builder, null for the outermost builder.
170 */
171 private final DateTimeFormatterBuilder parent;
172 /**
173 * The list of printers that will be used.
174 */
175 private final List<DateTimePrinterParser> printerParsers = new ArrayList<>();
176 /**
177 * Whether this builder produces an optional formatter.
178 */
179 private final boolean optional;
180 /**
181 * The width to pad the next field to.
182 */
183 private int padNextWidth;
184 /**
185 * The character to pad the next field with.
186 */
187 private char padNextChar;
188 /**
189 * The index of the last variable width value parser.
190 */
191 private int valueParserIndex = -1;
192
193 /**
194 * Gets the formatting pattern for date and time styles for a locale and chronology.
195 * The locale and chronology are used to lookup the locale specific format
196 * for the requested dateStyle and/or timeStyle.
197 *
198 * @param dateStyle the FormatStyle for the date, null for time-only pattern
199 * @param timeStyle the FormatStyle for the time, null for date-only pattern
200 * @param chrono the Chronology, non-null
201 * @param locale the locale, non-null
202 * @return the locale and Chronology specific formatting pattern
203 * @throws IllegalArgumentException if both dateStyle and timeStyle are null
204 */
205 public static String getLocalizedDateTimePattern(FormatStyle dateStyle, FormatStyle timeStyle,
206 Chronology chrono, Locale locale) {
207 Objects.requireNonNull(locale, "locale");
208 Objects.requireNonNull(chrono, "chrono");
209 if (dateStyle == null && timeStyle == null) {
210 throw new IllegalArgumentException("Either dateStyle or timeStyle must be non-null");
211 }
212 LocaleResources lr = LocaleProviderAdapter.getResourceBundleBased().getLocaleResources(locale);
213 String pattern = lr.getJavaTimeDateTimePattern(
214 convertStyle(timeStyle), convertStyle(dateStyle), chrono.getCalendarType());
215 return pattern;
216 }
217
218 /**
219 * Converts the given FormatStyle to the java.text.DateFormat style.
220 *
221 * @param style the FormatStyle style
222 * @return the int style, or -1 if style is null, indicating un-required
223 */
224 private static int convertStyle(FormatStyle style) {
225 if (style == null) {
226 return -1;
227 }
228 return style.ordinal(); // indices happen to align
229 }
230
231 /**
232 * Constructs a new instance of the builder.
233 */
234 public DateTimeFormatterBuilder() {
235 super();
236 parent = null;
237 optional = false;
238 }
239
240 /**
241 * Constructs a new instance of the builder.
242 *
243 * @param parent the parent builder, not null
244 * @param optional whether the formatter is optional, not null
245 */
246 private DateTimeFormatterBuilder(DateTimeFormatterBuilder parent, boolean optional) {
247 super();
248 this.parent = parent;
249 this.optional = optional;
250 }
251
252 //-----------------------------------------------------------------------
253 /**
254 * Changes the parse style to be case sensitive for the remainder of the formatter.
255 * <p>
256 * Parsing can be case sensitive or insensitive - by default it is case sensitive.
257 * This method allows the case sensitivity setting of parsing to be changed.
258 * <p>
259 * Calling this method changes the state of the builder such that all
260 * subsequent builder method calls will parse text in case sensitive mode.
261 * See {@link #parseCaseInsensitive} for the opposite setting.
262 * The parse case sensitive/insensitive methods may be called at any point
263 * in the builder, thus the parser can swap between case parsing modes
264 * multiple times during the parse.
265 * <p>
266 * Since the default is case sensitive, this method should only be used after
267 * a previous call to {@code #parseCaseInsensitive}.
268 *
269 * @return this, for chaining, not null
270 */
271 public DateTimeFormatterBuilder parseCaseSensitive() {
272 appendInternal(SettingsParser.SENSITIVE);
273 return this;
274 }
275
276 /**
277 * Changes the parse style to be case insensitive for the remainder of the formatter.
278 * <p>
279 * Parsing can be case sensitive or insensitive - by default it is case sensitive.
280 * This method allows the case sensitivity setting of parsing to be changed.
281 * <p>
282 * Calling this method changes the state of the builder such that all
283 * subsequent builder method calls will parse text in case insensitive mode.
284 * See {@link #parseCaseSensitive()} for the opposite setting.
285 * The parse case sensitive/insensitive methods may be called at any point
286 * in the builder, thus the parser can swap between case parsing modes
287 * multiple times during the parse.
288 *
289 * @return this, for chaining, not null
290 */
291 public DateTimeFormatterBuilder parseCaseInsensitive() {
292 appendInternal(SettingsParser.INSENSITIVE);
293 return this;
294 }
295
296 //-----------------------------------------------------------------------
297 /**
298 * Changes the parse style to be strict for the remainder of the formatter.
299 * <p>
300 * Parsing can be strict or lenient - by default its strict.
301 * This controls the degree of flexibility in matching the text and sign styles.
302 * <p>
303 * When used, this method changes the parsing to be strict from this point onwards.
304 * As strict is the default, this is normally only needed after calling {@link #parseLenient()}.
305 * The change will remain in force until the end of the formatter that is eventually
306 * constructed or until {@code parseLenient} is called.
307 *
308 * @return this, for chaining, not null
309 */
310 public DateTimeFormatterBuilder parseStrict() {
311 appendInternal(SettingsParser.STRICT);
312 return this;
313 }
314
315 /**
316 * Changes the parse style to be lenient for the remainder of the formatter.
317 * Note that case sensitivity is set separately to this method.
318 * <p>
319 * Parsing can be strict or lenient - by default its strict.
320 * This controls the degree of flexibility in matching the text and sign styles.
321 * Applications calling this method should typically also call {@link #parseCaseInsensitive()}.
322 * <p>
323 * When used, this method changes the parsing to be lenient from this point onwards.
324 * The change will remain in force until the end of the formatter that is eventually
325 * constructed or until {@code parseStrict} is called.
326 *
327 * @return this, for chaining, not null
328 */
329 public DateTimeFormatterBuilder parseLenient() {
330 appendInternal(SettingsParser.LENIENT);
331 return this;
332 }
333
334 //-----------------------------------------------------------------------
335 /**
336 * Appends a default value for a field to the formatter for use in parsing.
337 * <p>
338 * This appends an instruction to the builder to inject a default value
339 * into the parsed result. This is especially useful in conjunction with
340 * optional parts of the formatter.
341 * <p>
342 * For example, consider a formatter that parses the year, followed by
343 * an optional month, with a further optional day-of-month. Using such a
344 * formatter would require the calling code to check whether a full date,
345 * year-month or just a year had been parsed. This method can be used to
346 * default the month and day-of-month to a sensible value, such as the
347 * first of the month, allowing the calling code to always get a date.
348 * <p>
349 * During formatting, this method has no effect.
350 * <p>
351 * During parsing, the current state of the parse is inspected.
352 * If the specified field has no associated value, because it has not been
353 * parsed successfully at that point, then the specified value is injected
354 * into the parse result. Injection is immediate, thus the field-value pair
355 * will be visible to any subsequent elements in the formatter.
356 * As such, this method is normally called at the end of the builder.
357 *
358 * @param field the field to default the value of, not null
359 * @param value the value to default the field to
360 * @return this, for chaining, not null
361 */
362 public DateTimeFormatterBuilder parseDefaulting(TemporalField field, long value) {
363 Objects.requireNonNull(field, "field");
364 appendInternal(new DefaultValueParser(field, value));
365 return this;
366 }
367
368 //-----------------------------------------------------------------------
369 /**
370 * Appends the value of a date-time field to the formatter using a normal
371 * output style.
372 * <p>
373 * The value of the field will be output during a format.
374 * If the value cannot be obtained then an exception will be thrown.
375 * <p>
376 * The value will be printed as per the normal format of an integer value.
377 * Only negative numbers will be signed. No padding will be added.
378 * <p>
379 * The parser for a variable width value such as this normally behaves greedily,
380 * requiring one digit, but accepting as many digits as possible.
381 * This behavior can be affected by 'adjacent value parsing'.
382 * See {@link #appendValue(java.time.temporal.TemporalField, int)} for full details.
383 *
384 * @param field the field to append, not null
385 * @return this, for chaining, not null
386 */
387 public DateTimeFormatterBuilder appendValue(TemporalField field) {
388 Objects.requireNonNull(field, "field");
389 appendValue(new NumberPrinterParser(field, 1, 19, SignStyle.NORMAL));
390 return this;
391 }
392
393 /**
394 * Appends the value of a date-time field to the formatter using a fixed
395 * width, zero-padded approach.
396 * <p>
397 * The value of the field will be output during a format.
398 * If the value cannot be obtained then an exception will be thrown.
399 * <p>
400 * The value will be zero-padded on the left. If the size of the value
401 * means that it cannot be printed within the width then an exception is thrown.
402 * If the value of the field is negative then an exception is thrown during formatting.
403 * <p>
404 * This method supports a special technique of parsing known as 'adjacent value parsing'.
405 * This technique solves the problem where a value, variable or fixed width, is followed by one or more
406 * fixed length values. The standard parser is greedy, and thus it would normally
407 * steal the digits that are needed by the fixed width value parsers that follow the
408 * variable width one.
409 * <p>
410 * No action is required to initiate 'adjacent value parsing'.
411 * When a call to {@code appendValue} is made, the builder
412 * enters adjacent value parsing setup mode. If the immediately subsequent method
413 * call or calls on the same builder are for a fixed width value, then the parser will reserve
414 * space so that the fixed width values can be parsed.
415 * <p>
416 * For example, consider {@code builder.appendValue(YEAR).appendValue(MONTH_OF_YEAR, 2);}
417 * The year is a variable width parse of between 1 and 19 digits.
418 * The month is a fixed width parse of 2 digits.
419 * Because these were appended to the same builder immediately after one another,
420 * the year parser will reserve two digits for the month to parse.
421 * Thus, the text '201106' will correctly parse to a year of 2011 and a month of 6.
422 * Without adjacent value parsing, the year would greedily parse all six digits and leave
423 * nothing for the month.
424 * <p>
425 * Adjacent value parsing applies to each set of fixed width not-negative values in the parser
426 * that immediately follow any kind of value, variable or fixed width.
427 * Calling any other append method will end the setup of adjacent value parsing.
428 * Thus, in the unlikely event that you need to avoid adjacent value parsing behavior,
429 * simply add the {@code appendValue} to another {@code DateTimeFormatterBuilder}
430 * and add that to this builder.
431 * <p>
432 * If adjacent parsing is active, then parsing must match exactly the specified
433 * number of digits in both strict and lenient modes.
434 * In addition, no positive or negative sign is permitted.
435 *
436 * @param field the field to append, not null
437 * @param width the width of the printed field, from 1 to 19
438 * @return this, for chaining, not null
439 * @throws IllegalArgumentException if the width is invalid
440 */
441 public DateTimeFormatterBuilder appendValue(TemporalField field, int width) {
442 Objects.requireNonNull(field, "field");
443 if (width < 1 || width > 19) {
444 throw new IllegalArgumentException("The width must be from 1 to 19 inclusive but was " + width);
445 }
446 NumberPrinterParser pp = new NumberPrinterParser(field, width, width, SignStyle.NOT_NEGATIVE);
447 appendValue(pp);
448 return this;
449 }
450
451 /**
452 * Appends the value of a date-time field to the formatter providing full
453 * control over formatting.
454 * <p>
455 * The value of the field will be output during a format.
456 * If the value cannot be obtained then an exception will be thrown.
457 * <p>
458 * This method provides full control of the numeric formatting, including
459 * zero-padding and the positive/negative sign.
460 * <p>
461 * The parser for a variable width value such as this normally behaves greedily,
462 * accepting as many digits as possible.
463 * This behavior can be affected by 'adjacent value parsing'.
464 * See {@link #appendValue(java.time.temporal.TemporalField, int)} for full details.
465 * <p>
466 * In strict parsing mode, the minimum number of parsed digits is {@code minWidth}
467 * and the maximum is {@code maxWidth}.
468 * In lenient parsing mode, the minimum number of parsed digits is one
469 * and the maximum is 19 (except as limited by adjacent value parsing).
470 * <p>
471 * If this method is invoked with equal minimum and maximum widths and a sign style of
472 * {@code NOT_NEGATIVE} then it delegates to {@code appendValue(TemporalField,int)}.
473 * In this scenario, the formatting and parsing behavior described there occur.
474 *
475 * @param field the field to append, not null
476 * @param minWidth the minimum field width of the printed field, from 1 to 19
477 * @param maxWidth the maximum field width of the printed field, from 1 to 19
478 * @param signStyle the positive/negative output style, not null
479 * @return this, for chaining, not null
480 * @throws IllegalArgumentException if the widths are invalid
481 */
482 public DateTimeFormatterBuilder appendValue(
483 TemporalField field, int minWidth, int maxWidth, SignStyle signStyle) {
484 if (minWidth == maxWidth && signStyle == SignStyle.NOT_NEGATIVE) {
485 return appendValue(field, maxWidth);
486 }
487 Objects.requireNonNull(field, "field");
488 Objects.requireNonNull(signStyle, "signStyle");
489 if (minWidth < 1 || minWidth > 19) {
490 throw new IllegalArgumentException("The minimum width must be from 1 to 19 inclusive but was " + minWidth);
491 }
492 if (maxWidth < 1 || maxWidth > 19) {
493 throw new IllegalArgumentException("The maximum width must be from 1 to 19 inclusive but was " + maxWidth);
494 }
495 if (maxWidth < minWidth) {
496 throw new IllegalArgumentException("The maximum width must exceed or equal the minimum width but " +
497 maxWidth + " < " + minWidth);
498 }
499 NumberPrinterParser pp = new NumberPrinterParser(field, minWidth, maxWidth, signStyle);
500 appendValue(pp);
501 return this;
502 }
503
504 //-----------------------------------------------------------------------
505 /**
506 * Appends the reduced value of a date-time field to the formatter.
507 * <p>
508 * Since fields such as year vary by chronology, it is recommended to use the
509 * {@link #appendValueReduced(TemporalField, int, int, ChronoLocalDate)} date}
510 * variant of this method in most cases. This variant is suitable for
511 * simple fields or working with only the ISO chronology.
512 * <p>
513 * For formatting, the {@code width} and {@code maxWidth} are used to
514 * determine the number of characters to format.
515 * If they are equal then the format is fixed width.
516 * If the value of the field is within the range of the {@code baseValue} using
517 * {@code width} characters then the reduced value is formatted otherwise the value is
518 * truncated to fit {@code maxWidth}.
519 * The rightmost characters are output to match the width, left padding with zero.
520 * <p>
521 * For strict parsing, the number of characters allowed by {@code width} to {@code maxWidth} are parsed.
522 * For lenient parsing, the number of characters must be at least 1 and less than 10.
523 * If the number of digits parsed is equal to {@code width} and the value is positive,
524 * the value of the field is computed to be the first number greater than
525 * or equal to the {@code baseValue} with the same least significant characters,
526 * otherwise the value parsed is the field value.
527 * This allows a reduced value to be entered for values in range of the baseValue
528 * and width and absolute values can be entered for values outside the range.
529 * <p>
530 * For example, a base value of {@code 1980} and a width of {@code 2} will have
531 * valid values from {@code 1980} to {@code 2079}.
532 * During parsing, the text {@code "12"} will result in the value {@code 2012} as that
533 * is the value within the range where the last two characters are "12".
534 * By contrast, parsing the text {@code "1915"} will result in the value {@code 1915}.
535 *
536 * @param field the field to append, not null
537 * @param width the field width of the printed and parsed field, from 1 to 10
538 * @param maxWidth the maximum field width of the printed field, from 1 to 10
539 * @param baseValue the base value of the range of valid values
540 * @return this, for chaining, not null
541 * @throws IllegalArgumentException if the width or base value is invalid
542 */
543 public DateTimeFormatterBuilder appendValueReduced(TemporalField field,
544 int width, int maxWidth, int baseValue) {
545 Objects.requireNonNull(field, "field");
546 ReducedPrinterParser pp = new ReducedPrinterParser(field, width, maxWidth, baseValue, null);
547 appendValue(pp);
548 return this;
549 }
550
551 /**
552 * Appends the reduced value of a date-time field to the formatter.
553 * <p>
554 * This is typically used for formatting and parsing a two digit year.
555 * <p>
556 * The base date is used to calculate the full value during parsing.
557 * For example, if the base date is 1950-01-01 then parsed values for
558 * a two digit year parse will be in the range 1950-01-01 to 2049-12-31.
559 * Only the year would be extracted from the date, thus a base date of
560 * 1950-08-25 would also parse to the range 1950-01-01 to 2049-12-31.
561 * This behavior is necessary to support fields such as week-based-year
562 * or other calendar systems where the parsed value does not align with
563 * standard ISO years.
564 * <p>
565 * The exact behavior is as follows. Parse the full set of fields and
566 * determine the effective chronology using the last chronology if
567 * it appears more than once. Then convert the base date to the
568 * effective chronology. Then extract the specified field from the
569 * chronology-specific base date and use it to determine the
570 * {@code baseValue} used below.
571 * <p>
572 * For formatting, the {@code width} and {@code maxWidth} are used to
573 * determine the number of characters to format.
574 * If they are equal then the format is fixed width.
575 * If the value of the field is within the range of the {@code baseValue} using
576 * {@code width} characters then the reduced value is formatted otherwise the value is
577 * truncated to fit {@code maxWidth}.
578 * The rightmost characters are output to match the width, left padding with zero.
579 * <p>
580 * For strict parsing, the number of characters allowed by {@code width} to {@code maxWidth} are parsed.
581 * For lenient parsing, the number of characters must be at least 1 and less than 10.
582 * If the number of digits parsed is equal to {@code width} and the value is positive,
583 * the value of the field is computed to be the first number greater than
584 * or equal to the {@code baseValue} with the same least significant characters,
585 * otherwise the value parsed is the field value.
586 * This allows a reduced value to be entered for values in range of the baseValue
587 * and width and absolute values can be entered for values outside the range.
588 * <p>
589 * For example, a base value of {@code 1980} and a width of {@code 2} will have
590 * valid values from {@code 1980} to {@code 2079}.
591 * During parsing, the text {@code "12"} will result in the value {@code 2012} as that
592 * is the value within the range where the last two characters are "12".
593 * By contrast, parsing the text {@code "1915"} will result in the value {@code 1915}.
594 *
595 * @param field the field to append, not null
596 * @param width the field width of the printed and parsed field, from 1 to 10
597 * @param maxWidth the maximum field width of the printed field, from 1 to 10
598 * @param baseDate the base date used to calculate the base value for the range
599 * of valid values in the parsed chronology, not null
600 * @return this, for chaining, not null
601 * @throws IllegalArgumentException if the width or base value is invalid
602 */
603 public DateTimeFormatterBuilder appendValueReduced(
604 TemporalField field, int width, int maxWidth, ChronoLocalDate baseDate) {
605 Objects.requireNonNull(field, "field");
606 Objects.requireNonNull(baseDate, "baseDate");
607 ReducedPrinterParser pp = new ReducedPrinterParser(field, width, maxWidth, 0, baseDate);
608 appendValue(pp);
609 return this;
610 }
611
612 /**
613 * Appends a fixed or variable width printer-parser handling adjacent value mode.
614 * If a PrinterParser is not active then the new PrinterParser becomes
615 * the active PrinterParser.
616 * Otherwise, the active PrinterParser is modified depending on the new PrinterParser.
617 * If the new PrinterParser is fixed width and has sign style {@code NOT_NEGATIVE}
618 * then its width is added to the active PP and
619 * the new PrinterParser is forced to be fixed width.
620 * If the new PrinterParser is variable width, the active PrinterParser is changed
621 * to be fixed width and the new PrinterParser becomes the active PP.
622 *
623 * @param pp the printer-parser, not null
624 * @return this, for chaining, not null
625 */
626 private DateTimeFormatterBuilder appendValue(NumberPrinterParser pp) {
627 if (active.valueParserIndex >= 0) {
628 final int activeValueParser = active.valueParserIndex;
629
630 // adjacent parsing mode, update setting in previous parsers
631 NumberPrinterParser basePP = (NumberPrinterParser) active.printerParsers.get(activeValueParser);
632 if (pp.minWidth == pp.maxWidth && pp.signStyle == SignStyle.NOT_NEGATIVE) {
633 // Append the width to the subsequentWidth of the active parser
634 basePP = basePP.withSubsequentWidth(pp.maxWidth);
635 // Append the new parser as a fixed width
636 appendInternal(pp.withFixedWidth());
637 // Retain the previous active parser
638 active.valueParserIndex = activeValueParser;
639 } else {
640 // Modify the active parser to be fixed width
641 basePP = basePP.withFixedWidth();
642 // The new parser becomes the mew active parser
643 active.valueParserIndex = appendInternal(pp);
644 }
645 // Replace the modified parser with the updated one
646 active.printerParsers.set(activeValueParser, basePP);
647 } else {
648 // The new Parser becomes the active parser
649 active.valueParserIndex = appendInternal(pp);
650 }
651 return this;
652 }
653
654 //-----------------------------------------------------------------------
655 /**
656 * Appends the fractional value of a date-time field to the formatter.
657 * <p>
658 * The fractional value of the field will be output including the
659 * preceding decimal point. The preceding value is not output.
660 * For example, the second-of-minute value of 15 would be output as {@code .25}.
661 * <p>
662 * The width of the printed fraction can be controlled. Setting the
663 * minimum width to zero will cause no output to be generated.
664 * The printed fraction will have the minimum width necessary between
665 * the minimum and maximum widths - trailing zeroes are omitted.
666 * No rounding occurs due to the maximum width - digits are simply dropped.
667 * <p>
668 * When parsing in strict mode, the number of parsed digits must be between
669 * the minimum and maximum width. When parsing in lenient mode, the minimum
670 * width is considered to be zero and the maximum is nine.
671 * <p>
672 * If the value cannot be obtained then an exception will be thrown.
673 * If the value is negative an exception will be thrown.
674 * If the field does not have a fixed set of valid values then an
675 * exception will be thrown.
676 * If the field value in the date-time to be printed is invalid it
677 * cannot be printed and an exception will be thrown.
678 *
679 * @param field the field to append, not null
680 * @param minWidth the minimum width of the field excluding the decimal point, from 0 to 9
681 * @param maxWidth the maximum width of the field excluding the decimal point, from 1 to 9
682 * @param decimalPoint whether to output the localized decimal point symbol
683 * @return this, for chaining, not null
684 * @throws IllegalArgumentException if the field has a variable set of valid values or
685 * either width is invalid
686 */
687 public DateTimeFormatterBuilder appendFraction(
688 TemporalField field, int minWidth, int maxWidth, boolean decimalPoint) {
689 appendInternal(new FractionPrinterParser(field, minWidth, maxWidth, decimalPoint));
690 return this;
691 }
692
693 //-----------------------------------------------------------------------
694 /**
695 * Appends the text of a date-time field to the formatter using the full
696 * text style.
697 * <p>
698 * The text of the field will be output during a format.
699 * The value must be within the valid range of the field.
700 * If the value cannot be obtained then an exception will be thrown.
701 * If the field has no textual representation, then the numeric value will be used.
702 * <p>
703 * The value will be printed as per the normal format of an integer value.
704 * Only negative numbers will be signed. No padding will be added.
705 *
706 * @param field the field to append, not null
707 * @return this, for chaining, not null
708 */
709 public DateTimeFormatterBuilder appendText(TemporalField field) {
710 return appendText(field, TextStyle.FULL);
711 }
712
713 /**
714 * Appends the text of a date-time field to the formatter.
715 * <p>
716 * The text of the field will be output during a format.
717 * The value must be within the valid range of the field.
718 * If the value cannot be obtained then an exception will be thrown.
719 * If the field has no textual representation, then the numeric value will be used.
720 * <p>
721 * The value will be printed as per the normal format of an integer value.
722 * Only negative numbers will be signed. No padding will be added.
723 *
724 * @param field the field to append, not null
725 * @param textStyle the text style to use, not null
726 * @return this, for chaining, not null
727 */
728 public DateTimeFormatterBuilder appendText(TemporalField field, TextStyle textStyle) {
729 Objects.requireNonNull(field, "field");
730 Objects.requireNonNull(textStyle, "textStyle");
731 appendInternal(new TextPrinterParser(field, textStyle, DateTimeTextProvider.getInstance()));
732 return this;
733 }
734
735 /**
736 * Appends the text of a date-time field to the formatter using the specified
737 * map to supply the text.
738 * <p>
739 * The standard text outputting methods use the localized text in the JDK.
740 * This method allows that text to be specified directly.
741 * The supplied map is not validated by the builder to ensure that formatting or
742 * parsing is possible, thus an invalid map may throw an error during later use.
743 * <p>
744 * Supplying the map of text provides considerable flexibility in formatting and parsing.
745 * For example, a legacy application might require or supply the months of the
746 * year as "JNY", "FBY", "MCH" etc. These do not match the standard set of text
747 * for localized month names. Using this method, a map can be created which
748 * defines the connection between each value and the text:
749 * <pre>
750 * Map<Long, String> map = new HashMap<>();
751 * map.put(1L, "JNY");
752 * map.put(2L, "FBY");
753 * map.put(3L, "MCH");
754 * ...
755 * builder.appendText(MONTH_OF_YEAR, map);
756 * </pre>
757 * <p>
758 * Other uses might be to output the value with a suffix, such as "1st", "2nd", "3rd",
759 * or as Roman numerals "I", "II", "III", "IV".
760 * <p>
761 * During formatting, the value is obtained and checked that it is in the valid range.
762 * If text is not available for the value then it is output as a number.
763 * During parsing, the parser will match against the map of text and numeric values.
764 *
765 * @param field the field to append, not null
766 * @param textLookup the map from the value to the text
767 * @return this, for chaining, not null
768 */
769 public DateTimeFormatterBuilder appendText(TemporalField field, Map<Long, String> textLookup) {
770 Objects.requireNonNull(field, "field");
771 Objects.requireNonNull(textLookup, "textLookup");
772 Map<Long, String> copy = new LinkedHashMap<>(textLookup);
773 Map<TextStyle, Map<Long, String>> map = Collections.singletonMap(TextStyle.FULL, copy);
774 final LocaleStore store = new LocaleStore(map);
775 DateTimeTextProvider provider = new DateTimeTextProvider() {
776 @Override
777 public String getText(TemporalField field, long value, TextStyle style, Locale locale) {
778 return store.getText(value, style);
779 }
780 @Override
781 public Iterator<Entry<String, Long>> getTextIterator(TemporalField field, TextStyle style, Locale locale) {
782 return store.getTextIterator(style);
783 }
784 };
785 appendInternal(new TextPrinterParser(field, TextStyle.FULL, provider));
786 return this;
787 }
788
789 //-----------------------------------------------------------------------
790 /**
791 * Appends an instant using ISO-8601 to the formatter, formatting fractional
792 * digits in groups of three.
793 * <p>
794 * Instants have a fixed output format.
795 * They are converted to a date-time with a zone-offset of UTC and formatted
796 * using the standard ISO-8601 format.
797 * With this method, formatting nano-of-second outputs zero, three, six
798 * or nine digits as necessary.
799 * The localized decimal style is not used.
800 * <p>
801 * The instant is obtained using {@link ChronoField#INSTANT_SECONDS INSTANT_SECONDS}
802 * and optionally (@code NANO_OF_SECOND). The value of {@code INSTANT_SECONDS}
803 * may be outside the maximum range of {@code LocalDateTime}.
804 * <p>
805 * The {@linkplain ResolverStyle resolver style} has no effect on instant parsing.
806 * The end-of-day time of '24:00' is handled as midnight at the start of the following day.
807 * The leap-second time of '23:59:59' is handled to some degree, see
808 * {@link DateTimeFormatter#parsedLeapSecond()} for full details.
809 * <p>
810 * An alternative to this method is to format/parse the instant as a single
811 * epoch-seconds value. That is achieved using {@code appendValue(INSTANT_SECONDS)}.
812 *
813 * @return this, for chaining, not null
814 */
815 public DateTimeFormatterBuilder appendInstant() {
816 appendInternal(new InstantPrinterParser(-2));
817 return this;
818 }
819
820 /**
821 * Appends an instant using ISO-8601 to the formatter with control over
822 * the number of fractional digits.
823 * <p>
824 * Instants have a fixed output format, although this method provides some
825 * control over the fractional digits. They are converted to a date-time
826 * with a zone-offset of UTC and printed using the standard ISO-8601 format.
827 * The localized decimal style is not used.
828 * <p>
829 * The {@code fractionalDigits} parameter allows the output of the fractional
830 * second to be controlled. Specifying zero will cause no fractional digits
831 * to be output. From 1 to 9 will output an increasing number of digits, using
832 * zero right-padding if necessary. The special value -1 is used to output as
833 * many digits as necessary to avoid any trailing zeroes.
834 * <p>
835 * When parsing in strict mode, the number of parsed digits must match the
836 * fractional digits. When parsing in lenient mode, any number of fractional
837 * digits from zero to nine are accepted.
838 * <p>
839 * The instant is obtained using {@link ChronoField#INSTANT_SECONDS INSTANT_SECONDS}
840 * and optionally (@code NANO_OF_SECOND). The value of {@code INSTANT_SECONDS}
841 * may be outside the maximum range of {@code LocalDateTime}.
842 * <p>
843 * The {@linkplain ResolverStyle resolver style} has no effect on instant parsing.
844 * The end-of-day time of '24:00' is handled as midnight at the start of the following day.
845 * The leap-second time of '23:59:60' is handled to some degree, see
846 * {@link DateTimeFormatter#parsedLeapSecond()} for full details.
847 * <p>
848 * An alternative to this method is to format/parse the instant as a single
849 * epoch-seconds value. That is achieved using {@code appendValue(INSTANT_SECONDS)}.
850 *
851 * @param fractionalDigits the number of fractional second digits to format with,
852 * from 0 to 9, or -1 to use as many digits as necessary
853 * @return this, for chaining, not null
854 * @throws IllegalArgumentException if the number of fractional digits is invalid
855 */
856 public DateTimeFormatterBuilder appendInstant(int fractionalDigits) {
857 if (fractionalDigits < -1 || fractionalDigits > 9) {
858 throw new IllegalArgumentException("The fractional digits must be from -1 to 9 inclusive but was " + fractionalDigits);
859 }
860 appendInternal(new InstantPrinterParser(fractionalDigits));
861 return this;
862 }
863
864 //-----------------------------------------------------------------------
865 /**
866 * Appends the zone offset, such as '+01:00', to the formatter.
867 * <p>
868 * This appends an instruction to format/parse the offset ID to the builder.
869 * This is equivalent to calling {@code appendOffset("+HH:MM:ss", "Z")}.
870 *
871 * @return this, for chaining, not null
872 */
873 public DateTimeFormatterBuilder appendOffsetId() {
874 appendInternal(OffsetIdPrinterParser.INSTANCE_ID_Z);
875 return this;
876 }
877
878 /**
879 * Appends the zone offset, such as '+01:00', to the formatter.
880 * <p>
881 * This appends an instruction to format/parse the offset ID to the builder.
882 * <p>
883 * During formatting, the offset is obtained using a mechanism equivalent
884 * to querying the temporal with {@link TemporalQueries#offset()}.
885 * It will be printed using the format defined below.
886 * If the offset cannot be obtained then an exception is thrown unless the
887 * section of the formatter is optional.
888 * <p>
889 * During parsing, the offset is parsed using the format defined below.
890 * If the offset cannot be parsed then an exception is thrown unless the
891 * section of the formatter is optional.
892 * <p>
893 * The format of the offset is controlled by a pattern which must be one
894 * of the following:
895 * <ul>
896 * <li>{@code +HH} - hour only, ignoring minute and second
897 * <li>{@code +HHmm} - hour, with minute if non-zero, ignoring second, no colon
898 * <li>{@code +HH:mm} - hour, with minute if non-zero, ignoring second, with colon
899 * <li>{@code +HHMM} - hour and minute, ignoring second, no colon
900 * <li>{@code +HH:MM} - hour and minute, ignoring second, with colon
901 * <li>{@code +HHMMss} - hour and minute, with second if non-zero, no colon
902 * <li>{@code +HH:MM:ss} - hour and minute, with second if non-zero, with colon
903 * <li>{@code +HHMMSS} - hour, minute and second, no colon
904 * <li>{@code +HH:MM:SS} - hour, minute and second, with colon
905 * </ul>
906 * The "no offset" text controls what text is printed when the total amount of
907 * the offset fields to be output is zero.
908 * Example values would be 'Z', '+00:00', 'UTC' or 'GMT'.
909 * Three formats are accepted for parsing UTC - the "no offset" text, and the
910 * plus and minus versions of zero defined by the pattern.
911 *
912 * @param pattern the pattern to use, not null
913 * @param noOffsetText the text to use when the offset is zero, not null
914 * @return this, for chaining, not null
915 * @throws IllegalArgumentException if the pattern is invalid
916 */
917 public DateTimeFormatterBuilder appendOffset(String pattern, String noOffsetText) {
918 appendInternal(new OffsetIdPrinterParser(pattern, noOffsetText));
919 return this;
920 }
921
922 /**
923 * Appends the localized zone offset, such as 'GMT+01:00', to the formatter.
924 * <p>
925 * This appends a localized zone offset to the builder, the format of the
926 * localized offset is controlled by the specified {@link FormatStyle style}
927 * to this method:
928 * <ul>
929 * <li>{@link TextStyle#FULL full} - formats with localized offset text, such
930 * as 'GMT, 2-digit hour and minute field, optional second field if non-zero,
931 * and colon.
932 * <li>{@link TextStyle#SHORT short} - formats with localized offset text,
933 * such as 'GMT, hour without leading zero, optional 2-digit minute and
934 * second if non-zero, and colon.
935 * </ul>
936 * <p>
937 * During formatting, the offset is obtained using a mechanism equivalent
938 * to querying the temporal with {@link TemporalQueries#offset()}.
939 * If the offset cannot be obtained then an exception is thrown unless the
940 * section of the formatter is optional.
941 * <p>
942 * During parsing, the offset is parsed using the format defined above.
943 * If the offset cannot be parsed then an exception is thrown unless the
944 * section of the formatter is optional.
945 *
946 * @param style the format style to use, not null
947 * @return this, for chaining, not null
948 * @throws IllegalArgumentException if style is neither {@link TextStyle#FULL
949 * full} nor {@link TextStyle#SHORT short}
950 */
951 public DateTimeFormatterBuilder appendLocalizedOffset(TextStyle style) {
952 Objects.requireNonNull(style, "style");
953 if (style != TextStyle.FULL && style != TextStyle.SHORT) {
954 throw new IllegalArgumentException("Style must be either full or short");
955 }
956 appendInternal(new LocalizedOffsetIdPrinterParser(style));
957 return this;
958 }
959
960 //-----------------------------------------------------------------------
961 /**
962 * Appends the time-zone ID, such as 'Europe/Paris' or '+02:00', to the formatter.
963 * <p>
964 * This appends an instruction to format/parse the zone ID to the builder.
965 * The zone ID is obtained in a strict manner suitable for {@code ZonedDateTime}.
966 * By contrast, {@code OffsetDateTime} does not have a zone ID suitable
967 * for use with this method, see {@link #appendZoneOrOffsetId()}.
968 * <p>
969 * During formatting, the zone is obtained using a mechanism equivalent
970 * to querying the temporal with {@link TemporalQueries#zoneId()}.
971 * It will be printed using the result of {@link ZoneId#getId()}.
972 * If the zone cannot be obtained then an exception is thrown unless the
973 * section of the formatter is optional.
974 * <p>
975 * During parsing, the text must match a known zone or offset.
976 * There are two types of zone ID, offset-based, such as '+01:30' and
977 * region-based, such as 'Europe/London'. These are parsed differently.
978 * If the parse starts with '+', '-', 'UT', 'UTC' or 'GMT', then the parser
979 * expects an offset-based zone and will not match region-based zones.
980 * The offset ID, such as '+02:30', may be at the start of the parse,
981 * or prefixed by 'UT', 'UTC' or 'GMT'. The offset ID parsing is
982 * equivalent to using {@link #appendOffset(String, String)} using the
983 * arguments 'HH:MM:ss' and the no offset string '0'.
984 * If the parse starts with 'UT', 'UTC' or 'GMT', and the parser cannot
985 * match a following offset ID, then {@link ZoneOffset#UTC} is selected.
986 * In all other cases, the list of known region-based zones is used to
987 * find the longest available match. If no match is found, and the parse
988 * starts with 'Z', then {@code ZoneOffset.UTC} is selected.
989 * The parser uses the {@linkplain #parseCaseInsensitive() case sensitive} setting.
990 * <p>
991 * For example, the following will parse:
992 * <pre>
993 * "Europe/London" -- ZoneId.of("Europe/London")
994 * "Z" -- ZoneOffset.UTC
995 * "UT" -- ZoneId.of("UT")
996 * "UTC" -- ZoneId.of("UTC")
997 * "GMT" -- ZoneId.of("GMT")
998 * "+01:30" -- ZoneOffset.of("+01:30")
999 * "UT+01:30" -- ZoneOffset.of("+01:30")
1000 * "UTC+01:30" -- ZoneOffset.of("+01:30")
1001 * "GMT+01:30" -- ZoneOffset.of("+01:30")
1002 * </pre>
1003 *
1004 * @return this, for chaining, not null
1005 * @see #appendZoneRegionId()
1006 */
1007 public DateTimeFormatterBuilder appendZoneId() {
1008 appendInternal(new ZoneIdPrinterParser(TemporalQueries.zoneId(), "ZoneId()"));
1009 return this;
1010 }
1011
1012 /**
1013 * Appends the time-zone region ID, such as 'Europe/Paris', to the formatter,
1014 * rejecting the zone ID if it is a {@code ZoneOffset}.
1015 * <p>
1016 * This appends an instruction to format/parse the zone ID to the builder
1017 * only if it is a region-based ID.
1018 * <p>
1019 * During formatting, the zone is obtained using a mechanism equivalent
1020 * to querying the temporal with {@link TemporalQueries#zoneId()}.
1021 * If the zone is a {@code ZoneOffset} or it cannot be obtained then
1022 * an exception is thrown unless the section of the formatter is optional.
1023 * If the zone is not an offset, then the zone will be printed using
1024 * the zone ID from {@link ZoneId#getId()}.
1025 * <p>
1026 * During parsing, the text must match a known zone or offset.
1027 * There are two types of zone ID, offset-based, such as '+01:30' and
1028 * region-based, such as 'Europe/London'. These are parsed differently.
1029 * If the parse starts with '+', '-', 'UT', 'UTC' or 'GMT', then the parser
1030 * expects an offset-based zone and will not match region-based zones.
1031 * The offset ID, such as '+02:30', may be at the start of the parse,
1032 * or prefixed by 'UT', 'UTC' or 'GMT'. The offset ID parsing is
1033 * equivalent to using {@link #appendOffset(String, String)} using the
1034 * arguments 'HH:MM:ss' and the no offset string '0'.
1035 * If the parse starts with 'UT', 'UTC' or 'GMT', and the parser cannot
1036 * match a following offset ID, then {@link ZoneOffset#UTC} is selected.
1037 * In all other cases, the list of known region-based zones is used to
1038 * find the longest available match. If no match is found, and the parse
1039 * starts with 'Z', then {@code ZoneOffset.UTC} is selected.
1040 * The parser uses the {@linkplain #parseCaseInsensitive() case sensitive} setting.
1041 * <p>
1042 * For example, the following will parse:
1043 * <pre>
1044 * "Europe/London" -- ZoneId.of("Europe/London")
1045 * "Z" -- ZoneOffset.UTC
1046 * "UT" -- ZoneId.of("UT")
1047 * "UTC" -- ZoneId.of("UTC")
1048 * "GMT" -- ZoneId.of("GMT")
1049 * "+01:30" -- ZoneOffset.of("+01:30")
1050 * "UT+01:30" -- ZoneOffset.of("+01:30")
1051 * "UTC+01:30" -- ZoneOffset.of("+01:30")
1052 * "GMT+01:30" -- ZoneOffset.of("+01:30")
1053 * </pre>
1054 * <p>
1055 * Note that this method is identical to {@code appendZoneId()} except
1056 * in the mechanism used to obtain the zone.
1057 * Note also that parsing accepts offsets, whereas formatting will never
1058 * produce one.
1059 *
1060 * @return this, for chaining, not null
1061 * @see #appendZoneId()
1062 */
1063 public DateTimeFormatterBuilder appendZoneRegionId() {
1064 appendInternal(new ZoneIdPrinterParser(QUERY_REGION_ONLY, "ZoneRegionId()"));
1065 return this;
1066 }
1067
1068 /**
1069 * Appends the time-zone ID, such as 'Europe/Paris' or '+02:00', to
1070 * the formatter, using the best available zone ID.
1071 * <p>
1072 * This appends an instruction to format/parse the best available
1073 * zone or offset ID to the builder.
1074 * The zone ID is obtained in a lenient manner that first attempts to
1075 * find a true zone ID, such as that on {@code ZonedDateTime}, and
1076 * then attempts to find an offset, such as that on {@code OffsetDateTime}.
1077 * <p>
1078 * During formatting, the zone is obtained using a mechanism equivalent
1079 * to querying the temporal with {@link TemporalQueries#zone()}.
1080 * It will be printed using the result of {@link ZoneId#getId()}.
1081 * If the zone cannot be obtained then an exception is thrown unless the
1082 * section of the formatter is optional.
1083 * <p>
1084 * During parsing, the text must match a known zone or offset.
1085 * There are two types of zone ID, offset-based, such as '+01:30' and
1086 * region-based, such as 'Europe/London'. These are parsed differently.
1087 * If the parse starts with '+', '-', 'UT', 'UTC' or 'GMT', then the parser
1088 * expects an offset-based zone and will not match region-based zones.
1089 * The offset ID, such as '+02:30', may be at the start of the parse,
1090 * or prefixed by 'UT', 'UTC' or 'GMT'. The offset ID parsing is
1091 * equivalent to using {@link #appendOffset(String, String)} using the
1092 * arguments 'HH:MM:ss' and the no offset string '0'.
1093 * If the parse starts with 'UT', 'UTC' or 'GMT', and the parser cannot
1094 * match a following offset ID, then {@link ZoneOffset#UTC} is selected.
1095 * In all other cases, the list of known region-based zones is used to
1096 * find the longest available match. If no match is found, and the parse
1097 * starts with 'Z', then {@code ZoneOffset.UTC} is selected.
1098 * The parser uses the {@linkplain #parseCaseInsensitive() case sensitive} setting.
1099 * <p>
1100 * For example, the following will parse:
1101 * <pre>
1102 * "Europe/London" -- ZoneId.of("Europe/London")
1103 * "Z" -- ZoneOffset.UTC
1104 * "UT" -- ZoneId.of("UT")
1105 * "UTC" -- ZoneId.of("UTC")
1106 * "GMT" -- ZoneId.of("GMT")
1107 * "+01:30" -- ZoneOffset.of("+01:30")
1108 * "UT+01:30" -- ZoneOffset.of("UT+01:30")
1109 * "UTC+01:30" -- ZoneOffset.of("UTC+01:30")
1110 * "GMT+01:30" -- ZoneOffset.of("GMT+01:30")
1111 * </pre>
1112 * <p>
1113 * Note that this method is identical to {@code appendZoneId()} except
1114 * in the mechanism used to obtain the zone.
1115 *
1116 * @return this, for chaining, not null
1117 * @see #appendZoneId()
1118 */
1119 public DateTimeFormatterBuilder appendZoneOrOffsetId() {
1120 appendInternal(new ZoneIdPrinterParser(TemporalQueries.zone(), "ZoneOrOffsetId()"));
1121 return this;
1122 }
1123
1124 /**
1125 * Appends the time-zone name, such as 'British Summer Time', to the formatter.
1126 * <p>
1127 * This appends an instruction to format/parse the textual name of the zone to
1128 * the builder.
1129 * <p>
1130 * During formatting, the zone is obtained using a mechanism equivalent
1131 * to querying the temporal with {@link TemporalQueries#zoneId()}.
1132 * If the zone is a {@code ZoneOffset} it will be printed using the
1133 * result of {@link ZoneOffset#getId()}.
1134 * If the zone is not an offset, the textual name will be looked up
1135 * for the locale set in the {@link DateTimeFormatter}.
1136 * If the temporal object being printed represents an instant, then the text
1137 * will be the summer or winter time text as appropriate.
1138 * If the lookup for text does not find any suitable result, then the
1139 * {@link ZoneId#getId() ID} will be printed instead.
1140 * If the zone cannot be obtained then an exception is thrown unless the
1141 * section of the formatter is optional.
1142 * <p>
1143 * During parsing, either the textual zone name, the zone ID or the offset
1144 * is accepted. Many textual zone names are not unique, such as CST can be
1145 * for both "Central Standard Time" and "China Standard Time". In this
1146 * situation, the zone id will be determined by the region information from
1147 * formatter's {@link DateTimeFormatter#getLocale() locale} and the standard
1148 * zone id for that area, for example, America/New_York for the America Eastern
1149 * zone. The {@link #appendZoneText(TextStyle, Set)} may be used
1150 * to specify a set of preferred {@link ZoneId} in this situation.
1151 *
1152 * @param textStyle the text style to use, not null
1153 * @return this, for chaining, not null
1154 */
1155 public DateTimeFormatterBuilder appendZoneText(TextStyle textStyle) {
1156 appendInternal(new ZoneTextPrinterParser(textStyle, null));
1157 return this;
1158 }
1159
1160 /**
1161 * Appends the time-zone name, such as 'British Summer Time', to the formatter.
1162 * <p>
1163 * This appends an instruction to format/parse the textual name of the zone to
1164 * the builder.
1165 * <p>
1166 * During formatting, the zone is obtained using a mechanism equivalent
1167 * to querying the temporal with {@link TemporalQueries#zoneId()}.
1168 * If the zone is a {@code ZoneOffset} it will be printed using the
1169 * result of {@link ZoneOffset#getId()}.
1170 * If the zone is not an offset, the textual name will be looked up
1171 * for the locale set in the {@link DateTimeFormatter}.
1172 * If the temporal object being printed represents an instant, then the text
1173 * will be the summer or winter time text as appropriate.
1174 * If the lookup for text does not find any suitable result, then the
1175 * {@link ZoneId#getId() ID} will be printed instead.
1176 * If the zone cannot be obtained then an exception is thrown unless the
1177 * section of the formatter is optional.
1178 * <p>
1179 * During parsing, either the textual zone name, the zone ID or the offset
1180 * is accepted. Many textual zone names are not unique, such as CST can be
1181 * for both "Central Standard Time" and "China Standard Time". In this
1182 * situation, the zone id will be determined by the region information from
1183 * formatter's {@link DateTimeFormatter#getLocale() locale} and the standard
1184 * zone id for that area, for example, America/New_York for the America Eastern
1185 * zone. This method also allows a set of preferred {@link ZoneId} to be
1186 * specified for parsing. The matched preferred zone id will be used if the
1187 * textural zone name being parsed is not unique.
1188 * <p>
1189 * If the zone cannot be parsed then an exception is thrown unless the
1190 * section of the formatter is optional.
1191 *
1192 * @param textStyle the text style to use, not null
1193 * @param preferredZones the set of preferred zone ids, not null
1194 * @return this, for chaining, not null
1195 */
1196 public DateTimeFormatterBuilder appendZoneText(TextStyle textStyle,
1197 Set<ZoneId> preferredZones) {
1198 Objects.requireNonNull(preferredZones, "preferredZones");
1199 appendInternal(new ZoneTextPrinterParser(textStyle, preferredZones));
1200 return this;
1201 }
1202
1203 //-----------------------------------------------------------------------
1204 /**
1205 * Appends the chronology ID, such as 'ISO' or 'ThaiBuddhist', to the formatter.
1206 * <p>
1207 * This appends an instruction to format/parse the chronology ID to the builder.
1208 * <p>
1209 * During formatting, the chronology is obtained using a mechanism equivalent
1210 * to querying the temporal with {@link TemporalQueries#chronology()}.
1211 * It will be printed using the result of {@link Chronology#getId()}.
1212 * If the chronology cannot be obtained then an exception is thrown unless the
1213 * section of the formatter is optional.
1214 * <p>
1215 * During parsing, the chronology is parsed and must match one of the chronologies
1216 * in {@link Chronology#getAvailableChronologies()}.
1217 * If the chronology cannot be parsed then an exception is thrown unless the
1218 * section of the formatter is optional.
1219 * The parser uses the {@linkplain #parseCaseInsensitive() case sensitive} setting.
1220 *
1221 * @return this, for chaining, not null
1222 */
1223 public DateTimeFormatterBuilder appendChronologyId() {
1224 appendInternal(new ChronoPrinterParser(null));
1225 return this;
1226 }
1227
1228 /**
1229 * Appends the chronology name to the formatter.
1230 * <p>
1231 * The calendar system name will be output during a format.
1232 * If the chronology cannot be obtained then an exception will be thrown.
1233 *
1234 * @param textStyle the text style to use, not null
1235 * @return this, for chaining, not null
1236 */
1237 public DateTimeFormatterBuilder appendChronologyText(TextStyle textStyle) {
1238 Objects.requireNonNull(textStyle, "textStyle");
1239 appendInternal(new ChronoPrinterParser(textStyle));
1240 return this;
1241 }
1242
1243 //-----------------------------------------------------------------------
1244 /**
1245 * Appends a localized date-time pattern to the formatter.
1246 * <p>
1247 * This appends a localized section to the builder, suitable for outputting
1248 * a date, time or date-time combination. The format of the localized
1249 * section is lazily looked up based on four items:
1250 * <ul>
1251 * <li>the {@code dateStyle} specified to this method
1252 * <li>the {@code timeStyle} specified to this method
1253 * <li>the {@code Locale} of the {@code DateTimeFormatter}
1254 * <li>the {@code Chronology}, selecting the best available
1255 * </ul>
1256 * During formatting, the chronology is obtained from the temporal object
1257 * being formatted, which may have been overridden by
1258 * {@link DateTimeFormatter#withChronology(Chronology)}.
1259 * The {@code FULL} and {@code LONG} styles typically require a time-zone.
1260 * When formatting using these styles, a {@code ZoneId} must be available,
1261 * either by using {@code ZonedDateTime} or {@link DateTimeFormatter#withZone}.
1262 * <p>
1263 * During parsing, if a chronology has already been parsed, then it is used.
1264 * Otherwise the default from {@code DateTimeFormatter.withChronology(Chronology)}
1265 * is used, with {@code IsoChronology} as the fallback.
1266 * <p>
1267 * Note that this method provides similar functionality to methods on
1268 * {@code DateFormat} such as {@link java.text.DateFormat#getDateTimeInstance(int, int)}.
1269 *
1270 * @param dateStyle the date style to use, null means no date required
1271 * @param timeStyle the time style to use, null means no time required
1272 * @return this, for chaining, not null
1273 * @throws IllegalArgumentException if both the date and time styles are null
1274 */
1275 public DateTimeFormatterBuilder appendLocalized(FormatStyle dateStyle, FormatStyle timeStyle) {
1276 if (dateStyle == null && timeStyle == null) {
1277 throw new IllegalArgumentException("Either the date or time style must be non-null");
1278 }
1279 appendInternal(new LocalizedPrinterParser(dateStyle, timeStyle));
1280 return this;
1281 }
1282
1283 //-----------------------------------------------------------------------
1284 /**
1285 * Appends a character literal to the formatter.
1286 * <p>
1287 * This character will be output during a format.
1288 *
1289 * @param literal the literal to append, not null
1290 * @return this, for chaining, not null
1291 */
1292 public DateTimeFormatterBuilder appendLiteral(char literal) {
1293 appendInternal(new CharLiteralPrinterParser(literal));
1294 return this;
1295 }
1296
1297 /**
1298 * Appends a string literal to the formatter.
1299 * <p>
1300 * This string will be output during a format.
1301 * <p>
1302 * If the literal is empty, nothing is added to the formatter.
1303 *
1304 * @param literal the literal to append, not null
1305 * @return this, for chaining, not null
1306 */
1307 public DateTimeFormatterBuilder appendLiteral(String literal) {
1308 Objects.requireNonNull(literal, "literal");
1309 if (literal.length() > 0) {
1310 if (literal.length() == 1) {
1311 appendInternal(new CharLiteralPrinterParser(literal.charAt(0)));
1312 } else {
1313 appendInternal(new StringLiteralPrinterParser(literal));
1314 }
1315 }
1316 return this;
1317 }
1318
1319 //-----------------------------------------------------------------------
1320 /**
1321 * Appends all the elements of a formatter to the builder.
1322 * <p>
1323 * This method has the same effect as appending each of the constituent
1324 * parts of the formatter directly to this builder.
1325 *
1326 * @param formatter the formatter to add, not null
1327 * @return this, for chaining, not null
1328 */
1329 public DateTimeFormatterBuilder append(DateTimeFormatter formatter) {
1330 Objects.requireNonNull(formatter, "formatter");
1331 appendInternal(formatter.toPrinterParser(false));
1332 return this;
1333 }
1334
1335 /**
1336 * Appends a formatter to the builder which will optionally format/parse.
1337 * <p>
1338 * This method has the same effect as appending each of the constituent
1339 * parts directly to this builder surrounded by an {@link #optionalStart()} and
1340 * {@link #optionalEnd()}.
1341 * <p>
1342 * The formatter will format if data is available for all the fields contained within it.
1343 * The formatter will parse if the string matches, otherwise no error is returned.
1344 *
1345 * @param formatter the formatter to add, not null
1346 * @return this, for chaining, not null
1347 */
1348 public DateTimeFormatterBuilder appendOptional(DateTimeFormatter formatter) {
1349 Objects.requireNonNull(formatter, "formatter");
1350 appendInternal(formatter.toPrinterParser(true));
1351 return this;
1352 }
1353
1354 //-----------------------------------------------------------------------
1355 /**
1356 * Appends the elements defined by the specified pattern to the builder.
1357 * <p>
1358 * All letters 'A' to 'Z' and 'a' to 'z' are reserved as pattern letters.
1359 * The characters '#', '{' and '}' are reserved for future use.
1360 * The characters '[' and ']' indicate optional patterns.
1361 * The following pattern letters are defined:
1362 * <pre>
1363 * Symbol Meaning Presentation Examples
1364 * ------ ------- ------------ -------
1365 * G era text AD; Anno Domini; A
1366 * u year year 2004; 04
1367 * y year-of-era year 2004; 04
1368 * D day-of-year number 189
1369 * M/L month-of-year number/text 7; 07; Jul; July; J
1370 * d day-of-month number 10
1371 *
1372 * Q/q quarter-of-year number/text 3; 03; Q3; 3rd quarter
1373 * Y week-based-year year 1996; 96
1374 * w week-of-week-based-year number 27
1375 * W week-of-month number 4
1376 * E day-of-week text Tue; Tuesday; T
1377 * e/c localized day-of-week number/text 2; 02; Tue; Tuesday; T
1378 * F week-of-month number 3
1379 *
1380 * a am-pm-of-day text PM
1381 * h clock-hour-of-am-pm (1-12) number 12
1382 * K hour-of-am-pm (0-11) number 0
1383 * k clock-hour-of-am-pm (1-24) number 0
1384 *
1385 * H hour-of-day (0-23) number 0
1386 * m minute-of-hour number 30
1387 * s second-of-minute number 55
1388 * S fraction-of-second fraction 978
1389 * A milli-of-day number 1234
1390 * n nano-of-second number 987654321
1391 * N nano-of-day number 1234000000
1392 *
1393 * V time-zone ID zone-id America/Los_Angeles; Z; -08:30
1394 * z time-zone name zone-name Pacific Standard Time; PST
1395 * O localized zone-offset offset-O GMT+8; GMT+08:00; UTC-08:00;
1396 * X zone-offset 'Z' for zero offset-X Z; -08; -0830; -08:30; -083015; -08:30:15;
1397 * x zone-offset offset-x +0000; -08; -0830; -08:30; -083015; -08:30:15;
1398 * Z zone-offset offset-Z +0000; -0800; -08:00;
1399 *
1400 * p pad next pad modifier 1
1401 *
1402 * ' escape for text delimiter
1403 * '' single quote literal '
1404 * [ optional section start
1405 * ] optional section end
1406 * # reserved for future use
1407 * { reserved for future use
1408 * } reserved for future use
1409 * </pre>
1410 * <p>
1411 * The count of pattern letters determine the format.
1412 * See <a href="DateTimeFormatter.html#patterns">DateTimeFormatter</a> for a user-focused description of the patterns.
1413 * The following tables define how the pattern letters map to the builder.
1414 * <p>
1415 * <b>Date fields</b>: Pattern letters to output a date.
1416 * <pre>
1417 * Pattern Count Equivalent builder methods
1418 * ------- ----- --------------------------
1419 * G 1 appendText(ChronoField.ERA, TextStyle.SHORT)
1420 * GG 2 appendText(ChronoField.ERA, TextStyle.SHORT)
1421 * GGG 3 appendText(ChronoField.ERA, TextStyle.SHORT)
1422 * GGGG 4 appendText(ChronoField.ERA, TextStyle.FULL)
1423 * GGGGG 5 appendText(ChronoField.ERA, TextStyle.NARROW)
1424 *
1425 * u 1 appendValue(ChronoField.YEAR, 1, 19, SignStyle.NORMAL);
1426 * uu 2 appendValueReduced(ChronoField.YEAR, 2, 2000);
1427 * uuu 3 appendValue(ChronoField.YEAR, 3, 19, SignStyle.NORMAL);
1428 * u..u 4..n appendValue(ChronoField.YEAR, n, 19, SignStyle.EXCEEDS_PAD);
1429 * y 1 appendValue(ChronoField.YEAR_OF_ERA, 1, 19, SignStyle.NORMAL);
1430 * yy 2 appendValueReduced(ChronoField.YEAR_OF_ERA, 2, 2000);
1431 * yyy 3 appendValue(ChronoField.YEAR_OF_ERA, 3, 19, SignStyle.NORMAL);
1432 * y..y 4..n appendValue(ChronoField.YEAR_OF_ERA, n, 19, SignStyle.EXCEEDS_PAD);
1433 * Y 1 append special localized WeekFields element for numeric week-based-year
1434 * YY 2 append special localized WeekFields element for reduced numeric week-based-year 2 digits;
1435 * YYY 3 append special localized WeekFields element for numeric week-based-year (3, 19, SignStyle.NORMAL);
1436 * Y..Y 4..n append special localized WeekFields element for numeric week-based-year (n, 19, SignStyle.EXCEEDS_PAD);
1437 *
1438 * Q 1 appendValue(IsoFields.QUARTER_OF_YEAR);
1439 * QQ 2 appendValue(IsoFields.QUARTER_OF_YEAR, 2);
1440 * QQQ 3 appendText(IsoFields.QUARTER_OF_YEAR, TextStyle.SHORT)
1441 * QQQQ 4 appendText(IsoFields.QUARTER_OF_YEAR, TextStyle.FULL)
1442 * QQQQQ 5 appendText(IsoFields.QUARTER_OF_YEAR, TextStyle.NARROW)
1443 * q 1 appendValue(IsoFields.QUARTER_OF_YEAR);
1444 * qq 2 appendValue(IsoFields.QUARTER_OF_YEAR, 2);
1445 * qqq 3 appendText(IsoFields.QUARTER_OF_YEAR, TextStyle.SHORT_STANDALONE)
1446 * qqqq 4 appendText(IsoFields.QUARTER_OF_YEAR, TextStyle.FULL_STANDALONE)
1447 * qqqqq 5 appendText(IsoFields.QUARTER_OF_YEAR, TextStyle.NARROW_STANDALONE)
1448 *
1449 * M 1 appendValue(ChronoField.MONTH_OF_YEAR);
1450 * MM 2 appendValue(ChronoField.MONTH_OF_YEAR, 2);
1451 * MMM 3 appendText(ChronoField.MONTH_OF_YEAR, TextStyle.SHORT)
1452 * MMMM 4 appendText(ChronoField.MONTH_OF_YEAR, TextStyle.FULL)
1453 * MMMMM 5 appendText(ChronoField.MONTH_OF_YEAR, TextStyle.NARROW)
1454 * L 1 appendValue(ChronoField.MONTH_OF_YEAR);
1455 * LL 2 appendValue(ChronoField.MONTH_OF_YEAR, 2);
1456 * LLL 3 appendText(ChronoField.MONTH_OF_YEAR, TextStyle.SHORT_STANDALONE)
1457 * LLLL 4 appendText(ChronoField.MONTH_OF_YEAR, TextStyle.FULL_STANDALONE)
1458 * LLLLL 5 appendText(ChronoField.MONTH_OF_YEAR, TextStyle.NARROW_STANDALONE)
1459 *
1460 * w 1 append special localized WeekFields element for numeric week-of-year
1461 * ww 2 append special localized WeekFields element for numeric week-of-year, zero-padded
1462 * W 1 append special localized WeekFields element for numeric week-of-month
1463 * d 1 appendValue(ChronoField.DAY_OF_MONTH)
1464 * dd 2 appendValue(ChronoField.DAY_OF_MONTH, 2)
1465 * D 1 appendValue(ChronoField.DAY_OF_YEAR)
1466 * DD 2 appendValue(ChronoField.DAY_OF_YEAR, 2)
1467 * DDD 3 appendValue(ChronoField.DAY_OF_YEAR, 3)
1468 * F 1 appendValue(ChronoField.ALIGNED_DAY_OF_WEEK_IN_MONTH)
1469 * E 1 appendText(ChronoField.DAY_OF_WEEK, TextStyle.SHORT)
1470 * EE 2 appendText(ChronoField.DAY_OF_WEEK, TextStyle.SHORT)
1471 * EEE 3 appendText(ChronoField.DAY_OF_WEEK, TextStyle.SHORT)
1472 * EEEE 4 appendText(ChronoField.DAY_OF_WEEK, TextStyle.FULL)
1473 * EEEEE 5 appendText(ChronoField.DAY_OF_WEEK, TextStyle.NARROW)
1474 * e 1 append special localized WeekFields element for numeric day-of-week
1475 * ee 2 append special localized WeekFields element for numeric day-of-week, zero-padded
1476 * eee 3 appendText(ChronoField.DAY_OF_WEEK, TextStyle.SHORT)
1477 * eeee 4 appendText(ChronoField.DAY_OF_WEEK, TextStyle.FULL)
1478 * eeeee 5 appendText(ChronoField.DAY_OF_WEEK, TextStyle.NARROW)
1479 * c 1 append special localized WeekFields element for numeric day-of-week
1480 * ccc 3 appendText(ChronoField.DAY_OF_WEEK, TextStyle.SHORT_STANDALONE)
1481 * cccc 4 appendText(ChronoField.DAY_OF_WEEK, TextStyle.FULL_STANDALONE)
1482 * ccccc 5 appendText(ChronoField.DAY_OF_WEEK, TextStyle.NARROW_STANDALONE)
1483 * </pre>
1484 * <p>
1485 * <b>Time fields</b>: Pattern letters to output a time.
1486 * <pre>
1487 * Pattern Count Equivalent builder methods
1488 * ------- ----- --------------------------
1489 * a 1 appendText(ChronoField.AMPM_OF_DAY, TextStyle.SHORT)
1490 * h 1 appendValue(ChronoField.CLOCK_HOUR_OF_AMPM)
1491 * hh 2 appendValue(ChronoField.CLOCK_HOUR_OF_AMPM, 2)
1492 * H 1 appendValue(ChronoField.HOUR_OF_DAY)
1493 * HH 2 appendValue(ChronoField.HOUR_OF_DAY, 2)
1494 * k 1 appendValue(ChronoField.CLOCK_HOUR_OF_DAY)
1495 * kk 2 appendValue(ChronoField.CLOCK_HOUR_OF_DAY, 2)
1496 * K 1 appendValue(ChronoField.HOUR_OF_AMPM)
1497 * KK 2 appendValue(ChronoField.HOUR_OF_AMPM, 2)
1498 * m 1 appendValue(ChronoField.MINUTE_OF_HOUR)
1499 * mm 2 appendValue(ChronoField.MINUTE_OF_HOUR, 2)
1500 * s 1 appendValue(ChronoField.SECOND_OF_MINUTE)
1501 * ss 2 appendValue(ChronoField.SECOND_OF_MINUTE, 2)
1502 *
1503 * S..S 1..n appendFraction(ChronoField.NANO_OF_SECOND, n, n, false)
1504 * A 1 appendValue(ChronoField.MILLI_OF_DAY)
1505 * A..A 2..n appendValue(ChronoField.MILLI_OF_DAY, n)
1506 * n 1 appendValue(ChronoField.NANO_OF_SECOND)
1507 * n..n 2..n appendValue(ChronoField.NANO_OF_SECOND, n)
1508 * N 1 appendValue(ChronoField.NANO_OF_DAY)
1509 * N..N 2..n appendValue(ChronoField.NANO_OF_DAY, n)
1510 * </pre>
1511 * <p>
1512 * <b>Zone ID</b>: Pattern letters to output {@code ZoneId}.
1513 * <pre>
1514 * Pattern Count Equivalent builder methods
1515 * ------- ----- --------------------------
1516 * VV 2 appendZoneId()
1517 * z 1 appendZoneText(TextStyle.SHORT)
1518 * zz 2 appendZoneText(TextStyle.SHORT)
1519 * zzz 3 appendZoneText(TextStyle.SHORT)
1520 * zzzz 4 appendZoneText(TextStyle.FULL)
1521 * </pre>
1522 * <p>
1523 * <b>Zone offset</b>: Pattern letters to output {@code ZoneOffset}.
1524 * <pre>
1525 * Pattern Count Equivalent builder methods
1526 * ------- ----- --------------------------
1527 * O 1 appendLocalizedOffsetPrefixed(TextStyle.SHORT);
1528 * OOOO 4 appendLocalizedOffsetPrefixed(TextStyle.FULL);
1529 * X 1 appendOffset("+HHmm","Z")
1530 * XX 2 appendOffset("+HHMM","Z")
1531 * XXX 3 appendOffset("+HH:MM","Z")
1532 * XXXX 4 appendOffset("+HHMMss","Z")
1533 * XXXXX 5 appendOffset("+HH:MM:ss","Z")
1534 * x 1 appendOffset("+HHmm","+00")
1535 * xx 2 appendOffset("+HHMM","+0000")
1536 * xxx 3 appendOffset("+HH:MM","+00:00")
1537 * xxxx 4 appendOffset("+HHMMss","+0000")
1538 * xxxxx 5 appendOffset("+HH:MM:ss","+00:00")
1539 * Z 1 appendOffset("+HHMM","+0000")
1540 * ZZ 2 appendOffset("+HHMM","+0000")
1541 * ZZZ 3 appendOffset("+HHMM","+0000")
1542 * ZZZZ 4 appendLocalizedOffset(TextStyle.FULL);
1543 * ZZZZZ 5 appendOffset("+HH:MM:ss","Z")
1544 * </pre>
1545 * <p>
1546 * <b>Modifiers</b>: Pattern letters that modify the rest of the pattern:
1547 * <pre>
1548 * Pattern Count Equivalent builder methods
1549 * ------- ----- --------------------------
1550 * [ 1 optionalStart()
1551 * ] 1 optionalEnd()
1552 * p..p 1..n padNext(n)
1553 * </pre>
1554 * <p>
1555 * Any sequence of letters not specified above, unrecognized letter or
1556 * reserved character will throw an exception.
1557 * Future versions may add to the set of patterns.
1558 * It is recommended to use single quotes around all characters that you want
1559 * to output directly to ensure that future changes do not break your application.
1560 * <p>
1561 * Note that the pattern string is similar, but not identical, to
1562 * {@link java.text.SimpleDateFormat SimpleDateFormat}.
1563 * The pattern string is also similar, but not identical, to that defined by the
1564 * Unicode Common Locale Data Repository (CLDR/LDML).
1565 * Pattern letters 'X' and 'u' are aligned with Unicode CLDR/LDML.
1566 * By contrast, {@code SimpleDateFormat} uses 'u' for the numeric day of week.
1567 * Pattern letters 'y' and 'Y' parse years of two digits and more than 4 digits differently.
1568 * Pattern letters 'n', 'A', 'N', and 'p' are added.
1569 * Number types will reject large numbers.
1570 *
1571 * @param pattern the pattern to add, not null
1572 * @return this, for chaining, not null
1573 * @throws IllegalArgumentException if the pattern is invalid
1574 */
1575 public DateTimeFormatterBuilder appendPattern(String pattern) {
1576 Objects.requireNonNull(pattern, "pattern");
1577 parsePattern(pattern);
1578 return this;
1579 }
1580
1581 private void parsePattern(String pattern) {
1582 for (int pos = 0; pos < pattern.length(); pos++) {
1583 char cur = pattern.charAt(pos);
1584 if ((cur >= 'A' && cur <= 'Z') || (cur >= 'a' && cur <= 'z')) {
1585 int start = pos++;
1586 for ( ; pos < pattern.length() && pattern.charAt(pos) == cur; pos++); // short loop
1587 int count = pos - start;
1588 // padding
1589 if (cur == 'p') {
1590 int pad = 0;
1591 if (pos < pattern.length()) {
1592 cur = pattern.charAt(pos);
1593 if ((cur >= 'A' && cur <= 'Z') || (cur >= 'a' && cur <= 'z')) {
1594 pad = count;
1595 start = pos++;
1596 for ( ; pos < pattern.length() && pattern.charAt(pos) == cur; pos++); // short loop
1597 count = pos - start;
1598 }
1599 }
1600 if (pad == 0) {
1601 throw new IllegalArgumentException(
1602 "Pad letter 'p' must be followed by valid pad pattern: " + pattern);
1603 }
1604 padNext(pad); // pad and continue parsing
1605 }
1606 // main rules
1607 TemporalField field = FIELD_MAP.get(cur);
1608 if (field != null) {
1609 parseField(cur, count, field);
1610 } else if (cur == 'z') {
1611 if (count > 4) {
1612 throw new IllegalArgumentException("Too many pattern letters: " + cur);
1613 } else if (count == 4) {
1614 appendZoneText(TextStyle.FULL);
1615 } else {
1616 appendZoneText(TextStyle.SHORT);
1617 }
1618 } else if (cur == 'V') {
1619 if (count != 2) {
1620 throw new IllegalArgumentException("Pattern letter count must be 2: " + cur);
1621 }
1622 appendZoneId();
1623 } else if (cur == 'Z') {
1624 if (count < 4) {
1625 appendOffset("+HHMM", "+0000");
1626 } else if (count == 4) {
1627 appendLocalizedOffset(TextStyle.FULL);
1628 } else if (count == 5) {
1629 appendOffset("+HH:MM:ss","Z");
1630 } else {
1631 throw new IllegalArgumentException("Too many pattern letters: " + cur);
1632 }
1633 } else if (cur == 'O') {
1634 if (count == 1) {
1635 appendLocalizedOffset(TextStyle.SHORT);
1636 } else if (count == 4) {
1637 appendLocalizedOffset(TextStyle.FULL);
1638 } else {
1639 throw new IllegalArgumentException("Pattern letter count must be 1 or 4: " + cur);
1640 }
1641 } else if (cur == 'X') {
1642 if (count > 5) {
1643 throw new IllegalArgumentException("Too many pattern letters: " + cur);
1644 }
1645 appendOffset(OffsetIdPrinterParser.PATTERNS[count + (count == 1 ? 0 : 1)], "Z");
1646 } else if (cur == 'x') {
1647 if (count > 5) {
1648 throw new IllegalArgumentException("Too many pattern letters: " + cur);
1649 }
1650 String zero = (count == 1 ? "+00" : (count % 2 == 0 ? "+0000" : "+00:00"));
1651 appendOffset(OffsetIdPrinterParser.PATTERNS[count + (count == 1 ? 0 : 1)], zero);
1652 } else if (cur == 'W') {
1653 // Fields defined by Locale
1654 if (count > 1) {
1655 throw new IllegalArgumentException("Too many pattern letters: " + cur);
1656 }
1657 appendInternal(new WeekBasedFieldPrinterParser(cur, count));
1658 } else if (cur == 'w') {
1659 // Fields defined by Locale
1660 if (count > 2) {
1661 throw new IllegalArgumentException("Too many pattern letters: " + cur);
1662 }
1663 appendInternal(new WeekBasedFieldPrinterParser(cur, count));
1664 } else if (cur == 'Y') {
1665 // Fields defined by Locale
1666 appendInternal(new WeekBasedFieldPrinterParser(cur, count));
1667 } else {
1668 throw new IllegalArgumentException("Unknown pattern letter: " + cur);
1669 }
1670 pos--;
1671
1672 } else if (cur == '\'') {
1673 // parse literals
1674 int start = pos++;
1675 for ( ; pos < pattern.length(); pos++) {
1676 if (pattern.charAt(pos) == '\'') {
1677 if (pos + 1 < pattern.length() && pattern.charAt(pos + 1) == '\'') {
1678 pos++;
1679 } else {
1680 break; // end of literal
1681 }
1682 }
1683 }
1684 if (pos >= pattern.length()) {
1685 throw new IllegalArgumentException("Pattern ends with an incomplete string literal: " + pattern);
1686 }
1687 String str = pattern.substring(start + 1, pos);
1688 if (str.length() == 0) {
1689 appendLiteral('\'');
1690 } else {
1691 appendLiteral(str.replace("''", "'"));
1692 }
1693
1694 } else if (cur == '[') {
1695 optionalStart();
1696
1697 } else if (cur == ']') {
1698 if (active.parent == null) {
1699 throw new IllegalArgumentException("Pattern invalid as it contains ] without previous [");
1700 }
1701 optionalEnd();
1702
1703 } else if (cur == '{' || cur == '}' || cur == '#') {
1704 throw new IllegalArgumentException("Pattern includes reserved character: '" + cur + "'");
1705 } else {
1706 appendLiteral(cur);
1707 }
1708 }
1709 }
1710
1711 @SuppressWarnings("fallthrough")
1712 private void parseField(char cur, int count, TemporalField field) {
1713 boolean standalone = false;
1714 switch (cur) {
1715 case 'u':
1716 case 'y':
1717 if (count == 2) {
1718 appendValueReduced(field, 2, 2, ReducedPrinterParser.BASE_DATE);
1719 } else if (count < 4) {
1720 appendValue(field, count, 19, SignStyle.NORMAL);
1721 } else {
1722 appendValue(field, count, 19, SignStyle.EXCEEDS_PAD);
1723 }
1724 break;
1725 case 'c':
1726 if (count == 2) {
1727 throw new IllegalArgumentException("Invalid pattern \"cc\"");
1728 }
1729 /*fallthrough*/
1730 case 'L':
1731 case 'q':
1732 standalone = true;
1733 /*fallthrough*/
1734 case 'M':
1735 case 'Q':
1736 case 'E':
1737 case 'e':
1738 switch (count) {
1739 case 1:
1740 case 2:
1741 if (cur == 'c' || cur == 'e') {
1742 appendInternal(new WeekBasedFieldPrinterParser(cur, count));
1743 } else if (cur == 'E') {
1744 appendText(field, TextStyle.SHORT);
1745 } else {
1746 if (count == 1) {
1747 appendValue(field);
1748 } else {
1749 appendValue(field, 2);
1750 }
1751 }
1752 break;
1753 case 3:
1754 appendText(field, standalone ? TextStyle.SHORT_STANDALONE : TextStyle.SHORT);
1755 break;
1756 case 4:
1757 appendText(field, standalone ? TextStyle.FULL_STANDALONE : TextStyle.FULL);
1758 break;
1759 case 5:
1760 appendText(field, standalone ? TextStyle.NARROW_STANDALONE : TextStyle.NARROW);
1761 break;
1762 default:
1763 throw new IllegalArgumentException("Too many pattern letters: " + cur);
1764 }
1765 break;
1766 case 'a':
1767 if (count == 1) {
1768 appendText(field, TextStyle.SHORT);
1769 } else {
1770 throw new IllegalArgumentException("Too many pattern letters: " + cur);
1771 }
1772 break;
1773 case 'G':
1774 switch (count) {
1775 case 1:
1776 case 2:
1777 case 3:
1778 appendText(field, TextStyle.SHORT);
1779 break;
1780 case 4:
1781 appendText(field, TextStyle.FULL);
1782 break;
1783 case 5:
1784 appendText(field, TextStyle.NARROW);
1785 break;
1786 default:
1787 throw new IllegalArgumentException("Too many pattern letters: " + cur);
1788 }
1789 break;
1790 case 'S':
1791 appendFraction(NANO_OF_SECOND, count, count, false);
1792 break;
1793 case 'F':
1794 if (count == 1) {
1795 appendValue(field);
1796 } else {
1797 throw new IllegalArgumentException("Too many pattern letters: " + cur);
1798 }
1799 break;
1800 case 'd':
1801 case 'h':
1802 case 'H':
1803 case 'k':
1804 case 'K':
1805 case 'm':
1806 case 's':
1807 if (count == 1) {
1808 appendValue(field);
1809 } else if (count == 2) {
1810 appendValue(field, count);
1811 } else {
1812 throw new IllegalArgumentException("Too many pattern letters: " + cur);
1813 }
1814 break;
1815 case 'D':
1816 if (count == 1) {
1817 appendValue(field);
1818 } else if (count <= 3) {
1819 appendValue(field, count);
1820 } else {
1821 throw new IllegalArgumentException("Too many pattern letters: " + cur);
1822 }
1823 break;
1824 default:
1825 if (count == 1) {
1826 appendValue(field);
1827 } else {
1828 appendValue(field, count);
1829 }
1830 break;
1831 }
1832 }
1833
1834 /** Map of letters to fields. */
1835 private static final Map<Character, TemporalField> FIELD_MAP = new HashMap<>();
1836 static {
1837 // SDF = SimpleDateFormat
1838 FIELD_MAP.put('G', ChronoField.ERA); // SDF, LDML (different to both for 1/2 chars)
1839 FIELD_MAP.put('y', ChronoField.YEAR_OF_ERA); // SDF, LDML
1840 FIELD_MAP.put('u', ChronoField.YEAR); // LDML (different in SDF)
1841 FIELD_MAP.put('Q', IsoFields.QUARTER_OF_YEAR); // LDML (removed quarter from 310)
1842 FIELD_MAP.put('q', IsoFields.QUARTER_OF_YEAR); // LDML (stand-alone)
1843 FIELD_MAP.put('M', ChronoField.MONTH_OF_YEAR); // SDF, LDML
1844 FIELD_MAP.put('L', ChronoField.MONTH_OF_YEAR); // SDF, LDML (stand-alone)
1845 FIELD_MAP.put('D', ChronoField.DAY_OF_YEAR); // SDF, LDML
1846 FIELD_MAP.put('d', ChronoField.DAY_OF_MONTH); // SDF, LDML
1847 FIELD_MAP.put('F', ChronoField.ALIGNED_DAY_OF_WEEK_IN_MONTH); // SDF, LDML
1848 FIELD_MAP.put('E', ChronoField.DAY_OF_WEEK); // SDF, LDML (different to both for 1/2 chars)
1849 FIELD_MAP.put('c', ChronoField.DAY_OF_WEEK); // LDML (stand-alone)
1850 FIELD_MAP.put('e', ChronoField.DAY_OF_WEEK); // LDML (needs localized week number)
1851 FIELD_MAP.put('a', ChronoField.AMPM_OF_DAY); // SDF, LDML
1852 FIELD_MAP.put('H', ChronoField.HOUR_OF_DAY); // SDF, LDML
1853 FIELD_MAP.put('k', ChronoField.CLOCK_HOUR_OF_DAY); // SDF, LDML
1854 FIELD_MAP.put('K', ChronoField.HOUR_OF_AMPM); // SDF, LDML
1855 FIELD_MAP.put('h', ChronoField.CLOCK_HOUR_OF_AMPM); // SDF, LDML
1856 FIELD_MAP.put('m', ChronoField.MINUTE_OF_HOUR); // SDF, LDML
1857 FIELD_MAP.put('s', ChronoField.SECOND_OF_MINUTE); // SDF, LDML
1858 FIELD_MAP.put('S', ChronoField.NANO_OF_SECOND); // LDML (SDF uses milli-of-second number)
1859 FIELD_MAP.put('A', ChronoField.MILLI_OF_DAY); // LDML
1860 FIELD_MAP.put('n', ChronoField.NANO_OF_SECOND); // 310 (proposed for LDML)
1861 FIELD_MAP.put('N', ChronoField.NANO_OF_DAY); // 310 (proposed for LDML)
1862 // 310 - z - time-zone names, matches LDML and SimpleDateFormat 1 to 4
1863 // 310 - Z - matches SimpleDateFormat and LDML
1864 // 310 - V - time-zone id, matches LDML
1865 // 310 - p - prefix for padding
1866 // 310 - X - matches LDML, almost matches SDF for 1, exact match 2&3, extended 4&5
1867 // 310 - x - matches LDML
1868 // 310 - w, W, and Y are localized forms matching LDML
1869 // LDML - U - cycle year name, not supported by 310 yet
1870 // LDML - l - deprecated
1871 // LDML - j - not relevant
1872 // LDML - g - modified-julian-day
1873 // LDML - v,V - extended time-zone names
1874 }
1875
1876 //-----------------------------------------------------------------------
1877 /**
1878 * Causes the next added printer/parser to pad to a fixed width using a space.
1879 * <p>
1880 * This padding will pad to a fixed width using spaces.
1881 * <p>
1882 * During formatting, the decorated element will be output and then padded
1883 * to the specified width. An exception will be thrown during formatting if
1884 * the pad width is exceeded.
1885 * <p>
1886 * During parsing, the padding and decorated element are parsed.
1887 * If parsing is lenient, then the pad width is treated as a maximum.
1888 * The padding is parsed greedily. Thus, if the decorated element starts with
1889 * the pad character, it will not be parsed.
1890 *
1891 * @param padWidth the pad width, 1 or greater
1892 * @return this, for chaining, not null
1893 * @throws IllegalArgumentException if pad width is too small
1894 */
1895 public DateTimeFormatterBuilder padNext(int padWidth) {
1896 return padNext(padWidth, ' ');
1897 }
1898
1899 /**
1900 * Causes the next added printer/parser to pad to a fixed width.
1901 * <p>
1902 * This padding is intended for padding other than zero-padding.
1903 * Zero-padding should be achieved using the appendValue methods.
1904 * <p>
1905 * During formatting, the decorated element will be output and then padded
1906 * to the specified width. An exception will be thrown during formatting if
1907 * the pad width is exceeded.
1908 * <p>
1909 * During parsing, the padding and decorated element are parsed.
1910 * If parsing is lenient, then the pad width is treated as a maximum.
1911 * If parsing is case insensitive, then the pad character is matched ignoring case.
1912 * The padding is parsed greedily. Thus, if the decorated element starts with
1913 * the pad character, it will not be parsed.
1914 *
1915 * @param padWidth the pad width, 1 or greater
1916 * @param padChar the pad character
1917 * @return this, for chaining, not null
1918 * @throws IllegalArgumentException if pad width is too small
1919 */
1920 public DateTimeFormatterBuilder padNext(int padWidth, char padChar) {
1921 if (padWidth < 1) {
1922 throw new IllegalArgumentException("The pad width must be at least one but was " + padWidth);
1923 }
1924 active.padNextWidth = padWidth;
1925 active.padNextChar = padChar;
1926 active.valueParserIndex = -1;
1927 return this;
1928 }
1929
1930 //-----------------------------------------------------------------------
1931 /**
1932 * Mark the start of an optional section.
1933 * <p>
1934 * The output of formatting can include optional sections, which may be nested.
1935 * An optional section is started by calling this method and ended by calling
1936 * {@link #optionalEnd()} or by ending the build process.
1937 * <p>
1938 * All elements in the optional section are treated as optional.
1939 * During formatting, the section is only output if data is available in the
1940 * {@code TemporalAccessor} for all the elements in the section.
1941 * During parsing, the whole section may be missing from the parsed string.
1942 * <p>
1943 * For example, consider a builder setup as
1944 * {@code builder.appendValue(HOUR_OF_DAY,2).optionalStart().appendValue(MINUTE_OF_HOUR,2)}.
1945 * The optional section ends automatically at the end of the builder.
1946 * During formatting, the minute will only be output if its value can be obtained from the date-time.
1947 * During parsing, the input will be successfully parsed whether the minute is present or not.
1948 *
1949 * @return this, for chaining, not null
1950 */
1951 public DateTimeFormatterBuilder optionalStart() {
1952 active.valueParserIndex = -1;
1953 active = new DateTimeFormatterBuilder(active, true);
1954 return this;
1955 }
1956
1957 /**
1958 * Ends an optional section.
1959 * <p>
1960 * The output of formatting can include optional sections, which may be nested.
1961 * An optional section is started by calling {@link #optionalStart()} and ended
1962 * using this method (or at the end of the builder).
1963 * <p>
1964 * Calling this method without having previously called {@code optionalStart}
1965 * will throw an exception.
1966 * Calling this method immediately after calling {@code optionalStart} has no effect
1967 * on the formatter other than ending the (empty) optional section.
1968 * <p>
1969 * All elements in the optional section are treated as optional.
1970 * During formatting, the section is only output if data is available in the
1971 * {@code TemporalAccessor} for all the elements in the section.
1972 * During parsing, the whole section may be missing from the parsed string.
1973 * <p>
1974 * For example, consider a builder setup as
1975 * {@code builder.appendValue(HOUR_OF_DAY,2).optionalStart().appendValue(MINUTE_OF_HOUR,2).optionalEnd()}.
1976 * During formatting, the minute will only be output if its value can be obtained from the date-time.
1977 * During parsing, the input will be successfully parsed whether the minute is present or not.
1978 *
1979 * @return this, for chaining, not null
1980 * @throws IllegalStateException if there was no previous call to {@code optionalStart}
1981 */
1982 public DateTimeFormatterBuilder optionalEnd() {
1983 if (active.parent == null) {
1984 throw new IllegalStateException("Cannot call optionalEnd() as there was no previous call to optionalStart()");
1985 }
1986 if (active.printerParsers.size() > 0) {
1987 CompositePrinterParser cpp = new CompositePrinterParser(active.printerParsers, active.optional);
1988 active = active.parent;
1989 appendInternal(cpp);
1990 } else {
1991 active = active.parent;
1992 }
1993 return this;
1994 }
1995
1996 //-----------------------------------------------------------------------
1997 /**
1998 * Appends a printer and/or parser to the internal list handling padding.
1999 *
2000 * @param pp the printer-parser to add, not null
2001 * @return the index into the active parsers list
2002 */
2003 private int appendInternal(DateTimePrinterParser pp) {
2004 Objects.requireNonNull(pp, "pp");
2005 if (active.padNextWidth > 0) {
2006 if (pp != null) {
2007 pp = new PadPrinterParserDecorator(pp, active.padNextWidth, active.padNextChar);
2008 }
2009 active.padNextWidth = 0;
2010 active.padNextChar = 0;
2011 }
2012 active.printerParsers.add(pp);
2013 active.valueParserIndex = -1;
2014 return active.printerParsers.size() - 1;
2015 }
2016
2017 //-----------------------------------------------------------------------
2018 /**
2019 * Completes this builder by creating the {@code DateTimeFormatter}
2020 * using the default locale.
2021 * <p>
2022 * This will create a formatter with the {@linkplain Locale#getDefault(Locale.Category) default FORMAT locale}.
2023 * Numbers will be printed and parsed using the standard DecimalStyle.
2024 * The resolver style will be {@link ResolverStyle#SMART SMART}.
2025 * <p>
2026 * Calling this method will end any open optional sections by repeatedly
2027 * calling {@link #optionalEnd()} before creating the formatter.
2028 * <p>
2029 * This builder can still be used after creating the formatter if desired,
2030 * although the state may have been changed by calls to {@code optionalEnd}.
2031 *
2032 * @return the created formatter, not null
2033 */
2034 public DateTimeFormatter toFormatter() {
2035 return toFormatter(Locale.getDefault(Locale.Category.FORMAT));
2036 }
2037
2038 /**
2039 * Completes this builder by creating the {@code DateTimeFormatter}
2040 * using the specified locale.
2041 * <p>
2042 * This will create a formatter with the specified locale.
2043 * Numbers will be printed and parsed using the standard DecimalStyle.
2044 * The resolver style will be {@link ResolverStyle#SMART SMART}.
2045 * <p>
2046 * Calling this method will end any open optional sections by repeatedly
2047 * calling {@link #optionalEnd()} before creating the formatter.
2048 * <p>
2049 * This builder can still be used after creating the formatter if desired,
2050 * although the state may have been changed by calls to {@code optionalEnd}.
2051 *
2052 * @param locale the locale to use for formatting, not null
2053 * @return the created formatter, not null
2054 */
2055 public DateTimeFormatter toFormatter(Locale locale) {
2056 return toFormatter(locale, ResolverStyle.SMART, null);
2057 }
2058
2059 /**
2060 * Completes this builder by creating the formatter.
2061 * This uses the default locale.
2062 *
2063 * @param resolverStyle the resolver style to use, not null
2064 * @return the created formatter, not null
2065 */
2066 DateTimeFormatter toFormatter(ResolverStyle resolverStyle, Chronology chrono) {
2067 return toFormatter(Locale.getDefault(Locale.Category.FORMAT), resolverStyle, chrono);
2068 }
2069
2070 /**
2071 * Completes this builder by creating the formatter.
2072 *
2073 * @param locale the locale to use for formatting, not null
2074 * @param chrono the chronology to use, may be null
2075 * @return the created formatter, not null
2076 */
2077 private DateTimeFormatter toFormatter(Locale locale, ResolverStyle resolverStyle, Chronology chrono) {
2078 Objects.requireNonNull(locale, "locale");
2079 while (active.parent != null) {
2080 optionalEnd();
2081 }
2082 CompositePrinterParser pp = new CompositePrinterParser(printerParsers, false);
2083 return new DateTimeFormatter(pp, locale, DecimalStyle.STANDARD,
2084 resolverStyle, null, chrono, null);
2085 }
2086
2087 //-----------------------------------------------------------------------
2088 /**
2089 * Strategy for formatting/parsing date-time information.
2090 * <p>
2091 * The printer may format any part, or the whole, of the input date-time object.
2092 * Typically, a complete format is constructed from a number of smaller
2093 * units, each outputting a single field.
2094 * <p>
2095 * The parser may parse any piece of text from the input, storing the result
2096 * in the context. Typically, each individual parser will just parse one
2097 * field, such as the day-of-month, storing the value in the context.
2098 * Once the parse is complete, the caller will then resolve the parsed values
2099 * to create the desired object, such as a {@code LocalDate}.
2100 * <p>
2101 * The parse position will be updated during the parse. Parsing will start at
2102 * the specified index and the return value specifies the new parse position
2103 * for the next parser. If an error occurs, the returned index will be negative
2104 * and will have the error position encoded using the complement operator.
2105 *
2106 * @implSpec
2107 * This interface must be implemented with care to ensure other classes operate correctly.
2108 * All implementations that can be instantiated must be final, immutable and thread-safe.
2109 * <p>
2110 * The context is not a thread-safe object and a new instance will be created
2111 * for each format that occurs. The context must not be stored in an instance
2112 * variable or shared with any other threads.
2113 */
2114 interface DateTimePrinterParser {
2115
2116 /**
2117 * Prints the date-time object to the buffer.
2118 * <p>
2119 * The context holds information to use during the format.
2120 * It also contains the date-time information to be printed.
2121 * <p>
2122 * The buffer must not be mutated beyond the content controlled by the implementation.
2123 *
2124 * @param context the context to format using, not null
2125 * @param buf the buffer to append to, not null
2126 * @return false if unable to query the value from the date-time, true otherwise
2127 * @throws DateTimeException if the date-time cannot be printed successfully
2128 */
2129 boolean format(DateTimePrintContext context, StringBuilder buf);
2130
2131 /**
2132 * Parses text into date-time information.
2133 * <p>
2134 * The context holds information to use during the parse.
2135 * It is also used to store the parsed date-time information.
2136 *
2137 * @param context the context to use and parse into, not null
2138 * @param text the input text to parse, not null
2139 * @param position the position to start parsing at, from 0 to the text length
2140 * @return the new parse position, where negative means an error with the
2141 * error position encoded using the complement ~ operator
2142 * @throws NullPointerException if the context or text is null
2143 * @throws IndexOutOfBoundsException if the position is invalid
2144 */
2145 int parse(DateTimeParseContext context, CharSequence text, int position);
2146 }
2147
2148 //-----------------------------------------------------------------------
2149 /**
2150 * Composite printer and parser.
2151 */
2152 static final class CompositePrinterParser implements DateTimePrinterParser {
2153 private final DateTimePrinterParser[] printerParsers;
2154 private final boolean optional;
2155
2156 CompositePrinterParser(List<DateTimePrinterParser> printerParsers, boolean optional) {
2157 this(printerParsers.toArray(new DateTimePrinterParser[printerParsers.size()]), optional);
2158 }
2159
2160 CompositePrinterParser(DateTimePrinterParser[] printerParsers, boolean optional) {
2161 this.printerParsers = printerParsers;
2162 this.optional = optional;
2163 }
2164
2165 /**
2166 * Returns a copy of this printer-parser with the optional flag changed.
2167 *
2168 * @param optional the optional flag to set in the copy
2169 * @return the new printer-parser, not null
2170 */
2171 public CompositePrinterParser withOptional(boolean optional) {
2172 if (optional == this.optional) {
2173 return this;
2174 }
2175 return new CompositePrinterParser(printerParsers, optional);
2176 }
2177
2178 @Override
2179 public boolean format(DateTimePrintContext context, StringBuilder buf) {
2180 int length = buf.length();
2181 if (optional) {
2182 context.startOptional();
2183 }
2184 try {
2185 for (DateTimePrinterParser pp : printerParsers) {
2186 if (pp.format(context, buf) == false) {
2187 buf.setLength(length); // reset buffer
2188 return true;
2189 }
2190 }
2191 } finally {
2192 if (optional) {
2193 context.endOptional();
2194 }
2195 }
2196 return true;
2197 }
2198
2199 @Override
2200 public int parse(DateTimeParseContext context, CharSequence text, int position) {
2201 if (optional) {
2202 context.startOptional();
2203 int pos = position;
2204 for (DateTimePrinterParser pp : printerParsers) {
2205 pos = pp.parse(context, text, pos);
2206 if (pos < 0) {
2207 context.endOptional(false);
2208 return position; // return original position
2209 }
2210 }
2211 context.endOptional(true);
2212 return pos;
2213 } else {
2214 for (DateTimePrinterParser pp : printerParsers) {
2215 position = pp.parse(context, text, position);
2216 if (position < 0) {
2217 break;
2218 }
2219 }
2220 return position;
2221 }
2222 }
2223
2224 @Override
2225 public String toString() {
2226 StringBuilder buf = new StringBuilder();
2227 if (printerParsers != null) {
2228 buf.append(optional ? "[" : "(");
2229 for (DateTimePrinterParser pp : printerParsers) {
2230 buf.append(pp);
2231 }
2232 buf.append(optional ? "]" : ")");
2233 }
2234 return buf.toString();
2235 }
2236 }
2237
2238 //-----------------------------------------------------------------------
2239 /**
2240 * Pads the output to a fixed width.
2241 */
2242 static final class PadPrinterParserDecorator implements DateTimePrinterParser {
2243 private final DateTimePrinterParser printerParser;
2244 private final int padWidth;
2245 private final char padChar;
2246
2247 /**
2248 * Constructor.
2249 *
2250 * @param printerParser the printer, not null
2251 * @param padWidth the width to pad to, 1 or greater
2252 * @param padChar the pad character
2253 */
2254 PadPrinterParserDecorator(DateTimePrinterParser printerParser, int padWidth, char padChar) {
2255 // input checked by DateTimeFormatterBuilder
2256 this.printerParser = printerParser;
2257 this.padWidth = padWidth;
2258 this.padChar = padChar;
2259 }
2260
2261 @Override
2262 public boolean format(DateTimePrintContext context, StringBuilder buf) {
2263 int preLen = buf.length();
2264 if (printerParser.format(context, buf) == false) {
2265 return false;
2266 }
2267 int len = buf.length() - preLen;
2268 if (len > padWidth) {
2269 throw new DateTimeException(
2270 "Cannot print as output of " + len + " characters exceeds pad width of " + padWidth);
2271 }
2272 for (int i = 0; i < padWidth - len; i++) {
2273 buf.insert(preLen, padChar);
2274 }
2275 return true;
2276 }
2277
2278 @Override
2279 public int parse(DateTimeParseContext context, CharSequence text, int position) {
2280 // cache context before changed by decorated parser
2281 final boolean strict = context.isStrict();
2282 // parse
2283 if (position > text.length()) {
2284 throw new IndexOutOfBoundsException();
2285 }
2286 if (position == text.length()) {
2287 return ~position; // no more characters in the string
2288 }
2289 int endPos = position + padWidth;
2290 if (endPos > text.length()) {
2291 if (strict) {
2292 return ~position; // not enough characters in the string to meet the parse width
2293 }
2294 endPos = text.length();
2295 }
2296 int pos = position;
2297 while (pos < endPos && context.charEquals(text.charAt(pos), padChar)) {
2298 pos++;
2299 }
2300 text = text.subSequence(0, endPos);
2301 int resultPos = printerParser.parse(context, text, pos);
2302 if (resultPos != endPos && strict) {
2303 return ~(position + pos); // parse of decorated field didn't parse to the end
2304 }
2305 return resultPos;
2306 }
2307
2308 @Override
2309 public String toString() {
2310 return "Pad(" + printerParser + "," + padWidth + (padChar == ' ' ? ")" : ",'" + padChar + "')");
2311 }
2312 }
2313
2314 //-----------------------------------------------------------------------
2315 /**
2316 * Enumeration to apply simple parse settings.
2317 */
2318 static enum SettingsParser implements DateTimePrinterParser {
2319 SENSITIVE,
2320 INSENSITIVE,
2321 STRICT,
2322 LENIENT;
2323
2324 @Override
2325 public boolean format(DateTimePrintContext context, StringBuilder buf) {
2326 return true; // nothing to do here
2327 }
2328
2329 @Override
2330 public int parse(DateTimeParseContext context, CharSequence text, int position) {
2331 // using ordinals to avoid javac synthetic inner class
2332 switch (ordinal()) {
2333 case 0: context.setCaseSensitive(true); break;
2334 case 1: context.setCaseSensitive(false); break;
2335 case 2: context.setStrict(true); break;
2336 case 3: context.setStrict(false); break;
2337 }
2338 return position;
2339 }
2340
2341 @Override
2342 public String toString() {
2343 // using ordinals to avoid javac synthetic inner class
2344 switch (ordinal()) {
2345 case 0: return "ParseCaseSensitive(true)";
2346 case 1: return "ParseCaseSensitive(false)";
2347 case 2: return "ParseStrict(true)";
2348 case 3: return "ParseStrict(false)";
2349 }
2350 throw new IllegalStateException("Unreachable");
2351 }
2352 }
2353
2354 //-----------------------------------------------------------------------
2355 /**
2356 * Defaults a value into the parse if not currently present.
2357 */
2358 static class DefaultValueParser implements DateTimePrinterParser {
2359 private final TemporalField field;
2360 private final long value;
2361
2362 DefaultValueParser(TemporalField field, long value) {
2363 this.field = field;
2364 this.value = value;
2365 }
2366
2367 public boolean format(DateTimePrintContext context, StringBuilder buf) {
2368 return true;
2369 }
2370
2371 public int parse(DateTimeParseContext context, CharSequence text, int position) {
2372 if (context.getParsed(field) == null) {
2373 context.setParsedField(field, value, position, position);
2374 }
2375 return position;
2376 }
2377 }
2378
2379 //-----------------------------------------------------------------------
2380 /**
2381 * Prints or parses a character literal.
2382 */
2383 static final class CharLiteralPrinterParser implements DateTimePrinterParser {
2384 private final char literal;
2385
2386 CharLiteralPrinterParser(char literal) {
2387 this.literal = literal;
2388 }
2389
2390 @Override
2391 public boolean format(DateTimePrintContext context, StringBuilder buf) {
2392 buf.append(literal);
2393 return true;
2394 }
2395
2396 @Override
2397 public int parse(DateTimeParseContext context, CharSequence text, int position) {
2398 int length = text.length();
2399 if (position == length) {
2400 return ~position;
2401 }
2402 char ch = text.charAt(position);
2403 if (ch != literal) {
2404 if (context.isCaseSensitive() ||
2405 (Character.toUpperCase(ch) != Character.toUpperCase(literal) &&
2406 Character.toLowerCase(ch) != Character.toLowerCase(literal))) {
2407 return ~position;
2408 }
2409 }
2410 return position + 1;
2411 }
2412
2413 @Override
2414 public String toString() {
2415 if (literal == '\'') {
2416 return "''";
2417 }
2418 return "'" + literal + "'";
2419 }
2420 }
2421
2422 //-----------------------------------------------------------------------
2423 /**
2424 * Prints or parses a string literal.
2425 */
2426 static final class StringLiteralPrinterParser implements DateTimePrinterParser {
2427 private final String literal;
2428
2429 StringLiteralPrinterParser(String literal) {
2430 this.literal = literal; // validated by caller
2431 }
2432
2433 @Override
2434 public boolean format(DateTimePrintContext context, StringBuilder buf) {
2435 buf.append(literal);
2436 return true;
2437 }
2438
2439 @Override
2440 public int parse(DateTimeParseContext context, CharSequence text, int position) {
2441 int length = text.length();
2442 if (position > length || position < 0) {
2443 throw new IndexOutOfBoundsException();
2444 }
2445 if (context.subSequenceEquals(text, position, literal, 0, literal.length()) == false) {
2446 return ~position;
2447 }
2448 return position + literal.length();
2449 }
2450
2451 @Override
2452 public String toString() {
2453 String converted = literal.replace("'", "''");
2454 return "'" + converted + "'";
2455 }
2456 }
2457
2458 //-----------------------------------------------------------------------
2459 /**
2460 * Prints and parses a numeric date-time field with optional padding.
2461 */
2462 static class NumberPrinterParser implements DateTimePrinterParser {
2463
2464 /**
2465 * Array of 10 to the power of n.
2466 */
2467 static final long[] EXCEED_POINTS = new long[] {
2468 0L,
2469 10L,
2470 100L,
2471 1000L,
2472 10000L,
2473 100000L,
2474 1000000L,
2475 10000000L,
2476 100000000L,
2477 1000000000L,
2478 10000000000L,
2479 };
2480
2481 final TemporalField field;
2482 final int minWidth;
2483 final int maxWidth;
2484 private final SignStyle signStyle;
2485 final int subsequentWidth;
2486
2487 /**
2488 * Constructor.
2489 *
2490 * @param field the field to format, not null
2491 * @param minWidth the minimum field width, from 1 to 19
2492 * @param maxWidth the maximum field width, from minWidth to 19
2493 * @param signStyle the positive/negative sign style, not null
2494 */
2495 NumberPrinterParser(TemporalField field, int minWidth, int maxWidth, SignStyle signStyle) {
2496 // validated by caller
2497 this.field = field;
2498 this.minWidth = minWidth;
2499 this.maxWidth = maxWidth;
2500 this.signStyle = signStyle;
2501 this.subsequentWidth = 0;
2502 }
2503
2504 /**
2505 * Constructor.
2506 *
2507 * @param field the field to format, not null
2508 * @param minWidth the minimum field width, from 1 to 19
2509 * @param maxWidth the maximum field width, from minWidth to 19
2510 * @param signStyle the positive/negative sign style, not null
2511 * @param subsequentWidth the width of subsequent non-negative numbers, 0 or greater,
2512 * -1 if fixed width due to active adjacent parsing
2513 */
2514 protected NumberPrinterParser(TemporalField field, int minWidth, int maxWidth, SignStyle signStyle, int subsequentWidth) {
2515 // validated by caller
2516 this.field = field;
2517 this.minWidth = minWidth;
2518 this.maxWidth = maxWidth;
2519 this.signStyle = signStyle;
2520 this.subsequentWidth = subsequentWidth;
2521 }
2522
2523 /**
2524 * Returns a new instance with fixed width flag set.
2525 *
2526 * @return a new updated printer-parser, not null
2527 */
2528 NumberPrinterParser withFixedWidth() {
2529 if (subsequentWidth == -1) {
2530 return this;
2531 }
2532 return new NumberPrinterParser(field, minWidth, maxWidth, signStyle, -1);
2533 }
2534
2535 /**
2536 * Returns a new instance with an updated subsequent width.
2537 *
2538 * @param subsequentWidth the width of subsequent non-negative numbers, 0 or greater
2539 * @return a new updated printer-parser, not null
2540 */
2541 NumberPrinterParser withSubsequentWidth(int subsequentWidth) {
2542 return new NumberPrinterParser(field, minWidth, maxWidth, signStyle, this.subsequentWidth + subsequentWidth);
2543 }
2544
2545 @Override
2546 public boolean format(DateTimePrintContext context, StringBuilder buf) {
2547 Long valueLong = context.getValue(field);
2548 if (valueLong == null) {
2549 return false;
2550 }
2551 long value = getValue(context, valueLong);
2552 DecimalStyle decimalStyle = context.getDecimalStyle();
2553 String str = (value == Long.MIN_VALUE ? "9223372036854775808" : Long.toString(Math.abs(value)));
2554 if (str.length() > maxWidth) {
2555 throw new DateTimeException("Field " + field +
2556 " cannot be printed as the value " + value +
2557 " exceeds the maximum print width of " + maxWidth);
2558 }
2559 str = decimalStyle.convertNumberToI18N(str);
2560
2561 if (value >= 0) {
2562 switch (signStyle) {
2563 case EXCEEDS_PAD:
2564 if (minWidth < 19 && value >= EXCEED_POINTS[minWidth]) {
2565 buf.append(decimalStyle.getPositiveSign());
2566 }
2567 break;
2568 case ALWAYS:
2569 buf.append(decimalStyle.getPositiveSign());
2570 break;
2571 }
2572 } else {
2573 switch (signStyle) {
2574 case NORMAL:
2575 case EXCEEDS_PAD:
2576 case ALWAYS:
2577 buf.append(decimalStyle.getNegativeSign());
2578 break;
2579 case NOT_NEGATIVE:
2580 throw new DateTimeException("Field " + field +
2581 " cannot be printed as the value " + value +
2582 " cannot be negative according to the SignStyle");
2583 }
2584 }
2585 for (int i = 0; i < minWidth - str.length(); i++) {
2586 buf.append(decimalStyle.getZeroDigit());
2587 }
2588 buf.append(str);
2589 return true;
2590 }
2591
2592 /**
2593 * Gets the value to output.
2594 *
2595 * @param context the context
2596 * @param value the value of the field, not null
2597 * @return the value
2598 */
2599 long getValue(DateTimePrintContext context, long value) {
2600 return value;
2601 }
2602
2603 /**
2604 * For NumberPrinterParser, the width is fixed depending on the
2605 * minWidth, maxWidth, signStyle and whether subsequent fields are fixed.
2606 * @param context the context
2607 * @return true if the field is fixed width
2608 * @see DateTimeFormatterBuilder#appendValue(java.time.temporal.TemporalField, int)
2609 */
2610 boolean isFixedWidth(DateTimeParseContext context) {
2611 return subsequentWidth == -1 ||
2612 (subsequentWidth > 0 && minWidth == maxWidth && signStyle == SignStyle.NOT_NEGATIVE);
2613 }
2614
2615 @Override
2616 public int parse(DateTimeParseContext context, CharSequence text, int position) {
2617 int length = text.length();
2618 if (position == length) {
2619 return ~position;
2620 }
2621 char sign = text.charAt(position); // IOOBE if invalid position
2622 boolean negative = false;
2623 boolean positive = false;
2624 if (sign == context.getDecimalStyle().getPositiveSign()) {
2625 if (signStyle.parse(true, context.isStrict(), minWidth == maxWidth) == false) {
2626 return ~position;
2627 }
2628 positive = true;
2629 position++;
2630 } else if (sign == context.getDecimalStyle().getNegativeSign()) {
2631 if (signStyle.parse(false, context.isStrict(), minWidth == maxWidth) == false) {
2632 return ~position;
2633 }
2634 negative = true;
2635 position++;
2636 } else {
2637 if (signStyle == SignStyle.ALWAYS && context.isStrict()) {
2638 return ~position;
2639 }
2640 }
2641 int effMinWidth = (context.isStrict() || isFixedWidth(context) ? minWidth : 1);
2642 int minEndPos = position + effMinWidth;
2643 if (minEndPos > length) {
2644 return ~position;
2645 }
2646 int effMaxWidth = (context.isStrict() || isFixedWidth(context) ? maxWidth : 9) + Math.max(subsequentWidth, 0);
2647 long total = 0;
2648 BigInteger totalBig = null;
2649 int pos = position;
2650 for (int pass = 0; pass < 2; pass++) {
2651 int maxEndPos = Math.min(pos + effMaxWidth, length);
2652 while (pos < maxEndPos) {
2653 char ch = text.charAt(pos++);
2654 int digit = context.getDecimalStyle().convertToDigit(ch);
2655 if (digit < 0) {
2656 pos--;
2657 if (pos < minEndPos) {
2658 return ~position; // need at least min width digits
2659 }
2660 break;
2661 }
2662 if ((pos - position) > 18) {
2663 if (totalBig == null) {
2664 totalBig = BigInteger.valueOf(total);
2665 }
2666 totalBig = totalBig.multiply(BigInteger.TEN).add(BigInteger.valueOf(digit));
2667 } else {
2668 total = total * 10 + digit;
2669 }
2670 }
2671 if (subsequentWidth > 0 && pass == 0) {
2672 // re-parse now we know the correct width
2673 int parseLen = pos - position;
2674 effMaxWidth = Math.max(effMinWidth, parseLen - subsequentWidth);
2675 pos = position;
2676 total = 0;
2677 totalBig = null;
2678 } else {
2679 break;
2680 }
2681 }
2682 if (negative) {
2683 if (totalBig != null) {
2684 if (totalBig.equals(BigInteger.ZERO) && context.isStrict()) {
2685 return ~(position - 1); // minus zero not allowed
2686 }
2687 totalBig = totalBig.negate();
2688 } else {
2689 if (total == 0 && context.isStrict()) {
2690 return ~(position - 1); // minus zero not allowed
2691 }
2692 total = -total;
2693 }
2694 } else if (signStyle == SignStyle.EXCEEDS_PAD && context.isStrict()) {
2695 int parseLen = pos - position;
2696 if (positive) {
2697 if (parseLen <= minWidth) {
2698 return ~(position - 1); // '+' only parsed if minWidth exceeded
2699 }
2700 } else {
2701 if (parseLen > minWidth) {
2702 return ~position; // '+' must be parsed if minWidth exceeded
2703 }
2704 }
2705 }
2706 if (totalBig != null) {
2707 if (totalBig.bitLength() > 63) {
2708 // overflow, parse 1 less digit
2709 totalBig = totalBig.divide(BigInteger.TEN);
2710 pos--;
2711 }
2712 return setValue(context, totalBig.longValue(), position, pos);
2713 }
2714 return setValue(context, total, position, pos);
2715 }
2716
2717 /**
2718 * Stores the value.
2719 *
2720 * @param context the context to store into, not null
2721 * @param value the value
2722 * @param errorPos the position of the field being parsed
2723 * @param successPos the position after the field being parsed
2724 * @return the new position
2725 */
2726 int setValue(DateTimeParseContext context, long value, int errorPos, int successPos) {
2727 return context.setParsedField(field, value, errorPos, successPos);
2728 }
2729
2730 @Override
2731 public String toString() {
2732 if (minWidth == 1 && maxWidth == 19 && signStyle == SignStyle.NORMAL) {
2733 return "Value(" + field + ")";
2734 }
2735 if (minWidth == maxWidth && signStyle == SignStyle.NOT_NEGATIVE) {
2736 return "Value(" + field + "," + minWidth + ")";
2737 }
2738 return "Value(" + field + "," + minWidth + "," + maxWidth + "," + signStyle + ")";
2739 }
2740 }
2741
2742 //-----------------------------------------------------------------------
2743 /**
2744 * Prints and parses a reduced numeric date-time field.
2745 */
2746 static final class ReducedPrinterParser extends NumberPrinterParser {
2747 /**
2748 * The base date for reduced value parsing.
2749 */
2750 static final LocalDate BASE_DATE = LocalDate.of(2000, 1, 1);
2751
2752 private final int baseValue;
2753 private final ChronoLocalDate baseDate;
2754
2755 /**
2756 * Constructor.
2757 *
2758 * @param field the field to format, validated not null
2759 * @param minWidth the minimum field width, from 1 to 10
2760 * @param maxWidth the maximum field width, from 1 to 10
2761 * @param baseValue the base value
2762 * @param baseDate the base date
2763 */
2764 ReducedPrinterParser(TemporalField field, int minWidth, int maxWidth,
2765 int baseValue, ChronoLocalDate baseDate) {
2766 this(field, minWidth, maxWidth, baseValue, baseDate, 0);
2767 if (minWidth < 1 || minWidth > 10) {
2768 throw new IllegalArgumentException("The minWidth must be from 1 to 10 inclusive but was " + minWidth);
2769 }
2770 if (maxWidth < 1 || maxWidth > 10) {
2771 throw new IllegalArgumentException("The maxWidth must be from 1 to 10 inclusive but was " + minWidth);
2772 }
2773 if (maxWidth < minWidth) {
2774 throw new IllegalArgumentException("Maximum width must exceed or equal the minimum width but " +
2775 maxWidth + " < " + minWidth);
2776 }
2777 if (baseDate == null) {
2778 if (field.range().isValidValue(baseValue) == false) {
2779 throw new IllegalArgumentException("The base value must be within the range of the field");
2780 }
2781 if ((((long) baseValue) + EXCEED_POINTS[maxWidth]) > Integer.MAX_VALUE) {
2782 throw new DateTimeException("Unable to add printer-parser as the range exceeds the capacity of an int");
2783 }
2784 }
2785 }
2786
2787 /**
2788 * Constructor.
2789 * The arguments have already been checked.
2790 *
2791 * @param field the field to format, validated not null
2792 * @param minWidth the minimum field width, from 1 to 10
2793 * @param maxWidth the maximum field width, from 1 to 10
2794 * @param baseValue the base value
2795 * @param baseDate the base date
2796 * @param subsequentWidth the subsequentWidth for this instance
2797 */
2798 private ReducedPrinterParser(TemporalField field, int minWidth, int maxWidth,
2799 int baseValue, ChronoLocalDate baseDate, int subsequentWidth) {
2800 super(field, minWidth, maxWidth, SignStyle.NOT_NEGATIVE, subsequentWidth);
2801 this.baseValue = baseValue;
2802 this.baseDate = baseDate;
2803 }
2804
2805 @Override
2806 long getValue(DateTimePrintContext context, long value) {
2807 long absValue = Math.abs(value);
2808 int baseValue = this.baseValue;
2809 if (baseDate != null) {
2810 Chronology chrono = Chronology.from(context.getTemporal());
2811 baseValue = chrono.date(baseDate).get(field);
2812 }
2813 if (value >= baseValue && value < baseValue + EXCEED_POINTS[minWidth]) {
2814 // Use the reduced value if it fits in minWidth
2815 return absValue % EXCEED_POINTS[minWidth];
2816 }
2817 // Otherwise truncate to fit in maxWidth
2818 return absValue % EXCEED_POINTS[maxWidth];
2819 }
2820
2821 @Override
2822 int setValue(DateTimeParseContext context, long value, int errorPos, int successPos) {
2823 int baseValue = this.baseValue;
2824 if (baseDate != null) {
2825 Chronology chrono = context.getEffectiveChronology();
2826 baseValue = chrono.date(baseDate).get(field);
2827
2828 // In case the Chronology is changed later, add a callback when/if it changes
2829 final long initialValue = value;
2830 context.addChronoChangedListener(
2831 (_unused) -> {
2832 /* Repeat the set of the field using the current Chronology
2833 * The success/error position is ignored because the value is
2834 * intentionally being overwritten.
2835 */
2836 setValue(context, initialValue, errorPos, successPos);
2837 });
2838 }
2839 int parseLen = successPos - errorPos;
2840 if (parseLen == minWidth && value >= 0) {
2841 long range = EXCEED_POINTS[minWidth];
2842 long lastPart = baseValue % range;
2843 long basePart = baseValue - lastPart;
2844 if (baseValue > 0) {
2845 value = basePart + value;
2846 } else {
2847 value = basePart - value;
2848 }
2849 if (value < baseValue) {
2850 value += range;
2851 }
2852 }
2853 return context.setParsedField(field, value, errorPos, successPos);
2854 }
2855
2856 /**
2857 * Returns a new instance with fixed width flag set.
2858 *
2859 * @return a new updated printer-parser, not null
2860 */
2861 @Override
2862 ReducedPrinterParser withFixedWidth() {
2863 if (subsequentWidth == -1) {
2864 return this;
2865 }
2866 return new ReducedPrinterParser(field, minWidth, maxWidth, baseValue, baseDate, -1);
2867 }
2868
2869 /**
2870 * Returns a new instance with an updated subsequent width.
2871 *
2872 * @param subsequentWidth the width of subsequent non-negative numbers, 0 or greater
2873 * @return a new updated printer-parser, not null
2874 */
2875 @Override
2876 ReducedPrinterParser withSubsequentWidth(int subsequentWidth) {
2877 return new ReducedPrinterParser(field, minWidth, maxWidth, baseValue, baseDate,
2878 this.subsequentWidth + subsequentWidth);
2879 }
2880
2881 /**
2882 * For a ReducedPrinterParser, fixed width is false if the mode is strict,
2883 * otherwise it is set as for NumberPrinterParser.
2884 * @param context the context
2885 * @return if the field is fixed width
2886 * @see DateTimeFormatterBuilder#appendValueReduced(java.time.temporal.TemporalField, int, int, int)
2887 */
2888 @Override
2889 boolean isFixedWidth(DateTimeParseContext context) {
2890 if (context.isStrict() == false) {
2891 return false;
2892 }
2893 return super.isFixedWidth(context);
2894 }
2895
2896 @Override
2897 public String toString() {
2898 return "ReducedValue(" + field + "," + minWidth + "," + maxWidth +
2899 "," + Objects.requireNonNullElse(baseDate, baseValue) + ")";
2900 }
2901 }
2902
2903 //-----------------------------------------------------------------------
2904 /**
2905 * Prints and parses a numeric date-time field with optional padding.
2906 */
2907 static final class FractionPrinterParser implements DateTimePrinterParser {
2908 private final TemporalField field;
2909 private final int minWidth;
2910 private final int maxWidth;
2911 private final boolean decimalPoint;
2912
2913 /**
2914 * Constructor.
2915 *
2916 * @param field the field to output, not null
2917 * @param minWidth the minimum width to output, from 0 to 9
2918 * @param maxWidth the maximum width to output, from 0 to 9
2919 * @param decimalPoint whether to output the localized decimal point symbol
2920 */
2921 FractionPrinterParser(TemporalField field, int minWidth, int maxWidth, boolean decimalPoint) {
2922 Objects.requireNonNull(field, "field");
2923 if (field.range().isFixed() == false) {
2924 throw new IllegalArgumentException("Field must have a fixed set of values: " + field);
2925 }
2926 if (minWidth < 0 || minWidth > 9) {
2927 throw new IllegalArgumentException("Minimum width must be from 0 to 9 inclusive but was " + minWidth);
2928 }
2929 if (maxWidth < 1 || maxWidth > 9) {
2930 throw new IllegalArgumentException("Maximum width must be from 1 to 9 inclusive but was " + maxWidth);
2931 }
2932 if (maxWidth < minWidth) {
2933 throw new IllegalArgumentException("Maximum width must exceed or equal the minimum width but " +
2934 maxWidth + " < " + minWidth);
2935 }
2936 this.field = field;
2937 this.minWidth = minWidth;
2938 this.maxWidth = maxWidth;
2939 this.decimalPoint = decimalPoint;
2940 }
2941
2942 @Override
2943 public boolean format(DateTimePrintContext context, StringBuilder buf) {
2944 Long value = context.getValue(field);
2945 if (value == null) {
2946 return false;
2947 }
2948 DecimalStyle decimalStyle = context.getDecimalStyle();
2949 BigDecimal fraction = convertToFraction(value);
2950 if (fraction.scale() == 0) { // scale is zero if value is zero
2951 if (minWidth > 0) {
2952 if (decimalPoint) {
2953 buf.append(decimalStyle.getDecimalSeparator());
2954 }
2955 for (int i = 0; i < minWidth; i++) {
2956 buf.append(decimalStyle.getZeroDigit());
2957 }
2958 }
2959 } else {
2960 int outputScale = Math.min(Math.max(fraction.scale(), minWidth), maxWidth);
2961 fraction = fraction.setScale(outputScale, RoundingMode.FLOOR);
2962 String str = fraction.toPlainString().substring(2);
2963 str = decimalStyle.convertNumberToI18N(str);
2964 if (decimalPoint) {
2965 buf.append(decimalStyle.getDecimalSeparator());
2966 }
2967 buf.append(str);
2968 }
2969 return true;
2970 }
2971
2972 @Override
2973 public int parse(DateTimeParseContext context, CharSequence text, int position) {
2974 int effectiveMin = (context.isStrict() ? minWidth : 0);
2975 int effectiveMax = (context.isStrict() ? maxWidth : 9);
2976 int length = text.length();
2977 if (position == length) {
2978 // valid if whole field is optional, invalid if minimum width
2979 return (effectiveMin > 0 ? ~position : position);
2980 }
2981 if (decimalPoint) {
2982 if (text.charAt(position) != context.getDecimalStyle().getDecimalSeparator()) {
2983 // valid if whole field is optional, invalid if minimum width
2984 return (effectiveMin > 0 ? ~position : position);
2985 }
2986 position++;
2987 }
2988 int minEndPos = position + effectiveMin;
2989 if (minEndPos > length) {
2990 return ~position; // need at least min width digits
2991 }
2992 int maxEndPos = Math.min(position + effectiveMax, length);
2993 int total = 0; // can use int because we are only parsing up to 9 digits
2994 int pos = position;
2995 while (pos < maxEndPos) {
2996 char ch = text.charAt(pos++);
2997 int digit = context.getDecimalStyle().convertToDigit(ch);
2998 if (digit < 0) {
2999 if (pos < minEndPos) {
3000 return ~position; // need at least min width digits
3001 }
3002 pos--;
3003 break;
3004 }
3005 total = total * 10 + digit;
3006 }
3007 BigDecimal fraction = new BigDecimal(total).movePointLeft(pos - position);
3008 long value = convertFromFraction(fraction);
3009 return context.setParsedField(field, value, position, pos);
3010 }
3011
3012 /**
3013 * Converts a value for this field to a fraction between 0 and 1.
3014 * <p>
3015 * The fractional value is between 0 (inclusive) and 1 (exclusive).
3016 * It can only be returned if the {@link java.time.temporal.TemporalField#range() value range} is fixed.
3017 * The fraction is obtained by calculation from the field range using 9 decimal
3018 * places and a rounding mode of {@link RoundingMode#FLOOR FLOOR}.
3019 * The calculation is inaccurate if the values do not run continuously from smallest to largest.
3020 * <p>
3021 * For example, the second-of-minute value of 15 would be returned as 0.25,
3022 * assuming the standard definition of 60 seconds in a minute.
3023 *
3024 * @param value the value to convert, must be valid for this rule
3025 * @return the value as a fraction within the range, from 0 to 1, not null
3026 * @throws DateTimeException if the value cannot be converted to a fraction
3027 */
3028 private BigDecimal convertToFraction(long value) {
3029 ValueRange range = field.range();
3030 range.checkValidValue(value, field);
3031 BigDecimal minBD = BigDecimal.valueOf(range.getMinimum());
3032 BigDecimal rangeBD = BigDecimal.valueOf(range.getMaximum()).subtract(minBD).add(BigDecimal.ONE);
3033 BigDecimal valueBD = BigDecimal.valueOf(value).subtract(minBD);
3034 BigDecimal fraction = valueBD.divide(rangeBD, 9, RoundingMode.FLOOR);
3035 // stripTrailingZeros bug
3036 return fraction.compareTo(BigDecimal.ZERO) == 0 ? BigDecimal.ZERO : fraction.stripTrailingZeros();
3037 }
3038
3039 /**
3040 * Converts a fraction from 0 to 1 for this field to a value.
3041 * <p>
3042 * The fractional value must be between 0 (inclusive) and 1 (exclusive).
3043 * It can only be returned if the {@link java.time.temporal.TemporalField#range() value range} is fixed.
3044 * The value is obtained by calculation from the field range and a rounding
3045 * mode of {@link RoundingMode#FLOOR FLOOR}.
3046 * The calculation is inaccurate if the values do not run continuously from smallest to largest.
3047 * <p>
3048 * For example, the fractional second-of-minute of 0.25 would be converted to 15,
3049 * assuming the standard definition of 60 seconds in a minute.
3050 *
3051 * @param fraction the fraction to convert, not null
3052 * @return the value of the field, valid for this rule
3053 * @throws DateTimeException if the value cannot be converted
3054 */
3055 private long convertFromFraction(BigDecimal fraction) {
3056 ValueRange range = field.range();
3057 BigDecimal minBD = BigDecimal.valueOf(range.getMinimum());
3058 BigDecimal rangeBD = BigDecimal.valueOf(range.getMaximum()).subtract(minBD).add(BigDecimal.ONE);
3059 BigDecimal valueBD = fraction.multiply(rangeBD).setScale(0, RoundingMode.FLOOR).add(minBD);
3060 return valueBD.longValueExact();
3061 }
3062
3063 @Override
3064 public String toString() {
3065 String decimal = (decimalPoint ? ",DecimalPoint" : "");
3066 return "Fraction(" + field + "," + minWidth + "," + maxWidth + decimal + ")";
3067 }
3068 }
3069
3070 //-----------------------------------------------------------------------
3071 /**
3072 * Prints or parses field text.
3073 */
3074 static final class TextPrinterParser implements DateTimePrinterParser {
3075 private final TemporalField field;
3076 private final TextStyle textStyle;
3077 private final DateTimeTextProvider provider;
3078 /**
3079 * The cached number printer parser.
3080 * Immutable and volatile, so no synchronization needed.
3081 */
3082 private volatile NumberPrinterParser numberPrinterParser;
3083
3084 /**
3085 * Constructor.
3086 *
3087 * @param field the field to output, not null
3088 * @param textStyle the text style, not null
3089 * @param provider the text provider, not null
3090 */
3091 TextPrinterParser(TemporalField field, TextStyle textStyle, DateTimeTextProvider provider) {
3092 // validated by caller
3093 this.field = field;
3094 this.textStyle = textStyle;
3095 this.provider = provider;
3096 }
3097
3098 @Override
3099 public boolean format(DateTimePrintContext context, StringBuilder buf) {
3100 Long value = context.getValue(field);
3101 if (value == null) {
3102 return false;
3103 }
3104 String text;
3105 Chronology chrono = context.getTemporal().query(TemporalQueries.chronology());
3106 if (chrono == null || chrono == IsoChronology.INSTANCE) {
3107 text = provider.getText(field, value, textStyle, context.getLocale());
3108 } else {
3109 text = provider.getText(chrono, field, value, textStyle, context.getLocale());
3110 }
3111 if (text == null) {
3112 return numberPrinterParser().format(context, buf);
3113 }
3114 buf.append(text);
3115 return true;
3116 }
3117
3118 @Override
3119 public int parse(DateTimeParseContext context, CharSequence parseText, int position) {
3120 int length = parseText.length();
3121 if (position < 0 || position > length) {
3122 throw new IndexOutOfBoundsException();
3123 }
3124 TextStyle style = (context.isStrict() ? textStyle : null);
3125 Chronology chrono = context.getEffectiveChronology();
3126 Iterator<Entry<String, Long>> it;
3127 if (chrono == null || chrono == IsoChronology.INSTANCE) {
3128 it = provider.getTextIterator(field, style, context.getLocale());
3129 } else {
3130 it = provider.getTextIterator(chrono, field, style, context.getLocale());
3131 }
3132 if (it != null) {
3133 while (it.hasNext()) {
3134 Entry<String, Long> entry = it.next();
3135 String itText = entry.getKey();
3136 if (context.subSequenceEquals(itText, 0, parseText, position, itText.length())) {
3137 return context.setParsedField(field, entry.getValue(), position, position + itText.length());
3138 }
3139 }
3140 if (field == ERA && !context.isStrict()) {
3141 // parse the possible era name from era.toString()
3142 List<Era> eras = chrono.eras();
3143 for (Era era : eras) {
3144 String name = era.toString();
3145 if (context.subSequenceEquals(name, 0, parseText, position, name.length())) {
3146 return context.setParsedField(field, era.getValue(), position, position + name.length());
3147 }
3148 }
3149 }
3150 if (context.isStrict()) {
3151 return ~position;
3152 }
3153 }
3154 return numberPrinterParser().parse(context, parseText, position);
3155 }
3156
3157 /**
3158 * Create and cache a number printer parser.
3159 * @return the number printer parser for this field, not null
3160 */
3161 private NumberPrinterParser numberPrinterParser() {
3162 if (numberPrinterParser == null) {
3163 numberPrinterParser = new NumberPrinterParser(field, 1, 19, SignStyle.NORMAL);
3164 }
3165 return numberPrinterParser;
3166 }
3167
3168 @Override
3169 public String toString() {
3170 if (textStyle == TextStyle.FULL) {
3171 return "Text(" + field + ")";
3172 }
3173 return "Text(" + field + "," + textStyle + ")";
3174 }
3175 }
3176
3177 //-----------------------------------------------------------------------
3178 /**
3179 * Prints or parses an ISO-8601 instant.
3180 */
3181 static final class InstantPrinterParser implements DateTimePrinterParser {
3182 // days in a 400 year cycle = 146097
3183 // days in a 10,000 year cycle = 146097 * 25
3184 // seconds per day = 86400
3185 private static final long SECONDS_PER_10000_YEARS = 146097L * 25L * 86400L;
3186 private static final long SECONDS_0000_TO_1970 = ((146097L * 5L) - (30L * 365L + 7L)) * 86400L;
3187 private final int fractionalDigits;
3188
3189 InstantPrinterParser(int fractionalDigits) {
3190 this.fractionalDigits = fractionalDigits;
3191 }
3192
3193 @Override
3194 public boolean format(DateTimePrintContext context, StringBuilder buf) {
3195 // use INSTANT_SECONDS, thus this code is not bound by Instant.MAX
3196 Long inSecs = context.getValue(INSTANT_SECONDS);
3197 Long inNanos = null;
3198 if (context.getTemporal().isSupported(NANO_OF_SECOND)) {
3199 inNanos = context.getTemporal().getLong(NANO_OF_SECOND);
3200 }
3201 if (inSecs == null) {
3202 return false;
3203 }
3204 long inSec = inSecs;
3205 int inNano = NANO_OF_SECOND.checkValidIntValue(inNanos != null ? inNanos : 0);
3206 // format mostly using LocalDateTime.toString
3207 if (inSec >= -SECONDS_0000_TO_1970) {
3208 // current era
3209 long zeroSecs = inSec - SECONDS_PER_10000_YEARS + SECONDS_0000_TO_1970;
3210 long hi = Math.floorDiv(zeroSecs, SECONDS_PER_10000_YEARS) + 1;
3211 long lo = Math.floorMod(zeroSecs, SECONDS_PER_10000_YEARS);
3212 LocalDateTime ldt = LocalDateTime.ofEpochSecond(lo - SECONDS_0000_TO_1970, 0, ZoneOffset.UTC);
3213 if (hi > 0) {
3214 buf.append('+').append(hi);
3215 }
3216 buf.append(ldt);
3217 if (ldt.getSecond() == 0) {
3218 buf.append(":00");
3219 }
3220 } else {
3221 // before current era
3222 long zeroSecs = inSec + SECONDS_0000_TO_1970;
3223 long hi = zeroSecs / SECONDS_PER_10000_YEARS;
3224 long lo = zeroSecs % SECONDS_PER_10000_YEARS;
3225 LocalDateTime ldt = LocalDateTime.ofEpochSecond(lo - SECONDS_0000_TO_1970, 0, ZoneOffset.UTC);
3226 int pos = buf.length();
3227 buf.append(ldt);
3228 if (ldt.getSecond() == 0) {
3229 buf.append(":00");
3230 }
3231 if (hi < 0) {
3232 if (ldt.getYear() == -10_000) {
3233 buf.replace(pos, pos + 2, Long.toString(hi - 1));
3234 } else if (lo == 0) {
3235 buf.insert(pos, hi);
3236 } else {
3237 buf.insert(pos + 1, Math.abs(hi));
3238 }
3239 }
3240 }
3241 // add fraction
3242 if ((fractionalDigits < 0 && inNano > 0) || fractionalDigits > 0) {
3243 buf.append('.');
3244 int div = 100_000_000;
3245 for (int i = 0; ((fractionalDigits == -1 && inNano > 0) ||
3246 (fractionalDigits == -2 && (inNano > 0 || (i % 3) != 0)) ||
3247 i < fractionalDigits); i++) {
3248 int digit = inNano / div;
3249 buf.append((char) (digit + '0'));
3250 inNano = inNano - (digit * div);
3251 div = div / 10;
3252 }
3253 }
3254 buf.append('Z');
3255 return true;
3256 }
3257
3258 @Override
3259 public int parse(DateTimeParseContext context, CharSequence text, int position) {
3260 // new context to avoid overwriting fields like year/month/day
3261 int minDigits = (fractionalDigits < 0 ? 0 : fractionalDigits);
3262 int maxDigits = (fractionalDigits < 0 ? 9 : fractionalDigits);
3263 CompositePrinterParser parser = new DateTimeFormatterBuilder()
3264 .append(DateTimeFormatter.ISO_LOCAL_DATE).appendLiteral('T')
3265 .appendValue(HOUR_OF_DAY, 2).appendLiteral(':')
3266 .appendValue(MINUTE_OF_HOUR, 2).appendLiteral(':')
3267 .appendValue(SECOND_OF_MINUTE, 2)
3268 .appendFraction(NANO_OF_SECOND, minDigits, maxDigits, true)
3269 .appendLiteral('Z')
3270 .toFormatter().toPrinterParser(false);
3271 DateTimeParseContext newContext = context.copy();
3272 int pos = parser.parse(newContext, text, position);
3273 if (pos < 0) {
3274 return pos;
3275 }
3276 // parser restricts most fields to 2 digits, so definitely int
3277 // correctly parsed nano is also guaranteed to be valid
3278 long yearParsed = newContext.getParsed(YEAR);
3279 int month = newContext.getParsed(MONTH_OF_YEAR).intValue();
3280 int day = newContext.getParsed(DAY_OF_MONTH).intValue();
3281 int hour = newContext.getParsed(HOUR_OF_DAY).intValue();
3282 int min = newContext.getParsed(MINUTE_OF_HOUR).intValue();
3283 Long secVal = newContext.getParsed(SECOND_OF_MINUTE);
3284 Long nanoVal = newContext.getParsed(NANO_OF_SECOND);
3285 int sec = (secVal != null ? secVal.intValue() : 0);
3286 int nano = (nanoVal != null ? nanoVal.intValue() : 0);
3287 int days = 0;
3288 if (hour == 24 && min == 0 && sec == 0 && nano == 0) {
3289 hour = 0;
3290 days = 1;
3291 } else if (hour == 23 && min == 59 && sec == 60) {
3292 context.setParsedLeapSecond();
3293 sec = 59;
3294 }
3295 int year = (int) yearParsed % 10_000;
3296 long instantSecs;
3297 try {
3298 LocalDateTime ldt = LocalDateTime.of(year, month, day, hour, min, sec, 0).plusDays(days);
3299 instantSecs = ldt.toEpochSecond(ZoneOffset.UTC);
3300 instantSecs += Math.multiplyExact(yearParsed / 10_000L, SECONDS_PER_10000_YEARS);
3301 } catch (RuntimeException ex) {
3302 return ~position;
3303 }
3304 int successPos = pos;
3305 successPos = context.setParsedField(INSTANT_SECONDS, instantSecs, position, successPos);
3306 return context.setParsedField(NANO_OF_SECOND, nano, position, successPos);
3307 }
3308
3309 @Override
3310 public String toString() {
3311 return "Instant()";
3312 }
3313 }
3314
3315 //-----------------------------------------------------------------------
3316 /**
3317 * Prints or parses an offset ID.
3318 */
3319 static final class OffsetIdPrinterParser implements DateTimePrinterParser {
3320 static final String[] PATTERNS = new String[] {
3321 "+HH", "+HHmm", "+HH:mm", "+HHMM", "+HH:MM", "+HHMMss", "+HH:MM:ss", "+HHMMSS", "+HH:MM:SS",
3322 }; // order used in pattern builder
3323 static final OffsetIdPrinterParser INSTANCE_ID_Z = new OffsetIdPrinterParser("+HH:MM:ss", "Z");
3324 static final OffsetIdPrinterParser INSTANCE_ID_ZERO = new OffsetIdPrinterParser("+HH:MM:ss", "0");
3325
3326 private final String noOffsetText;
3327 private final int type;
3328
3329 /**
3330 * Constructor.
3331 *
3332 * @param pattern the pattern
3333 * @param noOffsetText the text to use for UTC, not null
3334 */
3335 OffsetIdPrinterParser(String pattern, String noOffsetText) {
3336 Objects.requireNonNull(pattern, "pattern");
3337 Objects.requireNonNull(noOffsetText, "noOffsetText");
3338 this.type = checkPattern(pattern);
3339 this.noOffsetText = noOffsetText;
3340 }
3341
3342 private int checkPattern(String pattern) {
3343 for (int i = 0; i < PATTERNS.length; i++) {
3344 if (PATTERNS[i].equals(pattern)) {
3345 return i;
3346 }
3347 }
3348 throw new IllegalArgumentException("Invalid zone offset pattern: " + pattern);
3349 }
3350
3351 @Override
3352 public boolean format(DateTimePrintContext context, StringBuilder buf) {
3353 Long offsetSecs = context.getValue(OFFSET_SECONDS);
3354 if (offsetSecs == null) {
3355 return false;
3356 }
3357 int totalSecs = Math.toIntExact(offsetSecs);
3358 if (totalSecs == 0) {
3359 buf.append(noOffsetText);
3360 } else {
3361 int absHours = Math.abs((totalSecs / 3600) % 100); // anything larger than 99 silently dropped
3362 int absMinutes = Math.abs((totalSecs / 60) % 60);
3363 int absSeconds = Math.abs(totalSecs % 60);
3364 int bufPos = buf.length();
3365 int output = absHours;
3366 buf.append(totalSecs < 0 ? "-" : "+")
3367 .append((char) (absHours / 10 + '0')).append((char) (absHours % 10 + '0'));
3368 if (type >= 3 || (type >= 1 && absMinutes > 0)) {
3369 buf.append((type % 2) == 0 ? ":" : "")
3370 .append((char) (absMinutes / 10 + '0')).append((char) (absMinutes % 10 + '0'));
3371 output += absMinutes;
3372 if (type >= 7 || (type >= 5 && absSeconds > 0)) {
3373 buf.append((type % 2) == 0 ? ":" : "")
3374 .append((char) (absSeconds / 10 + '0')).append((char) (absSeconds % 10 + '0'));
3375 output += absSeconds;
3376 }
3377 }
3378 if (output == 0) {
3379 buf.setLength(bufPos);
3380 buf.append(noOffsetText);
3381 }
3382 }
3383 return true;
3384 }
3385
3386 @Override
3387 public int parse(DateTimeParseContext context, CharSequence text, int position) {
3388 int length = text.length();
3389 int noOffsetLen = noOffsetText.length();
3390 if (noOffsetLen == 0) {
3391 if (position == length) {
3392 return context.setParsedField(OFFSET_SECONDS, 0, position, position);
3393 }
3394 } else {
3395 if (position == length) {
3396 return ~position;
3397 }
3398 if (context.subSequenceEquals(text, position, noOffsetText, 0, noOffsetLen)) {
3399 return context.setParsedField(OFFSET_SECONDS, 0, position, position + noOffsetLen);
3400 }
3401 }
3402
3403 // parse normal plus/minus offset
3404 char sign = text.charAt(position); // IOOBE if invalid position
3405 if (sign == '+' || sign == '-') {
3406 // starts
3407 int negative = (sign == '-' ? -1 : 1);
3408 int[] array = new int[4];
3409 array[0] = position + 1;
3410 if ((parseNumber(array, 1, text, true) ||
3411 parseNumber(array, 2, text, type >=3) ||
3412 parseNumber(array, 3, text, false)) == false) {
3413 // success
3414 long offsetSecs = negative * (array[1] * 3600L + array[2] * 60L + array[3]);
3415 return context.setParsedField(OFFSET_SECONDS, offsetSecs, position, array[0]);
3416 }
3417 }
3418 // handle special case of empty no offset text
3419 if (noOffsetLen == 0) {
3420 return context.setParsedField(OFFSET_SECONDS, 0, position, position + noOffsetLen);
3421 }
3422 return ~position;
3423 }
3424
3425 /**
3426 * Parse a two digit zero-prefixed number.
3427 *
3428 * @param array the array of parsed data, 0=pos,1=hours,2=mins,3=secs, not null
3429 * @param arrayIndex the index to parse the value into
3430 * @param parseText the offset ID, not null
3431 * @param required whether this number is required
3432 * @return true if an error occurred
3433 */
3434 private boolean parseNumber(int[] array, int arrayIndex, CharSequence parseText, boolean required) {
3435 if ((type + 3) / 2 < arrayIndex) {
3436 return false; // ignore seconds/minutes
3437 }
3438 int pos = array[0];
3439 if ((type % 2) == 0 && arrayIndex > 1) {
3440 if (pos + 1 > parseText.length() || parseText.charAt(pos) != ':') {
3441 return required;
3442 }
3443 pos++;
3444 }
3445 if (pos + 2 > parseText.length()) {
3446 return required;
3447 }
3448 char ch1 = parseText.charAt(pos++);
3449 char ch2 = parseText.charAt(pos++);
3450 if (ch1 < '0' || ch1 > '9' || ch2 < '0' || ch2 > '9') {
3451 return required;
3452 }
3453 int value = (ch1 - 48) * 10 + (ch2 - 48);
3454 if (value < 0 || value > 59) {
3455 return required;
3456 }
3457 array[arrayIndex] = value;
3458 array[0] = pos;
3459 return false;
3460 }
3461
3462 @Override
3463 public String toString() {
3464 String converted = noOffsetText.replace("'", "''");
3465 return "Offset(" + PATTERNS[type] + ",'" + converted + "')";
3466 }
3467 }
3468
3469 //-----------------------------------------------------------------------
3470 /**
3471 * Prints or parses an offset ID.
3472 */
3473 static final class LocalizedOffsetIdPrinterParser implements DateTimePrinterParser {
3474 private final TextStyle style;
3475
3476 /**
3477 * Constructor.
3478 *
3479 * @param style the style, not null
3480 */
3481 LocalizedOffsetIdPrinterParser(TextStyle style) {
3482 this.style = style;
3483 }
3484
3485 private static StringBuilder appendHMS(StringBuilder buf, int t) {
3486 return buf.append((char)(t / 10 + '0'))
3487 .append((char)(t % 10 + '0'));
3488 }
3489
3490 @Override
3491 public boolean format(DateTimePrintContext context, StringBuilder buf) {
3492 Long offsetSecs = context.getValue(OFFSET_SECONDS);
3493 if (offsetSecs == null) {
3494 return false;
3495 }
3496 String gmtText = "GMT"; // TODO: get localized version of 'GMT'
3497 if (gmtText != null) {
3498 buf.append(gmtText);
3499 }
3500 int totalSecs = Math.toIntExact(offsetSecs);
3501 if (totalSecs != 0) {
3502 int absHours = Math.abs((totalSecs / 3600) % 100); // anything larger than 99 silently dropped
3503 int absMinutes = Math.abs((totalSecs / 60) % 60);
3504 int absSeconds = Math.abs(totalSecs % 60);
3505 buf.append(totalSecs < 0 ? "-" : "+");
3506 if (style == TextStyle.FULL) {
3507 appendHMS(buf, absHours);
3508 buf.append(':');
3509 appendHMS(buf, absMinutes);
3510 if (absSeconds != 0) {
3511 buf.append(':');
3512 appendHMS(buf, absSeconds);
3513 }
3514 } else {
3515 if (absHours >= 10) {
3516 buf.append((char)(absHours / 10 + '0'));
3517 }
3518 buf.append((char)(absHours % 10 + '0'));
3519 if (absMinutes != 0 || absSeconds != 0) {
3520 buf.append(':');
3521 appendHMS(buf, absMinutes);
3522 if (absSeconds != 0) {
3523 buf.append(':');
3524 appendHMS(buf, absSeconds);
3525 }
3526 }
3527 }
3528 }
3529 return true;
3530 }
3531
3532 int getDigit(CharSequence text, int position) {
3533 char c = text.charAt(position);
3534 if (c < '0' || c > '9') {
3535 return -1;
3536 }
3537 return c - '0';
3538 }
3539
3540 @Override
3541 public int parse(DateTimeParseContext context, CharSequence text, int position) {
3542 int pos = position;
3543 int end = pos + text.length();
3544 String gmtText = "GMT"; // TODO: get localized version of 'GMT'
3545 if (gmtText != null) {
3546 if (!context.subSequenceEquals(text, pos, gmtText, 0, gmtText.length())) {
3547 return ~position;
3548 }
3549 pos += gmtText.length();
3550 }
3551 // parse normal plus/minus offset
3552 int negative = 0;
3553 if (pos == end) {
3554 return context.setParsedField(OFFSET_SECONDS, 0, position, pos);
3555 }
3556 char sign = text.charAt(pos); // IOOBE if invalid position
3557 if (sign == '+') {
3558 negative = 1;
3559 } else if (sign == '-') {
3560 negative = -1;
3561 } else {
3562 return context.setParsedField(OFFSET_SECONDS, 0, position, pos);
3563 }
3564 pos++;
3565 int h = 0;
3566 int m = 0;
3567 int s = 0;
3568 if (style == TextStyle.FULL) {
3569 int h1 = getDigit(text, pos++);
3570 int h2 = getDigit(text, pos++);
3571 if (h1 < 0 || h2 < 0 || text.charAt(pos++) != ':') {
3572 return ~position;
3573 }
3574 h = h1 * 10 + h2;
3575 int m1 = getDigit(text, pos++);
3576 int m2 = getDigit(text, pos++);
3577 if (m1 < 0 || m2 < 0) {
3578 return ~position;
3579 }
3580 m = m1 * 10 + m2;
3581 if (pos + 2 < end && text.charAt(pos) == ':') {
3582 int s1 = getDigit(text, pos + 1);
3583 int s2 = getDigit(text, pos + 2);
3584 if (s1 >= 0 && s2 >= 0) {
3585 s = s1 * 10 + s2;
3586 pos += 3;
3587 }
3588 }
3589 } else {
3590 h = getDigit(text, pos++);
3591 if (h < 0) {
3592 return ~position;
3593 }
3594 if (pos < end) {
3595 int h2 = getDigit(text, pos);
3596 if (h2 >=0) {
3597 h = h * 10 + h2;
3598 pos++;
3599 }
3600 if (pos + 2 < end && text.charAt(pos) == ':') {
3601 if (pos + 2 < end && text.charAt(pos) == ':') {
3602 int m1 = getDigit(text, pos + 1);
3603 int m2 = getDigit(text, pos + 2);
3604 if (m1 >= 0 && m2 >= 0) {
3605 m = m1 * 10 + m2;
3606 pos += 3;
3607 if (pos + 2 < end && text.charAt(pos) == ':') {
3608 int s1 = getDigit(text, pos + 1);
3609 int s2 = getDigit(text, pos + 2);
3610 if (s1 >= 0 && s2 >= 0) {
3611 s = s1 * 10 + s2;
3612 pos += 3;
3613 }
3614 }
3615 }
3616 }
3617 }
3618 }
3619 }
3620 long offsetSecs = negative * (h * 3600L + m * 60L + s);
3621 return context.setParsedField(OFFSET_SECONDS, offsetSecs, position, pos);
3622 }
3623
3624 @Override
3625 public String toString() {
3626 return "LocalizedOffset(" + style + ")";
3627 }
3628 }
3629
3630 //-----------------------------------------------------------------------
3631 /**
3632 * Prints or parses a zone ID.
3633 */
3634 static final class ZoneTextPrinterParser extends ZoneIdPrinterParser {
3635
3636 /** The text style to output. */
3637 private final TextStyle textStyle;
3638
3639 /** The preferred zoneid map */
3640 private Set<String> preferredZones;
3641
3642 ZoneTextPrinterParser(TextStyle textStyle, Set<ZoneId> preferredZones) {
3643 super(TemporalQueries.zone(), "ZoneText(" + textStyle + ")");
3644 this.textStyle = Objects.requireNonNull(textStyle, "textStyle");
3645 if (preferredZones != null && preferredZones.size() != 0) {
3646 this.preferredZones = new HashSet<>();
3647 for (ZoneId id : preferredZones) {
3648 this.preferredZones.add(id.getId());
3649 }
3650 }
3651 }
3652
3653 private static final int STD = 0;
3654 private static final int DST = 1;
3655 private static final int GENERIC = 2;
3656 private static final Map<String, SoftReference<Map<Locale, String[]>>> cache =
3657 new ConcurrentHashMap<>();
3658
3659 private String getDisplayName(String id, int type, Locale locale) {
3660 if (textStyle == TextStyle.NARROW) {
3661 return null;
3662 }
3663 String[] names;
3664 SoftReference<Map<Locale, String[]>> ref = cache.get(id);
3665 Map<Locale, String[]> perLocale = null;
3666 if (ref == null || (perLocale = ref.get()) == null ||
3667 (names = perLocale.get(locale)) == null) {
3668 names = TimeZoneNameUtility.retrieveDisplayNames(id, locale);
3669 if (names == null) {
3670 return null;
3671 }
3672 names = Arrays.copyOfRange(names, 0, 7);
3673 names[5] =
3674 TimeZoneNameUtility.retrieveGenericDisplayName(id, TimeZone.LONG, locale);
3675 if (names[5] == null) {
3676 names[5] = names[0]; // use the id
3677 }
3678 names[6] =
3679 TimeZoneNameUtility.retrieveGenericDisplayName(id, TimeZone.SHORT, locale);
3680 if (names[6] == null) {
3681 names[6] = names[0];
3682 }
3683 if (perLocale == null) {
3684 perLocale = new ConcurrentHashMap<>();
3685 }
3686 perLocale.put(locale, names);
3687 cache.put(id, new SoftReference<>(perLocale));
3688 }
3689 switch (type) {
3690 case STD:
3691 return names[textStyle.zoneNameStyleIndex() + 1];
3692 case DST:
3693 return names[textStyle.zoneNameStyleIndex() + 3];
3694 }
3695 return names[textStyle.zoneNameStyleIndex() + 5];
3696 }
3697
3698 @Override
3699 public boolean format(DateTimePrintContext context, StringBuilder buf) {
3700 ZoneId zone = context.getValue(TemporalQueries.zoneId());
3701 if (zone == null) {
3702 return false;
3703 }
3704 String zname = zone.getId();
3705 if (!(zone instanceof ZoneOffset)) {
3706 TemporalAccessor dt = context.getTemporal();
3707 String name = getDisplayName(zname,
3708 dt.isSupported(ChronoField.INSTANT_SECONDS)
3709 ? (zone.getRules().isDaylightSavings(Instant.from(dt)) ? DST : STD)
3710 : GENERIC,
3711 context.getLocale());
3712 if (name != null) {
3713 zname = name;
3714 }
3715 }
3716 buf.append(zname);
3717 return true;
3718 }
3719
3720 // cache per instance for now
3721 private final Map<Locale, Entry<Integer, SoftReference<PrefixTree>>>
3722 cachedTree = new HashMap<>();
3723 private final Map<Locale, Entry<Integer, SoftReference<PrefixTree>>>
3724 cachedTreeCI = new HashMap<>();
3725
3726 @Override
3727 protected PrefixTree getTree(DateTimeParseContext context) {
3728 if (textStyle == TextStyle.NARROW) {
3729 return super.getTree(context);
3730 }
3731 Locale locale = context.getLocale();
3732 boolean isCaseSensitive = context.isCaseSensitive();
3733 Set<String> regionIds = ZoneRulesProvider.getAvailableZoneIds();
3734 int regionIdsSize = regionIds.size();
3735
3736 Map<Locale, Entry<Integer, SoftReference<PrefixTree>>> cached =
3737 isCaseSensitive ? cachedTree : cachedTreeCI;
3738
3739 Entry<Integer, SoftReference<PrefixTree>> entry = null;
3740 PrefixTree tree = null;
3741 String[][] zoneStrings = null;
3742 if ((entry = cached.get(locale)) == null ||
3743 (entry.getKey() != regionIdsSize ||
3744 (tree = entry.getValue().get()) == null)) {
3745 tree = PrefixTree.newTree(context);
3746 zoneStrings = TimeZoneNameUtility.getZoneStrings(locale);
3747 for (String[] names : zoneStrings) {
3748 String zid = names[0];
3749 if (!regionIds.contains(zid)) {
3750 continue;
3751 }
3752 tree.add(zid, zid); // don't convert zid -> metazone
3753 zid = ZoneName.toZid(zid, locale);
3754 int i = textStyle == TextStyle.FULL ? 1 : 2;
3755 for (; i < names.length; i += 2) {
3756 tree.add(names[i], zid);
3757 }
3758 }
3759 // if we have a set of preferred zones, need a copy and
3760 // add the preferred zones again to overwrite
3761 if (preferredZones != null) {
3762 for (String[] names : zoneStrings) {
3763 String zid = names[0];
3764 if (!preferredZones.contains(zid) || !regionIds.contains(zid)) {
3765 continue;
3766 }
3767 int i = textStyle == TextStyle.FULL ? 1 : 2;
3768 for (; i < names.length; i += 2) {
3769 tree.add(names[i], zid);
3770 }
3771 }
3772 }
3773 cached.put(locale, new SimpleImmutableEntry<>(regionIdsSize, new SoftReference<>(tree)));
3774 }
3775 return tree;
3776 }
3777 }
3778
3779 //-----------------------------------------------------------------------
3780 /**
3781 * Prints or parses a zone ID.
3782 */
3783 static class ZoneIdPrinterParser implements DateTimePrinterParser {
3784 private final TemporalQuery<ZoneId> query;
3785 private final String description;
3786
3787 ZoneIdPrinterParser(TemporalQuery<ZoneId> query, String description) {
3788 this.query = query;
3789 this.description = description;
3790 }
3791
3792 @Override
3793 public boolean format(DateTimePrintContext context, StringBuilder buf) {
3794 ZoneId zone = context.getValue(query);
3795 if (zone == null) {
3796 return false;
3797 }
3798 buf.append(zone.getId());
3799 return true;
3800 }
3801
3802 /**
3803 * The cached tree to speed up parsing.
3804 */
3805 private static volatile Entry<Integer, PrefixTree> cachedPrefixTree;
3806 private static volatile Entry<Integer, PrefixTree> cachedPrefixTreeCI;
3807
3808 protected PrefixTree getTree(DateTimeParseContext context) {
3809 // prepare parse tree
3810 Set<String> regionIds = ZoneRulesProvider.getAvailableZoneIds();
3811 final int regionIdsSize = regionIds.size();
3812 Entry<Integer, PrefixTree> cached = context.isCaseSensitive()
3813 ? cachedPrefixTree : cachedPrefixTreeCI;
3814 if (cached == null || cached.getKey() != regionIdsSize) {
3815 synchronized (this) {
3816 cached = context.isCaseSensitive() ? cachedPrefixTree : cachedPrefixTreeCI;
3817 if (cached == null || cached.getKey() != regionIdsSize) {
3818 cached = new SimpleImmutableEntry<>(regionIdsSize, PrefixTree.newTree(regionIds, context));
3819 if (context.isCaseSensitive()) {
3820 cachedPrefixTree = cached;
3821 } else {
3822 cachedPrefixTreeCI = cached;
3823 }
3824 }
3825 }
3826 }
3827 return cached.getValue();
3828 }
3829
3830 /**
3831 * This implementation looks for the longest matching string.
3832 * For example, parsing Etc/GMT-2 will return Etc/GMC-2 rather than just
3833 * Etc/GMC although both are valid.
3834 */
3835 @Override
3836 public int parse(DateTimeParseContext context, CharSequence text, int position) {
3837 int length = text.length();
3838 if (position > length) {
3839 throw new IndexOutOfBoundsException();
3840 }
3841 if (position == length) {
3842 return ~position;
3843 }
3844
3845 // handle fixed time-zone IDs
3846 char nextChar = text.charAt(position);
3847 if (nextChar == '+' || nextChar == '-') {
3848 return parseOffsetBased(context, text, position, position, OffsetIdPrinterParser.INSTANCE_ID_Z);
3849 } else if (length >= position + 2) {
3850 char nextNextChar = text.charAt(position + 1);
3851 if (context.charEquals(nextChar, 'U') && context.charEquals(nextNextChar, 'T')) {
3852 if (length >= position + 3 && context.charEquals(text.charAt(position + 2), 'C')) {
3853 return parseOffsetBased(context, text, position, position + 3, OffsetIdPrinterParser.INSTANCE_ID_ZERO);
3854 }
3855 return parseOffsetBased(context, text, position, position + 2, OffsetIdPrinterParser.INSTANCE_ID_ZERO);
3856 } else if (context.charEquals(nextChar, 'G') && length >= position + 3 &&
3857 context.charEquals(nextNextChar, 'M') && context.charEquals(text.charAt(position + 2), 'T')) {
3858 if (length >= position + 4 && context.charEquals(text.charAt(position + 3), '0')) {
3859 context.setParsed(ZoneId.of("GMT0"));
3860 return position + 4;
3861 }
3862 return parseOffsetBased(context, text, position, position + 3, OffsetIdPrinterParser.INSTANCE_ID_ZERO);
3863 }
3864 }
3865
3866 // parse
3867 PrefixTree tree = getTree(context);
3868 ParsePosition ppos = new ParsePosition(position);
3869 String parsedZoneId = tree.match(text, ppos);
3870 if (parsedZoneId == null) {
3871 if (context.charEquals(nextChar, 'Z')) {
3872 context.setParsed(ZoneOffset.UTC);
3873 return position + 1;
3874 }
3875 return ~position;
3876 }
3877 context.setParsed(ZoneId.of(parsedZoneId));
3878 return ppos.getIndex();
3879 }
3880
3881 /**
3882 * Parse an offset following a prefix and set the ZoneId if it is valid.
3883 * To matching the parsing of ZoneId.of the values are not normalized
3884 * to ZoneOffsets.
3885 *
3886 * @param context the parse context
3887 * @param text the input text
3888 * @param prefixPos start of the prefix
3889 * @param position start of text after the prefix
3890 * @param parser parser for the value after the prefix
3891 * @return the position after the parse
3892 */
3893 private int parseOffsetBased(DateTimeParseContext context, CharSequence text, int prefixPos, int position, OffsetIdPrinterParser parser) {
3894 String prefix = text.toString().substring(prefixPos, position).toUpperCase();
3895 if (position >= text.length()) {
3896 context.setParsed(ZoneId.of(prefix));
3897 return position;
3898 }
3899
3900 // '0' or 'Z' after prefix is not part of a valid ZoneId; use bare prefix
3901 if (text.charAt(position) == '0' ||
3902 context.charEquals(text.charAt(position), 'Z')) {
3903 context.setParsed(ZoneId.of(prefix));
3904 return position;
3905 }
3906
3907 DateTimeParseContext newContext = context.copy();
3908 int endPos = parser.parse(newContext, text, position);
3909 try {
3910 if (endPos < 0) {
3911 if (parser == OffsetIdPrinterParser.INSTANCE_ID_Z) {
3912 return ~prefixPos;
3913 }
3914 context.setParsed(ZoneId.of(prefix));
3915 return position;
3916 }
3917 int offset = (int) newContext.getParsed(OFFSET_SECONDS).longValue();
3918 ZoneOffset zoneOffset = ZoneOffset.ofTotalSeconds(offset);
3919 context.setParsed(ZoneId.ofOffset(prefix, zoneOffset));
3920 return endPos;
3921 } catch (DateTimeException dte) {
3922 return ~prefixPos;
3923 }
3924 }
3925
3926 @Override
3927 public String toString() {
3928 return description;
3929 }
3930 }
3931
3932 //-----------------------------------------------------------------------
3933 /**
3934 * A String based prefix tree for parsing time-zone names.
3935 */
3936 static class PrefixTree {
3937 protected String key;
3938 protected String value;
3939 protected char c0; // performance optimization to avoid the
3940 // boundary check cost of key.charat(0)
3941 protected PrefixTree child;
3942 protected PrefixTree sibling;
3943
3944 private PrefixTree(String k, String v, PrefixTree child) {
3945 this.key = k;
3946 this.value = v;
3947 this.child = child;
3948 if (k.length() == 0){
3949 c0 = 0xffff;
3950 } else {
3951 c0 = key.charAt(0);
3952 }
3953 }
3954
3955 /**
3956 * Creates a new prefix parsing tree based on parse context.
3957 *
3958 * @param context the parse context
3959 * @return the tree, not null
3960 */
3961 public static PrefixTree newTree(DateTimeParseContext context) {
3962 //if (!context.isStrict()) {
3963 // return new LENIENT("", null, null);
3964 //}
3965 if (context.isCaseSensitive()) {
3966 return new PrefixTree("", null, null);
3967 }
3968 return new CI("", null, null);
3969 }
3970
3971 /**
3972 * Creates a new prefix parsing tree.
3973 *
3974 * @param keys a set of strings to build the prefix parsing tree, not null
3975 * @param context the parse context
3976 * @return the tree, not null
3977 */
3978 public static PrefixTree newTree(Set<String> keys, DateTimeParseContext context) {
3979 PrefixTree tree = newTree(context);
3980 for (String k : keys) {
3981 tree.add0(k, k);
3982 }
3983 return tree;
3984 }
3985
3986 /**
3987 * Clone a copy of this tree
3988 */
3989 public PrefixTree copyTree() {
3990 PrefixTree copy = new PrefixTree(key, value, null);
3991 if (child != null) {
3992 copy.child = child.copyTree();
3993 }
3994 if (sibling != null) {
3995 copy.sibling = sibling.copyTree();
3996 }
3997 return copy;
3998 }
3999
4000
4001 /**
4002 * Adds a pair of {key, value} into the prefix tree.
4003 *
4004 * @param k the key, not null
4005 * @param v the value, not null
4006 * @return true if the pair is added successfully
4007 */
4008 public boolean add(String k, String v) {
4009 return add0(k, v);
4010 }
4011
4012 private boolean add0(String k, String v) {
4013 k = toKey(k);
4014 int prefixLen = prefixLength(k);
4015 if (prefixLen == key.length()) {
4016 if (prefixLen < k.length()) { // down the tree
4017 String subKey = k.substring(prefixLen);
4018 PrefixTree c = child;
4019 while (c != null) {
4020 if (isEqual(c.c0, subKey.charAt(0))) {
4021 return c.add0(subKey, v);
4022 }
4023 c = c.sibling;
4024 }
4025 // add the node as the child of the current node
4026 c = newNode(subKey, v, null);
4027 c.sibling = child;
4028 child = c;
4029 return true;
4030 }
4031 // have an existing <key, value> already, overwrite it
4032 // if (value != null) {
4033 // return false;
4034 //}
4035 value = v;
4036 return true;
4037 }
4038 // split the existing node
4039 PrefixTree n1 = newNode(key.substring(prefixLen), value, child);
4040 key = k.substring(0, prefixLen);
4041 child = n1;
4042 if (prefixLen < k.length()) {
4043 PrefixTree n2 = newNode(k.substring(prefixLen), v, null);
4044 child.sibling = n2;
4045 value = null;
4046 } else {
4047 value = v;
4048 }
4049 return true;
4050 }
4051
4052 /**
4053 * Match text with the prefix tree.
4054 *
4055 * @param text the input text to parse, not null
4056 * @param off the offset position to start parsing at
4057 * @param end the end position to stop parsing
4058 * @return the resulting string, or null if no match found.
4059 */
4060 public String match(CharSequence text, int off, int end) {
4061 if (!prefixOf(text, off, end)){
4062 return null;
4063 }
4064 if (child != null && (off += key.length()) != end) {
4065 PrefixTree c = child;
4066 do {
4067 if (isEqual(c.c0, text.charAt(off))) {
4068 String found = c.match(text, off, end);
4069 if (found != null) {
4070 return found;
4071 }
4072 return value;
4073 }
4074 c = c.sibling;
4075 } while (c != null);
4076 }
4077 return value;
4078 }
4079
4080 /**
4081 * Match text with the prefix tree.
4082 *
4083 * @param text the input text to parse, not null
4084 * @param pos the position to start parsing at, from 0 to the text
4085 * length. Upon return, position will be updated to the new parse
4086 * position, or unchanged, if no match found.
4087 * @return the resulting string, or null if no match found.
4088 */
4089 public String match(CharSequence text, ParsePosition pos) {
4090 int off = pos.getIndex();
4091 int end = text.length();
4092 if (!prefixOf(text, off, end)){
4093 return null;
4094 }
4095 off += key.length();
4096 if (child != null && off != end) {
4097 PrefixTree c = child;
4098 do {
4099 if (isEqual(c.c0, text.charAt(off))) {
4100 pos.setIndex(off);
4101 String found = c.match(text, pos);
4102 if (found != null) {
4103 return found;
4104 }
4105 break;
4106 }
4107 c = c.sibling;
4108 } while (c != null);
4109 }
4110 pos.setIndex(off);
4111 return value;
4112 }
4113
4114 protected String toKey(String k) {
4115 return k;
4116 }
4117
4118 protected PrefixTree newNode(String k, String v, PrefixTree child) {
4119 return new PrefixTree(k, v, child);
4120 }
4121
4122 protected boolean isEqual(char c1, char c2) {
4123 return c1 == c2;
4124 }
4125
4126 protected boolean prefixOf(CharSequence text, int off, int end) {
4127 if (text instanceof String) {
4128 return ((String)text).startsWith(key, off);
4129 }
4130 int len = key.length();
4131 if (len > end - off) {
4132 return false;
4133 }
4134 int off0 = 0;
4135 while (len-- > 0) {
4136 if (!isEqual(key.charAt(off0++), text.charAt(off++))) {
4137 return false;
4138 }
4139 }
4140 return true;
4141 }
4142
4143 private int prefixLength(String k) {
4144 int off = 0;
4145 while (off < k.length() && off < key.length()) {
4146 if (!isEqual(k.charAt(off), key.charAt(off))) {
4147 return off;
4148 }
4149 off++;
4150 }
4151 return off;
4152 }
4153
4154 /**
4155 * Case Insensitive prefix tree.
4156 */
4157 private static class CI extends PrefixTree {
4158
4159 private CI(String k, String v, PrefixTree child) {
4160 super(k, v, child);
4161 }
4162
4163 @Override
4164 protected CI newNode(String k, String v, PrefixTree child) {
4165 return new CI(k, v, child);
4166 }
4167
4168 @Override
4169 protected boolean isEqual(char c1, char c2) {
4170 return DateTimeParseContext.charEqualsIgnoreCase(c1, c2);
4171 }
4172
4173 @Override
4174 protected boolean prefixOf(CharSequence text, int off, int end) {
4175 int len = key.length();
4176 if (len > end - off) {
4177 return false;
4178 }
4179 int off0 = 0;
4180 while (len-- > 0) {
4181 if (!isEqual(key.charAt(off0++), text.charAt(off++))) {
4182 return false;
4183 }
4184 }
4185 return true;
4186 }
4187 }
4188
4189 /**
4190 * Lenient prefix tree. Case insensitive and ignores characters
4191 * like space, underscore and slash.
4192 */
4193 private static class LENIENT extends CI {
4194
4195 private LENIENT(String k, String v, PrefixTree child) {
4196 super(k, v, child);
4197 }
4198
4199 @Override
4200 protected CI newNode(String k, String v, PrefixTree child) {
4201 return new LENIENT(k, v, child);
4202 }
4203
4204 private boolean isLenientChar(char c) {
4205 return c == ' ' || c == '_' || c == '/';
4206 }
4207
4208 protected String toKey(String k) {
4209 for (int i = 0; i < k.length(); i++) {
4210 if (isLenientChar(k.charAt(i))) {
4211 StringBuilder sb = new StringBuilder(k.length());
4212 sb.append(k, 0, i);
4213 i++;
4214 while (i < k.length()) {
4215 if (!isLenientChar(k.charAt(i))) {
4216 sb.append(k.charAt(i));
4217 }
4218 i++;
4219 }
4220 return sb.toString();
4221 }
4222 }
4223 return k;
4224 }
4225
4226 @Override
4227 public String match(CharSequence text, ParsePosition pos) {
4228 int off = pos.getIndex();
4229 int end = text.length();
4230 int len = key.length();
4231 int koff = 0;
4232 while (koff < len && off < end) {
4233 if (isLenientChar(text.charAt(off))) {
4234 off++;
4235 continue;
4236 }
4237 if (!isEqual(key.charAt(koff++), text.charAt(off++))) {
4238 return null;
4239 }
4240 }
4241 if (koff != len) {
4242 return null;
4243 }
4244 if (child != null && off != end) {
4245 int off0 = off;
4246 while (off0 < end && isLenientChar(text.charAt(off0))) {
4247 off0++;
4248 }
4249 if (off0 < end) {
4250 PrefixTree c = child;
4251 do {
4252 if (isEqual(c.c0, text.charAt(off0))) {
4253 pos.setIndex(off0);
4254 String found = c.match(text, pos);
4255 if (found != null) {
4256 return found;
4257 }
4258 break;
4259 }
4260 c = c.sibling;
4261 } while (c != null);
4262 }
4263 }
4264 pos.setIndex(off);
4265 return value;
4266 }
4267 }
4268 }
4269
4270 //-----------------------------------------------------------------------
4271 /**
4272 * Prints or parses a chronology.
4273 */
4274 static final class ChronoPrinterParser implements DateTimePrinterParser {
4275 /** The text style to output, null means the ID. */
4276 private final TextStyle textStyle;
4277
4278 ChronoPrinterParser(TextStyle textStyle) {
4279 // validated by caller
4280 this.textStyle = textStyle;
4281 }
4282
4283 @Override
4284 public boolean format(DateTimePrintContext context, StringBuilder buf) {
4285 Chronology chrono = context.getValue(TemporalQueries.chronology());
4286 if (chrono == null) {
4287 return false;
4288 }
4289 if (textStyle == null) {
4290 buf.append(chrono.getId());
4291 } else {
4292 buf.append(getChronologyName(chrono, context.getLocale()));
4293 }
4294 return true;
4295 }
4296
4297 @Override
4298 public int parse(DateTimeParseContext context, CharSequence text, int position) {
4299 // simple looping parser to find the chronology
4300 if (position < 0 || position > text.length()) {
4301 throw new IndexOutOfBoundsException();
4302 }
4303 Set<Chronology> chronos = Chronology.getAvailableChronologies();
4304 Chronology bestMatch = null;
4305 int matchLen = -1;
4306 for (Chronology chrono : chronos) {
4307 String name;
4308 if (textStyle == null) {
4309 name = chrono.getId();
4310 } else {
4311 name = getChronologyName(chrono, context.getLocale());
4312 }
4313 int nameLen = name.length();
4314 if (nameLen > matchLen && context.subSequenceEquals(text, position, name, 0, nameLen)) {
4315 bestMatch = chrono;
4316 matchLen = nameLen;
4317 }
4318 }
4319 if (bestMatch == null) {
4320 return ~position;
4321 }
4322 context.setParsed(bestMatch);
4323 return position + matchLen;
4324 }
4325
4326 /**
4327 * Returns the chronology name of the given chrono in the given locale
4328 * if available, or the chronology Id otherwise. The regular ResourceBundle
4329 * search path is used for looking up the chronology name.
4330 *
4331 * @param chrono the chronology, not null
4332 * @param locale the locale, not null
4333 * @return the chronology name of chrono in locale, or the id if no name is available
4334 * @throws NullPointerException if chrono or locale is null
4335 */
4336 private String getChronologyName(Chronology chrono, Locale locale) {
4337 String key = "calendarname." + chrono.getCalendarType();
4338 String name = DateTimeTextProvider.getLocalizedResource(key, locale);
4339 return Objects.requireNonNullElseGet(name, () -> chrono.getId());
4340 }
4341 }
4342
4343 //-----------------------------------------------------------------------
4344 /**
4345 * Prints or parses a localized pattern.
4346 */
4347 static final class LocalizedPrinterParser implements DateTimePrinterParser {
4348 /** Cache of formatters. */
4349 private static final ConcurrentMap<String, DateTimeFormatter> FORMATTER_CACHE = new ConcurrentHashMap<>(16, 0.75f, 2);
4350
4351 private final FormatStyle dateStyle;
4352 private final FormatStyle timeStyle;
4353
4354 /**
4355 * Constructor.
4356 *
4357 * @param dateStyle the date style to use, may be null
4358 * @param timeStyle the time style to use, may be null
4359 */
4360 LocalizedPrinterParser(FormatStyle dateStyle, FormatStyle timeStyle) {
4361 // validated by caller
4362 this.dateStyle = dateStyle;
4363 this.timeStyle = timeStyle;
4364 }
4365
4366 @Override
4367 public boolean format(DateTimePrintContext context, StringBuilder buf) {
4368 Chronology chrono = Chronology.from(context.getTemporal());
4369 return formatter(context.getLocale(), chrono).toPrinterParser(false).format(context, buf);
4370 }
4371
4372 @Override
4373 public int parse(DateTimeParseContext context, CharSequence text, int position) {
4374 Chronology chrono = context.getEffectiveChronology();
4375 return formatter(context.getLocale(), chrono).toPrinterParser(false).parse(context, text, position);
4376 }
4377
4378 /**
4379 * Gets the formatter to use.
4380 * <p>
4381 * The formatter will be the most appropriate to use for the date and time style in the locale.
4382 * For example, some locales will use the month name while others will use the number.
4383 *
4384 * @param locale the locale to use, not null
4385 * @param chrono the chronology to use, not null
4386 * @return the formatter, not null
4387 * @throws IllegalArgumentException if the formatter cannot be found
4388 */
4389 private DateTimeFormatter formatter(Locale locale, Chronology chrono) {
4390 String key = chrono.getId() + '|' + locale.toString() + '|' + dateStyle + timeStyle;
4391 DateTimeFormatter formatter = FORMATTER_CACHE.get(key);
4392 if (formatter == null) {
4393 String pattern = getLocalizedDateTimePattern(dateStyle, timeStyle, chrono, locale);
4394 formatter = new DateTimeFormatterBuilder().appendPattern(pattern).toFormatter(locale);
4395 DateTimeFormatter old = FORMATTER_CACHE.putIfAbsent(key, formatter);
4396 if (old != null) {
4397 formatter = old;
4398 }
4399 }
4400 return formatter;
4401 }
4402
4403 @Override
4404 public String toString() {
4405 return "Localized(" + (dateStyle != null ? dateStyle : "") + "," +
4406 (timeStyle != null ? timeStyle : "") + ")";
4407 }
4408 }
4409
4410 //-----------------------------------------------------------------------
4411 /**
4412 * Prints or parses a localized pattern from a localized field.
4413 * The specific formatter and parameters is not selected until the
4414 * the field is to be printed or parsed.
4415 * The locale is needed to select the proper WeekFields from which
4416 * the field for day-of-week, week-of-month, or week-of-year is selected.
4417 */
4418 static final class WeekBasedFieldPrinterParser implements DateTimePrinterParser {
4419 private char chr;
4420 private int count;
4421
4422 /**
4423 * Constructor.
4424 *
4425 * @param chr the pattern format letter that added this PrinterParser.
4426 * @param count the repeat count of the format letter
4427 */
4428 WeekBasedFieldPrinterParser(char chr, int count) {
4429 this.chr = chr;
4430 this.count = count;
4431 }
4432
4433 @Override
4434 public boolean format(DateTimePrintContext context, StringBuilder buf) {
4435 return printerParser(context.getLocale()).format(context, buf);
4436 }
4437
4438 @Override
4439 public int parse(DateTimeParseContext context, CharSequence text, int position) {
4440 return printerParser(context.getLocale()).parse(context, text, position);
4441 }
4442
4443 /**
4444 * Gets the printerParser to use based on the field and the locale.
4445 *
4446 * @param locale the locale to use, not null
4447 * @return the formatter, not null
4448 * @throws IllegalArgumentException if the formatter cannot be found
4449 */
4450 private DateTimePrinterParser printerParser(Locale locale) {
4451 WeekFields weekDef = WeekFields.of(locale);
4452 TemporalField field = null;
4453 switch (chr) {
4454 case 'Y':
4455 field = weekDef.weekBasedYear();
4456 if (count == 2) {
4457 return new ReducedPrinterParser(field, 2, 2, 0, ReducedPrinterParser.BASE_DATE, 0);
4458 } else {
4459 return new NumberPrinterParser(field, count, 19,
4460 (count < 4) ? SignStyle.NORMAL : SignStyle.EXCEEDS_PAD, -1);
4461 }
4462 case 'e':
4463 case 'c':
4464 field = weekDef.dayOfWeek();
4465 break;
4466 case 'w':
4467 field = weekDef.weekOfWeekBasedYear();
4468 break;
4469 case 'W':
4470 field = weekDef.weekOfMonth();
4471 break;
4472 default:
4473 throw new IllegalStateException("unreachable");
4474 }
4475 return new NumberPrinterParser(field, (count == 2 ? 2 : 1), 2, SignStyle.NOT_NEGATIVE);
4476 }
4477
4478 @Override
4479 public String toString() {
4480 StringBuilder sb = new StringBuilder(30);
4481 sb.append("Localized(");
4482 if (chr == 'Y') {
4483 if (count == 1) {
4484 sb.append("WeekBasedYear");
4485 } else if (count == 2) {
4486 sb.append("ReducedValue(WeekBasedYear,2,2,2000-01-01)");
4487 } else {
4488 sb.append("WeekBasedYear,").append(count).append(",")
4489 .append(19).append(",")
4490 .append((count < 4) ? SignStyle.NORMAL : SignStyle.EXCEEDS_PAD);
4491 }
4492 } else {
4493 switch (chr) {
4494 case 'c':
4495 case 'e':
4496 sb.append("DayOfWeek");
4497 break;
4498 case 'w':
4499 sb.append("WeekOfWeekBasedYear");
4500 break;
4501 case 'W':
4502 sb.append("WeekOfMonth");
4503 break;
4504 default:
4505 break;
4506 }
4507 sb.append(",");
4508 sb.append(count);
4509 }
4510 sb.append(")");
4511 return sb.toString();
4512 }
4513 }
4514
4515 //-------------------------------------------------------------------------
4516 /**
4517 * Length comparator.
4518 */
4519 static final Comparator<String> LENGTH_SORT = new Comparator<String>() {
4520 @Override
4521 public int compare(String str1, String str2) {
4522 return str1.length() == str2.length() ? str1.compareTo(str2) : str1.length() - str2.length();
4523 }
4524 };
4525 }