blob: 841a3133659963d892994df7a6692bf03d4408ba (
plain)
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
|
// © 2018 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html#License
package com.ibm.icu.text;
import java.text.AttributedCharacterIterator;
import com.ibm.icu.util.ICUUncheckedIOException;
/**
* An abstract formatted value: a string with associated field attributes.
* Many formatters format to classes implementing FormattedValue.
*
* @author sffc
* @draft ICU 64
* @provisional This API might change or be removed in a future release.
*/
public interface FormattedValue extends CharSequence {
/**
* Returns the formatted string as a Java String.
*
* Consider using {@link #appendTo} for greater efficiency.
*
* @return The formatted string.
* @draft ICU 64
* @provisional This API might change or be removed in a future release.
*/
@Override
public String toString();
/**
* Appends the formatted string to an Appendable.
* <p>
* If an IOException occurs when appending to the Appendable, an unchecked
* {@link ICUUncheckedIOException} is thrown instead.
*
* @param appendable The Appendable to which to append the string output.
* @return The same Appendable, for chaining.
* @draft ICU 64
* @provisional This API might change or be removed in a future release.
*/
public <A extends Appendable> A appendTo(A appendable);
/**
* Iterates over field positions in the FormattedValue. This lets you determine the position
* of specific types of substrings, like a month or a decimal separator.
*
* To loop over all field positions:
*
* <pre>
* ConstrainableFieldPosition cfpos = new ConstrainableFieldPosition();
* while (fmtval.nextPosition(cfpos)) {
* // handle the field position; get information from cfpos
* }
* </pre>
*
* @param cfpos
* The object used for iteration state. This can provide constraints to iterate over
* only one specific field; see {@link ConstrainedFieldPosition#constrainField}.
* @return true if a new occurrence of the field was found;
* false otherwise.
* @draft ICU 64
* @provisional This API might change or be removed in a future release.
*/
public boolean nextPosition(ConstrainedFieldPosition cfpos);
/**
* Exports the formatted number as an AttributedCharacterIterator.
* <p>
* Consider using {@link #nextPosition} if you are trying to get field information.
*
* @return An AttributedCharacterIterator containing full field information.
* @draft ICU 64
* @provisional This API might change or be removed in a future release.
*/
public AttributedCharacterIterator toCharacterIterator();
}
|
