# Print output for @column tags ?>
public
class
FormattedNumberRange
extends Object
implements
FormattedValue
java.lang.Object | |
↳ | android.icu.number.FormattedNumberRange |
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. Instances of this class are immutable and thread-safe.
See also:
Public methods | |
---|---|
<A extends Appendable>
A
|
appendTo(A appendable)
Appends the formatted string to an Appendable. |
char
|
charAt(int index)
Returns the |
boolean
|
equals(Object other)
Indicates whether some other object is "equal to" this one. |
BigDecimal
|
getFirstBigDecimal()
Export the first formatted number as a BigDecimal. |
NumberRangeFormatter.RangeIdentityResult
|
getIdentityResult()
Returns whether the pair of numbers was successfully formatted as a range or whether an identity fallback was used. |
BigDecimal
|
getSecondBigDecimal()
Export the second formatted number as a BigDecimal. |
int
|
hashCode()
Returns a hash code value for the object. |
int
|
length()
Returns the length of this character sequence. |
boolean
|
nextPosition(ConstrainedFieldPosition cfpos)
Iterates over field positions in the FormattedValue. |
CharSequence
|
subSequence(int start, int end)
Returns a |
AttributedCharacterIterator
|
toCharacterIterator()
Exports the formatted number as an AttributedCharacterIterator. |
String
|
toString()
Returns a string representation of the object. |
Inherited methods | |
---|---|
public A appendTo (A appendable)
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. |
public char charAt (int index)
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 |
public boolean equals (Object other)
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
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. |
public BigDecimal getFirstBigDecimal ()
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. |
public NumberRangeFormatter.RangeIdentityResult getIdentityResult ()
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. |
public BigDecimal getSecondBigDecimal ()
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. |
See also:
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap
.
The general contract of hashCode
is:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
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.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
Returns | |
---|---|
int |
a hash code value for this object. |
public int length ()
Returns the length of this character sequence. The length is the number
of 16-bit char
s in the sequence.
Returns | |
---|---|
int |
the number of char s in this sequence |
public boolean nextPosition (ConstrainedFieldPosition cfpos)
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:
ConstrainableFieldPosition cfpos = new ConstrainableFieldPosition(); 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. |
public CharSequence subSequence (int start, int end)
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 char
s) 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 |
public AttributedCharacterIterator toCharacterIterator ()
Exports the formatted number as an AttributedCharacterIterator.
Consider using nextPosition(ConstrainedFieldPosition)
if you are trying to get field information.
Returns | |
---|---|
AttributedCharacterIterator |
An AttributedCharacterIterator containing full field information. |
public String toString ()
Returns a string representation of the object. In general, the
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |