| // © 2018 and later: Unicode, Inc. and others. |
| // License & terms of use: http://www.unicode.org/copyright.html#License |
| package com.ibm.icu.number; |
| |
| import java.io.IOException; |
| import java.math.BigDecimal; |
| import java.text.AttributedCharacterIterator; |
| import java.text.FieldPosition; |
| import java.util.Arrays; |
| |
| import com.ibm.icu.impl.number.DecimalQuantity; |
| import com.ibm.icu.impl.number.NumberStringBuilder; |
| import com.ibm.icu.number.NumberRangeFormatter.RangeIdentityResult; |
| import com.ibm.icu.text.ConstrainedFieldPosition; |
| import com.ibm.icu.text.FormattedValue; |
| import com.ibm.icu.util.ICUUncheckedIOException; |
| |
| /** |
| * The result of a number range formatting operation. This class allows the result to be exported in several data types, |
| * including a String, an AttributedCharacterIterator, and a BigDecimal. |
| * |
| * @author sffc |
| * @draft ICU 63 |
| * @provisional This API might change or be removed in a future release. |
| * @see NumberRangeFormatter |
| */ |
| public class FormattedNumberRange implements FormattedValue { |
| final NumberStringBuilder string; |
| final DecimalQuantity quantity1; |
| final DecimalQuantity quantity2; |
| final RangeIdentityResult identityResult; |
| |
| FormattedNumberRange(NumberStringBuilder string, DecimalQuantity quantity1, DecimalQuantity quantity2, |
| RangeIdentityResult identityResult) { |
| this.string = string; |
| this.quantity1 = quantity1; |
| this.quantity2 = quantity2; |
| this.identityResult = identityResult; |
| } |
| |
| /** |
| * {@inheritDoc} |
| * |
| * @draft ICU 63 |
| * @provisional This API might change or be removed in a future release. |
| */ |
| @Override |
| public String toString() { |
| return string.toString(); |
| } |
| |
| /** |
| * {@inheritDoc} |
| * |
| * @draft ICU 63 |
| * @provisional This API might change or be removed in a future release. |
| */ |
| @Override |
| public <A extends Appendable> A appendTo(A appendable) { |
| try { |
| appendable.append(string); |
| } catch (IOException e) { |
| // Throw as an unchecked exception to avoid users needing try/catch |
| throw new ICUUncheckedIOException(e); |
| } |
| return appendable; |
| } |
| |
| /** |
| * {@inheritDoc} |
| * |
| * @draft ICU 64 |
| * @provisional This API might change or be removed in a future release. |
| */ |
| @Override |
| public char charAt(int index) { |
| return string.charAt(index); |
| } |
| |
| /** |
| * {@inheritDoc} |
| * |
| * @draft ICU 64 |
| * @provisional This API might change or be removed in a future release. |
| */ |
| @Override |
| public int length() { |
| return string.length(); |
| } |
| |
| /** |
| * {@inheritDoc} |
| * |
| * @draft ICU 64 |
| * @provisional This API might change or be removed in a future release. |
| */ |
| @Override |
| public CharSequence subSequence(int start, int end) { |
| return string.subString(start, end); |
| } |
| |
| /** |
| * {@inheritDoc} |
| * |
| * @draft ICU 64 |
| * @provisional This API might change or be removed in a future release. |
| */ |
| @Override |
| public boolean nextPosition(ConstrainedFieldPosition cfpos) { |
| return string.nextPosition(cfpos, null); |
| } |
| |
| /** |
| * Determines the start (inclusive) and end (exclusive) indices of the next occurrence of the given |
| * <em>field</em> in the output string. This allows you to determine the locations of, for example, |
| * the integer part, fraction part, or symbols. |
| * <p> |
| * If both sides of the range have the same field, the field will occur twice, once before the range separator and |
| * once after the range separator, if applicable. |
| * <p> |
| * If a field occurs just once, calling this method will find that occurrence and return it. If a field occurs |
| * multiple times, this method may be called repeatedly with the following pattern: |
| * |
| * <pre> |
| * FieldPosition fpos = new FieldPosition(NumberFormat.Field.INTEGER); |
| * while (formattedNumberRange.nextFieldPosition(fpos, status)) { |
| * // do something with fpos. |
| * } |
| * </pre> |
| * <p> |
| * This method is useful if you know which field to query. If you want all available field position information, use |
| * {@link #toCharacterIterator()}. |
| * |
| * @param fieldPosition |
| * Input+output variable. See {@link FormattedNumber#nextFieldPosition(FieldPosition)}. |
| * @return true if a new occurrence of the field was found; false otherwise. |
| * @draft ICU 63 |
| * @provisional This API might change or be removed in a future release. |
| * @see com.ibm.icu.text.NumberFormat.Field |
| * @see NumberRangeFormatter |
| */ |
| public boolean nextFieldPosition(FieldPosition fieldPosition) { |
| return string.nextFieldPosition(fieldPosition); |
| } |
| |
| /** |
| * {@inheritDoc} |
| * |
| * @draft ICU 63 |
| * @provisional This API might change or be removed in a future release. |
| */ |
| @Override |
| public AttributedCharacterIterator toCharacterIterator() { |
| return string.toCharacterIterator(null); |
| } |
| |
| /** |
| * Export the first formatted number as a BigDecimal. This endpoint is useful for obtaining the exact number being |
| * printed after scaling and rounding have been applied by the number range formatting pipeline. |
| * |
| * @return A BigDecimal representation of the first formatted number. |
| * @draft ICU 63 |
| * @provisional This API might change or be removed in a future release. |
| * @see NumberRangeFormatter |
| * @see #getSecondBigDecimal |
| */ |
| public BigDecimal getFirstBigDecimal() { |
| return quantity1.toBigDecimal(); |
| } |
| |
| /** |
| * Export the second formatted number as a BigDecimal. This endpoint is useful for obtaining the exact number being |
| * printed after scaling and rounding have been applied by the number range formatting pipeline. |
| * |
| * @return A BigDecimal representation of the second formatted number. |
| * @draft ICU 63 |
| * @provisional This API might change or be removed in a future release. |
| * @see NumberRangeFormatter |
| * @see #getFirstBigDecimal |
| */ |
| public BigDecimal getSecondBigDecimal() { |
| return quantity2.toBigDecimal(); |
| } |
| |
| /** |
| * Returns whether the pair of numbers was successfully formatted as a range or whether an identity fallback was |
| * used. For example, if the first and second number were the same either before or after rounding occurred, an |
| * identity fallback was used. |
| * |
| * @return A RangeIdentityType indicating the resulting identity situation in the formatted number range. |
| * @draft ICU 63 |
| * @provisional This API might change or be removed in a future release. |
| * @see NumberRangeFormatter |
| * @see NumberRangeFormatter.RangeIdentityFallback |
| */ |
| public RangeIdentityResult getIdentityResult() { |
| return identityResult; |
| } |
| |
| /** |
| * {@inheritDoc} |
| * |
| * @draft ICU 63 |
| * @provisional This API might change or be removed in a future release. |
| */ |
| @Override |
| public int hashCode() { |
| // NumberStringBuilder and BigDecimal are mutable, so we can't call |
| // #equals() or #hashCode() on them directly. |
| return Arrays.hashCode(string.toCharArray()) ^ Arrays.hashCode(string.toFieldArray()) |
| ^ quantity1.toBigDecimal().hashCode() ^ quantity2.toBigDecimal().hashCode(); |
| } |
| |
| /** |
| * {@inheritDoc} |
| * |
| * @draft ICU 63 |
| * @provisional This API might change or be removed in a future release. |
| */ |
| @Override |
| public boolean equals(Object other) { |
| if (this == other) |
| return true; |
| if (other == null) |
| return false; |
| if (!(other instanceof FormattedNumberRange)) |
| return false; |
| // NumberStringBuilder and BigDecimal are mutable, so we can't call |
| // #equals() or #hashCode() on them directly. |
| FormattedNumberRange _other = (FormattedNumberRange) other; |
| return Arrays.equals(string.toCharArray(), _other.string.toCharArray()) |
| && Arrays.equals(string.toFieldArray(), _other.string.toFieldArray()) |
| && quantity1.toBigDecimal().equals(_other.quantity1.toBigDecimal()) |
| && quantity2.toBigDecimal().equals(_other.quantity2.toBigDecimal()); |
| } |
| } |