public Class FormattedNumberRange

Implements com.ibm.icu.text.FormattedValue.appendTo.

Doc from com.ibm.icu.text.FormattedValue.appendTo.

Appends the formatted string to an Appendable.

If an IOException occurs when appending to the Appendable, an unchecked ICUUncheckedIOException is thrown instead.

Parameters

appendable:A

The Appendable to which to append the string output.

Returns:A

The same Appendable, for chaining.

Annotations

@Override

ICU Status

Stable since ICU 63.

Implements java.lang.CharSequence.charAt.

Doc from java.lang.CharSequence.charAt.

Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

Parameters

index:int

the index of the char value to be returned

Returns:char

the specified char value

Annotations

@Override

ICU Status

Stable since ICU 64.

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

ICU Status

Stable since ICU 63.

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.

Returns:BigDecimal

A BigDecimal representation of the first formatted number.

ICU Status

Stable since ICU 63.

See Also

NumberRangeFormatter, getSecondBigDecimal

Annotations

@Deprecated

ICU Status

Internal ICU component.

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.

Returns:NumberRangeFormatter.RangeIdentityResult

A RangeIdentityType indicating the resulting identity situation in the formatted number range.

ICU Status

Stable since ICU 63.

See Also

NumberRangeFormatter, NumberRangeFormatter.RangeIdentityFallback

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.

Returns:BigDecimal

A BigDecimal representation of the second formatted number.

ICU Status

Stable since ICU 63.

See Also

NumberRangeFormatter, getFirstBigDecimal

Annotations

@Deprecated

ICU Status

Internal ICU component.

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

ICU Status

Stable since ICU 63.

Implements java.lang.CharSequence.length.

Doc from java.lang.CharSequence.length.

Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.

Returns:int

the number of chars in this sequence

Annotations

@Override

ICU Status

Stable since ICU 64.

Implements com.ibm.icu.text.FormattedValue.nextPosition.

Doc from com.ibm.icu.text.FormattedValue.nextPosition.

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:

    ConstrainedFieldPosition cfpos = new ConstrainedFieldPosition();
    while (fmtval.nextPosition(cfpos)) {
        // handle the field position; get information from cfpos
    }

Parameters

cfpos:ConstrainedFieldPosition

The object used for iteration state. This can provide constraints to iterate over only one specific field; see ConstrainedFieldPosition#constrainField.

Returns:boolean

true if a new occurrence of the field was found; false otherwise.

Annotations

@Override

ICU Status

Stable since ICU 64.

Implements java.lang.CharSequence.subSequence.

Doc from java.lang.CharSequence.subSequence.

Returns a CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Parameters

start:int

the start index, inclusive

end:int

the end index, exclusive

Returns:CharSequence

the specified subsequence

Annotations

@Override

ICU Status

Stable since ICU 64.

Implements com.ibm.icu.text.FormattedValue.toCharacterIterator.

Doc from com.ibm.icu.text.FormattedValue.toCharacterIterator.

Exports the formatted number as an AttributedCharacterIterator.

Consider using nextPosition if you are trying to get field information.

Returns:AttributedCharacterIterator

An AttributedCharacterIterator containing full field information.

Annotations

@Override

ICU Status

Stable since ICU 63.

Overrides java.lang.Object.toString.

Implements com.ibm.icu.text.FormattedValue.toString.

Doc from com.ibm.icu.text.FormattedValue.toString.

Returns the formatted string as a Java String. Consider using appendTo for greater efficiency.

Returns:String

The formatted string.

Annotations

@Override

ICU Status

Stable since ICU 63.