Repository navigation
Expand file tree
/
Copy pathChoiceFormat.java
More file actions
777 lines (740 loc) · 29.7 KB
/
Copy pathChoiceFormat.java
File metadata and controls
777 lines (740 loc) · 29.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
/*
* Copyright (c) 1996, 2025, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* (C) Copyright Taligent, Inc. 1996, 1997 - All Rights Reserved
* (C) Copyright IBM Corp. 1996 - 1998 - All Rights Reserved
*
* The original version of this source code and documentation is copyrighted
* and owned by Taligent, Inc., a wholly-owned subsidiary of IBM. These
* materials are provided under terms of a License Agreement between Taligent
* and Sun. This technology is protected by multiple US and International
* patents. This notice and attribution to Taligent may not be removed.
* Taligent is a registered trademark of Taligent, Inc.
*
*/
package java.text;
import java.io.InvalidObjectException;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Objects;
/**
* {@code ChoiceFormat} is a concrete subclass of {@code NumberFormat} that
* allows you to attach a format to a range of numbers.
* It is generally used in a {@link MessageFormat} for handling plurals.
* The choice is specified with an ascending list of doubles, where each item
* specifies a half-open interval up to the next item:
* <blockquote>
* <pre>
* X matches j if and only if limit[j] ≤ X < limit[j+1]
* </pre>
* </blockquote>
* If there is no match, then either the first or last index is used, depending
* on whether the number (X) is too low or too high. If the limit array is not
* in ascending order, the results of formatting will be incorrect. ChoiceFormat
* also accepts <code>\u221E</code> as equivalent to infinity(INF).
*
* <p>
* <strong>Note:</strong>
* {@code ChoiceFormat} differs from the other {@code Format}
* classes in that you create a {@code ChoiceFormat} object with a
* constructor (not with a {@code getInstance} style factory
* method). The factory methods aren't necessary because {@code ChoiceFormat}
* doesn't require any complex setup for a given locale. In fact,
* {@code ChoiceFormat} doesn't implement any locale specific behavior.
*
* <h2><a id="patterns">Patterns</a></h2>
* A {@code ChoiceFormat} pattern has the following syntax:
* <blockquote>
* <dl>
* <dt><i>Pattern:</i>
* <dd>SubPattern *("|" SubPattern)
* </dl>
*
* <dl>
* <dt><i>SubPattern:</i>
* <dd>Limit Relation Format
* <dd><sub>Note: Each additional SubPattern must have an ascending Limit-Relation interval</sub></dd>
* </dl>
*
* <dl>
* <dt><i>Limit:</i>
* <dd>Number / "∞" / "-∞"
* </dl>
*
* <dl>
* <dt><i>Number:</i>
* <dd>["-"] *(Digit) 1*(Decimal / Digit) *(Digit) [Exponent]
* </dl>
*
* <dl>
* <dt><i>Decimal:</i>
* <dd>1*(Digit ".") / 1*("." Digit)
* </dl>
*
* <dl>
* <dt><i>Digit:</i>
* <dd>0 - 9
* </dl>
*
* <dl>
* <dt><i>Exponent:</i>
* <dd>*(Digit) Digit ExponentSymbol Digit *(Digit)
* </dl>
*
* <dl>
* <dt><i>ExponentSymbol:</i>
* <dd>"e" / "E"
* </dl>
*
* <dl>
* <dt><i>Relation:</i>
* <dd>"#" / "<" / "≤"
* </dl>
*
* <dl>
* <dt><i>Format:</i>
* <dd>Any characters except the special pattern character '|'
* </dl>
*
* </blockquote>
*
* <i>Note:The relation ≤ is not equivalent to <=</i>
*
* <p> To use a reserved special pattern character within a <i>Format</i> pattern,
* it must be single quoted. For example, {@code new ChoiceFormat("1#'|'foo'|'").format(1)}
* returns {@code "|foo|"}.
* Use two single quotes in a row to produce a literal single quote. For example,
* {@code new ChoiceFormat("1# ''one'' ").format(1)} returns {@code " 'one' "}.
*
* <h2>Usage Information</h2>
*
* <p>
* A {@code ChoiceFormat} can be constructed using either an array of formats
* and an array of limits or a string pattern. When constructing with
* format and limit arrays, the length of these arrays must be the same.
*
* For example,
* <ul>
* <li>
* <em>limits</em> = {1,2,3,4,5,6,7}<br>
* <em>formats</em> = {"Sun","Mon","Tue","Wed","Thur","Fri","Sat"}
* <li>
* <em>limits</em> = {0, 1, ChoiceFormat.nextDouble(1)}<br>
* <em>formats</em> = {"no files", "one file", "many files"}<br>
* ({@code nextDouble} can be used to get the next higher double, to
* make the half-open interval.)
* </ul>
*
* <p>
* Below is an example of constructing a ChoiceFormat with arrays to format
* and parse values:
* {@snippet lang=java :
* double[] limits = {1,2,3,4,5,6,7};
* String[] dayOfWeekNames = {"Sun","Mon","Tue","Wed","Thur","Fri","Sat"};
* ChoiceFormat form = new ChoiceFormat(limits, dayOfWeekNames);
* ParsePosition status = new ParsePosition(0);
* for (double i = 0.0; i <= 8.0; ++i) {
* status.setIndex(0);
* System.out.println(i + " -> " + form.format(i) + " -> "
* + form.parse(form.format(i),status));
* }
* }
*
* <p>Below is an example of constructing a ChoiceFormat with a String pattern:
* {@snippet lang=java :
* ChoiceFormat fmt = new ChoiceFormat(
* "-1#is negative| 0#is zero or fraction | 1#is one |1.0<is 1+ |2#is two |2<is more than 2.");
*
* System.out.println(fmt.format(Double.NEGATIVE_INFINITY)); // outputs "is negative"
* System.out.println(fmt.format(-1.0)); // outputs "is negative"
* System.out.println(fmt.format(0)); // outputs "is zero or fraction"
* System.out.println(fmt.format(0.9)); // outputs "is zero or fraction"
* System.out.println(fmt.format(1)); // outputs "is one"
* System.out.println(fmt.format(1.5)); // outputs "is 1+"
* System.out.println(fmt.format(2)); // outputs "is two"
* System.out.println(fmt.format(2.1)); // outputs "is more than 2."
* System.out.println(fmt.format(Double.NaN)); // outputs "is negative"
* System.out.println(fmt.format(Double.POSITIVE_INFINITY)); // outputs "is more than 2."
* }
*
* <p>
* For more sophisticated patterns, {@code ChoiceFormat} can be used with
* {@link MessageFormat} to produce accurate forms for singular and plural:
* {@snippet lang=java :
* MessageFormat msgFmt = new MessageFormat("The disk \"{0}\" contains {1}.");
* double[] fileLimits = {0,1,2};
* String[] filePart = {"no files","one file","{1,number} files"};
* ChoiceFormat fileChoices = new ChoiceFormat(fileLimits, filePart);
* msgFmt.setFormatByArgumentIndex(1, fileChoices);
* Object[] args = {"MyDisk", 1273};
* System.out.println(msgFmt.format(args));
* }
* The output with different values for {@code fileCount}:
* <blockquote><pre>
* The disk "MyDisk" contains no files.
* The disk "MyDisk" contains one file.
* The disk "MyDisk" contains 1,273 files.
* </pre></blockquote>
* See {@link MessageFormat##pattern_caveats MessageFormat} for caveats regarding
* {@code MessageFormat} patterns within a {@code ChoiceFormat} pattern.
*
* <h2><a id="synchronization">Synchronization</a></h2>
*
* <p>
* Choice formats are not synchronized.
* It is recommended to create separate format instances for each thread.
* If multiple threads access a format concurrently, it must be synchronized
* externally.
*
* @apiNote A subclass could perform more consistent pattern validation by
* throwing an {@code IllegalArgumentException} for all incorrect cases.
* See the {@code Implementation Note} for this implementation's behavior regarding
* incorrect patterns.
* <p>This class inherits instance methods from {@code NumberFormat} it does
* not utilize; a subclass could override and throw {@code
* UnsupportedOperationException} for such methods.
* @implNote Given an incorrect pattern, this implementation may either
* throw an exception or succeed and discard the incorrect portion. A {@code
* NumberFormatException} is thrown if a {@code limit} can not be
* parsed as a numeric value and an {@code IllegalArgumentException} is thrown
* if a {@code SubPattern} is missing, or the intervals are not ascending.
* Discarding the incorrect portion may result in a ChoiceFormat with
* empty {@code limits} and {@code formats}.
*
*
* @see DecimalFormat
* @see MessageFormat
* @author Mark Davis
* @since 1.1
*/
public class ChoiceFormat extends NumberFormat {
// Proclaim serial compatibility with 1.1 FCS
@java.io.Serial
private static final long serialVersionUID = 1795184449645032964L;
/**
* Apply the given pattern to this ChoiceFormat object. The syntax and error
* related caveats for the ChoiceFormat pattern can be found in the
* {@linkplain ##patterns Patterns} section. Unlike {@link #setChoices(double[],
* String[])}, this method will throw an {@code IllegalArgumentException} if
* the {@code limits} are not in ascending order.
*
* @param newPattern a pattern string
* @throws NullPointerException if {@code newPattern}
* is {@code null}
* @throws IllegalArgumentException if {@code newPattern}
* violates the pattern syntax
* @see #ChoiceFormat(String)
*/
public void applyPattern(String newPattern) {
Objects.requireNonNull(newPattern, "newPattern must not be null");
applyPatternImpl(newPattern);
}
/**
* Implementation of applying a pattern to this ChoiceFormat.
* This method processes a String pattern in accordance with the ChoiceFormat
* pattern syntax and populates the internal {@code limits} and {@code formats}
* array variables. See the {@linkplain ##patterns} section for
* further understanding of certain special characters: "#", "<", "\u2264", "|".
*/
private void applyPatternImpl(String newPattern) {
// Set up components
ArrayList<Double> limits = new ArrayList<>();
ArrayList<String> formats = new ArrayList<>();
StringBuilder[] segments = new StringBuilder[]{new StringBuilder(),
new StringBuilder()};
int part = 0; // 0 denotes LIMIT. 1 denotes FORMAT.
double limit = 0;
boolean inQuote = false;
// Parse the string, alternating the value of part
for (int i = 0; i < newPattern.length(); ++i) {
char ch = newPattern.charAt(i);
switch (ch) {
case '\'':
// Check for "''" indicating a literal quote
if ((i + 1) < newPattern.length() && newPattern.charAt(i + 1) == ch) {
segments[part].append(ch);
++i;
} else {
inQuote = !inQuote;
}
break;
case '<', '#', '\u2264':
if (inQuote || part == 1) {
// Don't interpret relational symbols if parsing the format
segments[part].append(ch);
} else {
// Build the numerical value of the limit
// and switch to parsing format
if (segments[0].isEmpty()) {
throw new IllegalArgumentException("Each interval must" +
" contain a number before a format");
}
limit = stringToNum(segments[0].toString());
if (ch == '<' && Double.isFinite(limit)) {
limit = nextDouble(limit);
}
if (!limits.isEmpty() && limit <= limits.getLast()) {
throw new IllegalArgumentException("Incorrect order " +
"of intervals, must be in ascending order");
}
segments[0].setLength(0);
part = 1;
}
break;
case '|':
if (inQuote) {
segments[part].append(ch);
} else {
if (part != 1) {
// Discard incorrect portion and finish building cFmt
break;
}
// Insert an entry into the format and limit arrays
// and switch to parsing limit
limits.add(limit);
formats.add(segments[1].toString());
segments[1].setLength(0);
part = 0;
}
break;
default:
segments[part].append(ch);
}
}
// clean up last one (SubPattern without trailing '|')
if (part == 1) {
limits.add(limit);
formats.add(segments[1].toString());
}
choiceLimits = limits.stream().mapToDouble(d -> d).toArray();
choiceFormats = formats.toArray(new String[0]);
}
/**
* Converts a string value to its double representation; this is used
* to create the limit segment while applying a pattern.
* Handles "\u221E", as specified by the pattern syntax.
*/
private static double stringToNum(String str) {
return switch (str) {
case "\u221E" -> Double.POSITIVE_INFINITY;
case "-\u221E" -> Double.NEGATIVE_INFINITY;
default -> Double.parseDouble(str);
};
}
/**
* {@return a pattern {@code string} that represents the {@code limits} and
* {@code formats} of this ChoiceFormat object}
*
* The {@code string} returned is not guaranteed to be the same input
* {@code string} passed to either {@link #applyPattern(String)} or
* {@link #ChoiceFormat(String)}.
*
* @see #applyPattern(String)
*/
public String toPattern() {
StringBuilder result = new StringBuilder();
for (int i = 0; i < choiceLimits.length; ++i) {
if (i != 0) {
result.append('|');
}
// choose based upon which has less precision
// approximate that by choosing the closest one to an integer.
// could do better, but it's not worth it.
double less = previousDouble(choiceLimits[i]);
double tryLessOrEqual = Math.abs(Math.IEEEremainder(choiceLimits[i], 1.0d));
double tryLess = Math.abs(Math.IEEEremainder(less, 1.0d));
if (tryLessOrEqual < tryLess) {
result.append(choiceLimits[i]);
result.append('#');
} else {
if (choiceLimits[i] == Double.POSITIVE_INFINITY) {
result.append("\u221E");
} else if (choiceLimits[i] == Double.NEGATIVE_INFINITY) {
result.append("-\u221E");
} else {
result.append(less);
}
result.append('<');
}
// Append choiceFormats[i], using quotes if there are special characters.
// Single quotes themselves must be escaped in either case.
String text = choiceFormats[i];
boolean needQuote = text.indexOf('<') >= 0
|| text.indexOf('#') >= 0
|| text.indexOf('\u2264') >= 0
|| text.indexOf('|') >= 0;
if (needQuote) result.append('\'');
if (text.indexOf('\'') < 0) result.append(text);
else {
for (int j=0; j<text.length(); ++j) {
char c = text.charAt(j);
result.append(c);
if (c == '\'') result.append(c);
}
}
if (needQuote) result.append('\'');
}
return result.toString();
}
/**
* Constructs a ChoiceFormat with limits and corresponding formats
* based on the pattern. The syntax and error related caveats for the
* ChoiceFormat pattern can be found in the {@linkplain ##patterns Patterns}
* section. Unlike {@link #ChoiceFormat(double[], String[])}, this constructor will
* throw an {@code IllegalArgumentException} if the {@code limits} are not
* in ascending order.
*
* @param newPattern the new pattern string
* @throws NullPointerException if {@code newPattern} is
* {@code null}
* @throws IllegalArgumentException if {@code newPattern}
* violates the pattern syntax
* @see #applyPattern
*/
public ChoiceFormat(String newPattern) {
Objects.requireNonNull(newPattern, "newPattern must not be null");
applyPatternImpl(newPattern);
}
/**
* Constructs with the limits and the corresponding formats.
*
* @param limits limits in ascending order
* @param formats corresponding format strings
* @throws NullPointerException if {@code limits} or {@code formats}
* is {@code null}
* @throws IllegalArgumentException if the length of {@code limits}
* and {@code formats} are not equal
* @see #setChoices
*/
public ChoiceFormat(double[] limits, String[] formats) {
setChoicesImpl(limits, formats);
}
/**
* Set the choices to be used in formatting.
*
* @param limits contains the top value that you want
* parsed with that format, and should be in ascending sorted order. When
* formatting X, the choice will be the i, where
* limit[i] ≤ X {@literal <} limit[i+1].
* If the limit array is not in ascending order, the results of formatting
* will be incorrect.
* @param formats are the formats you want to use for each limit.
* @throws NullPointerException if {@code limits} or
* {@code formats} is {@code null}
* @throws IllegalArgumentException if the length of {@code limits}
* and {@code formats} are not equal
*/
public void setChoices(double[] limits, String[] formats) {
setChoicesImpl(limits, formats);
}
/**
* Implementation of populating the {@code limits} and
* {@code formats} of this ChoiceFormat. Defensive copies are made.
*/
private void setChoicesImpl(double[] limits, String[] formats) {
if (limits.length != formats.length) {
throw new IllegalArgumentException(
"Input arrays must be of the same length.");
}
choiceLimits = Arrays.copyOf(limits, limits.length);
choiceFormats = Arrays.copyOf(formats, formats.length);
}
/**
* {@return the limits of this ChoiceFormat}
*/
public double[] getLimits() {
return Arrays.copyOf(choiceLimits, choiceLimits.length);
}
/**
* {@return the formats of this ChoiceFormat}
*/
public Object[] getFormats() {
return Arrays.copyOf(choiceFormats, choiceFormats.length);
}
// Overrides
/**
* Specialization of format. This method really calls
* {@link #format(double, StringBuffer, FieldPosition)}.
* Thus, the range of longs that are supported is only equal to
* the range that can be stored by double. This will never be
* a practical limitation.
*
* @param number number to be formatted and substituted.
* @param toAppendTo where text is appended.
* @param status ignore no useful status is returned.
* @throws ArrayIndexOutOfBoundsException if either the {@code limits}
* or {@code formats} of this ChoiceFormat are empty
* @throws NullPointerException if {@code toAppendTo}
* is {@code null}
*/
@Override
public StringBuffer format(long number, StringBuffer toAppendTo,
FieldPosition status) {
return format((double) number, StringBufFactory.of(toAppendTo), status).asStringBuffer();
}
@Override
StringBuf format(long number, StringBuf toAppendTo,
FieldPosition status) {
return format((double) number, toAppendTo, status);
}
/**
* Returns pattern with formatted double.
*
* @param number number to be formatted and substituted.
* @param toAppendTo where text is appended.
* @param status ignore no useful status is returned.
* @throws ArrayIndexOutOfBoundsException if either the {@code limits}
* or {@code formats} of this ChoiceFormat are empty
* @throws NullPointerException if {@code toAppendTo}
* is {@code null}
*/
@Override
public StringBuffer format(double number, StringBuffer toAppendTo,
FieldPosition status) {
return format(number, StringBufFactory.of(toAppendTo), status).asStringBuffer();
}
@Override
StringBuf format(double number, StringBuf toAppendTo,
FieldPosition status) {
// find the number
int i;
for (i = 0; i < choiceLimits.length; ++i) {
if (!(number >= choiceLimits[i])) {
// same as number < choiceLimits, except catches NaN
break;
}
}
--i;
if (i < 0) i = 0;
// return either a formatted number, or a string
return toAppendTo.append(choiceFormats[i]);
}
/**
* Parses the input text starting at the index given by the {@code ParsePosition}
* as a {@code Double}. The value returned is the {@code limit} corresponding
* to the {@code format} that is the longest substring of the input text.
* Matching is done in ascending order, when multiple {@code format}s match
* the text equivalently in strength, the first matching {@code limit} is
* returned. If there is no match, {@code Double.NaN} is returned.
* <p>
* For example,
* {@snippet lang=java :
* var fmt = new ChoiceFormat("0#foo|1#bar|2#baz");
* fmt.parse("baz", new ParsePosition(0)); // returns 2.0
* fmt.parse("quux", new ParsePosition(0)); // returns NaN
* }
*
* @param text the source text.
* @param status an input-output parameter. On input, the
* status.index field indicates the first character of the
* source text that should be parsed. On exit, if no error
* occurred, status.index is set to the first unparsed character
* in the source text. On exit, if an error did occur,
* status.index is unchanged and status.errorIndex is set to the
* first index of the character that caused the parse to fail.
* @return A Number which represents the {@code limit} corresponding to the
* {@code format} parsed, or {@code Double.NaN} if the parse fails.
* @throws NullPointerException if {@code status} is {@code null}
* or if {@code text} is {@code null} and the list of
* choice strings is not empty.
*/
@Override
public Number parse(String text, ParsePosition status) {
// find the best number (defined as the one with the longest parse)
int start = status.index;
int furthest = start;
double bestNumber = Double.NaN;
double tempNumber = 0.0;
for (int i = 0; i < choiceFormats.length; ++i) {
String tempString = choiceFormats[i];
if (text.regionMatches(start, tempString, 0, tempString.length())) {
status.index = start + tempString.length();
tempNumber = choiceLimits[i];
if (status.index > furthest) {
furthest = status.index;
bestNumber = tempNumber;
if (furthest == text.length()) break;
}
}
}
status.index = furthest;
if (status.index == start) {
status.errorIndex = furthest;
}
return Double.valueOf(bestNumber);
}
/**
* @since 23
*/
@Override
public boolean isStrict() {
throw new UnsupportedOperationException(
"ChoiceFormat does not utilize leniency when parsing");
}
/**
* @since 23
*/
@Override
public void setStrict(boolean strict) {
throw new UnsupportedOperationException(
"ChoiceFormat does not utilize leniency when parsing");
}
/**
* Finds the least double greater than {@code d}.
* If {@code NaN}, returns same value.
* <p>Used to make half-open intervals.
*
* @implNote This is equivalent to calling
* {@link Math#nextUp(double) Math.nextUp(d)}
*
* @param d the reference value
* @return the least double value greater than {@code d}
* @see #previousDouble
*/
public static final double nextDouble (double d) {
return Math.nextUp(d);
}
/**
* Finds the least double greater than {@code d} (if {@code positive} is
* {@code true}), or the greatest double less than {@code d} (if
* {@code positive} is {@code false}).
* If {@code NaN}, returns same value.
*
* @implNote This is equivalent to calling
* {@code positive ? Math.nextUp(d) : Math.nextDown(d)}
*
* @param d the reference value
* @param positive {@code true} if the least double is desired;
* {@code false} otherwise
* @return the least or greater double value
*/
public static double nextDouble (double d, boolean positive) {
return positive ? Math.nextUp(d) : Math.nextDown(d);
}
/**
* Finds the greatest double less than {@code d}.
* If {@code NaN}, returns same value.
*
* @implNote This is equivalent to calling
* {@link Math#nextDown(double) Math.nextDown(d)}
*
* @param d the reference value
* @return the greatest double value less than {@code d}
* @see #nextDouble
*/
public static final double previousDouble (double d) {
return Math.nextDown(d);
}
/**
* Overrides Cloneable
*/
@Override
public Object clone() {
ChoiceFormat other = (ChoiceFormat) super.clone();
// for primitives or immutables, shallow clone is enough
other.choiceLimits = choiceLimits.clone();
other.choiceFormats = choiceFormats.clone();
return other;
}
/**
* {@return the hash code for this {@code ChoiceFormat}}
*
* @implSpec This method calculates the hash code value using the values returned by
* {@link #getFormats()} and {@link #getLimits()}.
* @see Object#hashCode()
*/
@Override
public int hashCode() {
int result = choiceLimits.length;
if (choiceFormats.length > 0) {
// enough for reasonable distribution
result ^= choiceFormats[choiceFormats.length-1].hashCode();
}
return result;
}
/**
* {@return a string identifying this {@code ChoiceFormat}, for debugging}
*/
@Override
public String toString() {
return
"""
ChoiceFormat [pattern: "%s"]
""".formatted(toPattern());
}
/**
* Compares the specified object with this {@code ChoiceFormat} for equality.
* Returns true if the object is also a {@code ChoiceFormat} and the
* two formats would format any value the same.
*
* @implSpec This method performs an equality check with a notion of class
* identity based on {@code getClass()}, rather than {@code instanceof}.
* Therefore, in the equals methods in subclasses, no instance of this class
* should compare as equal to an instance of a subclass.
* @param obj object to be compared for equality
* @return {@code true} if the specified object is equal to this {@code ChoiceFormat}
* @see Object#equals(Object)
*/
@Override
public boolean equals(Object obj) {
if (this == obj) // quick check
return true;
if (obj == null || getClass() != obj.getClass())
return false;
ChoiceFormat other = (ChoiceFormat) obj;
return (Arrays.equals(choiceLimits, other.choiceLimits)
&& Arrays.equals(choiceFormats, other.choiceFormats));
}
/**
* After reading an object from the input stream, do a simple verification
* to maintain class invariants.
* @throws InvalidObjectException if the objects read from the stream is invalid.
*/
@java.io.Serial
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
in.defaultReadObject();
if (choiceLimits.length != choiceFormats.length) {
throw new InvalidObjectException(
"limits and format arrays of different length.");
}
}
// ===============privates===========================
/**
* A list of lower bounds for the choices. The formatter will return
* {@code choiceFormats[i]} if the number being formatted is greater than or equal to
* {@code choiceLimits[i]} and less than {@code choiceLimits[i+1]}.
* @serial
*/
private double[] choiceLimits;
/**
* A list of choice strings. The formatter will return
* {@code choiceFormats[i]} if the number being formatted is greater than or equal to
* {@code choiceLimits[i]} and less than {@code choiceLimits[i+1]}.
* @serial
*/
private String[] choiceFormats;
}