com.ibm.icu.text

Class PluralRanges

java.lang.Object

com.ibm.icu.text.PluralRanges

All Implemented Interfaces:

Freezable<PluralRanges>, Cloneable, Comparable<PluralRanges>

Deprecated.

This API is ICU internal only.

@Deprecated
public final class PluralRanges
extends Object
implements Freezable<PluralRanges>, Comparable<PluralRanges>

Utility class for returning the plural category for a range of numbers, such as 1–5, so that appropriate messages can be chosen. The rules for determining this value vary widely across locales.

Constructor Summary

Constructors

Constructor and Description
PluralRanges() Deprecated. This API is ICU internal only.

Method Summary

Modifier and Type	Method and Description
void	add(PluralRules.StandardPluralCategories rangeStart, PluralRules.StandardPluralCategories rangeEnd, PluralRules.StandardPluralCategories result) Deprecated. This API is ICU internal only.
PluralRanges	cloneAsThawed() Deprecated. This API is ICU internal only.
int	compareTo(PluralRanges that) Deprecated. This API is ICU internal only.
boolean	equals(Object other) Deprecated. This API is ICU internal only.
PluralRanges	freeze() Deprecated. This API is ICU internal only.
PluralRules.StandardPluralCategories	get(PluralRules.StandardPluralCategories start, PluralRules.StandardPluralCategories end) Deprecated. This API is ICU internal only.
int	hashCode() Deprecated. This API is ICU internal only.
boolean	isExplicit(PluralRules.StandardPluralCategories start, PluralRules.StandardPluralCategories end) Deprecated. This API is ICU internal only.
boolean	isExplicitlySet(PluralRules.StandardPluralCategories count) Deprecated. This API is ICU internal only.
boolean	isFrozen() Deprecated. This API is ICU internal only.
String	toString() Deprecated. This API is ICU internal only.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PluralRanges

@Deprecated
public PluralRanges()

Deprecated. This API is ICU internal only.

Constructor

Method Detail

add

@Deprecated
public void add(PluralRules.StandardPluralCategories rangeStart,
                            PluralRules.StandardPluralCategories rangeEnd,
                            PluralRules.StandardPluralCategories result)

Deprecated. This API is ICU internal only.

Internal method for building. If the start or end are null, it means everything of that type.

Parameters:

rangeStart - plural category for the start of the range

rangeEnd - plural category for the end of the range

result - the resulting plural category

get

@Deprecated
public PluralRules.StandardPluralCategories get(PluralRules.StandardPluralCategories start,
                                                            PluralRules.StandardPluralCategories end)

Deprecated. This API is ICU internal only.

Returns the appropriate plural category for a range from start to end. If there is no available data, then 'end' is returned as an implicit value. (Such an implicit value can be tested for with isExplicit(com.ibm.icu.text.PluralRules.StandardPluralCategories, com.ibm.icu.text.PluralRules.StandardPluralCategories).)

Parameters:

start - plural category for the start of the range

end - plural category for the end of the range

Returns:

the resulting plural category, or 'end' if there is no data.

isExplicit

@Deprecated
public boolean isExplicit(PluralRules.StandardPluralCategories start,
                                      PluralRules.StandardPluralCategories end)

Deprecated. This API is ICU internal only.

Returns whether the appropriate plural category for a range from start to end is explicitly in the data (vs given an implicit value). See also get(com.ibm.icu.text.PluralRules.StandardPluralCategories, com.ibm.icu.text.PluralRules.StandardPluralCategories).

Parameters:

start - plural category for the start of the range

end - plural category for the end of the range

Returns:

whether the value for (start,end) is explicit or not.

isExplicitlySet

@Deprecated
public boolean isExplicitlySet(PluralRules.StandardPluralCategories count)

Deprecated. This API is ICU internal only.

Internal method to determines whether the StandardPluralCategories was explicitly used in any add statement.

Parameters:

count - plural category to test

Returns:

true if set

equals

@Deprecated
public boolean equals(Object other)

Deprecated. This API is ICU internal only.

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and Object.hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Overrides:

equals in class Object

Parameters:

other - the object to compare this instance with.

Returns:

true if the specified object is equal to this Object; false otherwise.

See Also:

Object.hashCode()

hashCode

@Deprecated
public int hashCode()

Deprecated. This API is ICU internal only.

Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Overrides:

hashCode in class Object

Returns:

this object's hash code.

See Also:

Object.equals(java.lang.Object)

compareTo

@Deprecated
public int compareTo(PluralRanges that)

Deprecated. This API is ICU internal only.

Compares this object to the specified object to determine their relative order.

Specified by:

compareTo in interface Comparable<PluralRanges>

Parameters:

that - the object to compare to this instance.

Returns:

a negative integer if this instance is less than another; a positive integer if this instance is greater than another; 0 if this instance has the same order as another.

isFrozen

@Deprecated
public boolean isFrozen()

Deprecated. This API is ICU internal only.

Determines whether the object has been frozen or not.

Specified by:

isFrozen in interface Freezable<PluralRanges>

freeze

@Deprecated
public PluralRanges freeze()

Deprecated. This API is ICU internal only.

Freezes the object.

Specified by:

freeze in interface Freezable<PluralRanges>

Returns:

the object itself.

cloneAsThawed

@Deprecated
public PluralRanges cloneAsThawed()

Deprecated. This API is ICU internal only.

Provides for the clone operation. Any clone is initially unfrozen.

Specified by:

cloneAsThawed in interface Freezable<PluralRanges>

toString

@Deprecated
public String toString()

Deprecated. This API is ICU internal only.

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Overrides:

toString in class Object

Returns:

a printable representation of this object.