International Components for Unicode for Java (icu4j) 74.2 · com.ibm.icu.impl.coll.UTF16CollationIterator

Modifier and Type	Field and Description
protected int	limit
protected int	pos
protected CharSequence	seq
protected int	start

Access	Constructor and Description
public	UTF16CollationIterator(CollationData d) Partial constructor, see `CollationIterator#CollationIterator(CollationData)`.
public	UTF16CollationIterator(CollationData d, boolean numeric, CharSequence s, int p)

Method Summary

Modifier and Type	Method and Description
protected void	backwardNumCodePoints(int num) Implements abstract com.ibm.icu.impl.coll.CollationIterator.backwardNumCodePoints.
public boolean	equals(Object the reference object with which to compare. other) Overrides com.ibm.icu.impl.coll.CollationIterator.equals. Indicates whether some other object is "equal to" this one.
protected void	forwardNumCodePoints(int num) Implements abstract com.ibm.icu.impl.coll.CollationIterator.forwardNumCodePoints.
public int	getOffset() Implements abstract com.ibm.icu.impl.coll.CollationIterator.getOffset.
protected char	handleGetTrailSurrogate() Overrides com.ibm.icu.impl.coll.CollationIterator.handleGetTrailSurrogate. Called when handleNextCE32() returns a LEAD_SURROGATE_TAG for a lead surrogate code unit.
protected long	handleNextCE32() Overrides com.ibm.icu.impl.coll.CollationIterator.handleNextCE32. Returns the next code point and its local CE32 value.
public int	hashCode() Overrides com.ibm.icu.impl.coll.CollationIterator.hashCode. Returns a hash code value for the object.
public int	nextCodePoint() Implements abstract com.ibm.icu.impl.coll.CollationIterator.nextCodePoint. Returns the next code point (with post-increment).
public int	previousCodePoint() Implements abstract com.ibm.icu.impl.coll.CollationIterator.previousCodePoint. Returns the previous code point (with pre-decrement).
public void	resetToOffset(int newOffset) Implements abstract com.ibm.icu.impl.coll.CollationIterator.resetToOffset. Resets the iterator state and sets the position to the specified offset.
public void	setText(boolean numeric, CharSequence s, int p)

Inherited from com.ibm.icu.impl.coll.CollationIterator:: appendCEsFromCE32 clearCEs clearCEsIfNoneRemaining fetchCEs forbidSurrogateCodePoints getCE getCE32FromBuilderData getCEs getCEsLength getDataCE32 isLeadSurrogate isTrailSurrogate makeCodePointAndCE32Pair nextCE previousCE reset reset setCurrentCE

limit	back to summary
protected int limit

pos	back to summary
protected int pos

seq	back to summary
protected CharSequence seq

start	back to summary
protected int start

UTF16CollationIterator	back to summary
public UTF16CollationIterator(CollationData d) Partial constructor, see `CollationIterator#CollationIterator(CollationData)`.

UTF16CollationIterator	back to summary
public UTF16CollationIterator(CollationData d, boolean numeric, CharSequence s, int p)

Method Detail

backwardNumCodePoints	back to summary
protected void backwardNumCodePoints(int num) Implements abstract com.ibm.icu.impl.coll.CollationIterator.backwardNumCodePoints. Annotations @Override

backwardNumCodePoints

back to summary

protected void backwardNumCodePoints(int num)

Implements abstract com.ibm.icu.impl.coll.CollationIterator.backwardNumCodePoints.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides com.ibm.icu.impl.coll.CollationIterator.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

public boolean equals(Object other)

Overrides com.ibm.icu.impl.coll.CollationIterator.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

forwardNumCodePoints	back to summary
protected void forwardNumCodePoints(int num) Implements abstract com.ibm.icu.impl.coll.CollationIterator.forwardNumCodePoints. Annotations @Override

forwardNumCodePoints

back to summary

protected void forwardNumCodePoints(int num)

Implements abstract com.ibm.icu.impl.coll.CollationIterator.forwardNumCodePoints.

Annotations

@Override

getOffset	back to summary
public int getOffset() Implements abstract com.ibm.icu.impl.coll.CollationIterator.getOffset. Annotations @Override

getOffset

back to summary

public int getOffset()

Implements abstract com.ibm.icu.impl.coll.CollationIterator.getOffset.

Annotations

@Override

handleGetTrailSurrogate	back to summary
protected char handleGetTrailSurrogate() Overrides com.ibm.icu.impl.coll.CollationIterator.handleGetTrailSurrogate. Doc from com.ibm.icu.impl.coll.CollationIterator.handleGetTrailSurrogate. Called when handleNextCE32() returns a LEAD_SURROGATE_TAG for a lead surrogate code unit. Returns the trail surrogate in that case and advances past it, if a trail surrogate follows the lead surrogate. Otherwise returns any other code unit and does not advance. Annotations @Override

handleGetTrailSurrogate

back to summary

protected char handleGetTrailSurrogate()

Overrides com.ibm.icu.impl.coll.CollationIterator.handleGetTrailSurrogate.

Doc from com.ibm.icu.impl.coll.CollationIterator.handleGetTrailSurrogate.

Called when handleNextCE32() returns a LEAD_SURROGATE_TAG for a lead surrogate code unit. Returns the trail surrogate in that case and advances past it, if a trail surrogate follows the lead surrogate. Otherwise returns any other code unit and does not advance.

Annotations

@Override

handleNextCE32	back to summary
protected long handleNextCE32() Overrides com.ibm.icu.impl.coll.CollationIterator.handleNextCE32. Doc from com.ibm.icu.impl.coll.CollationIterator.handleNextCE32. Returns the next code point and its local CE32 value. Returns Collation.FALLBACK_CE32 at the end of the text (c<0) or when c's CE32 value is to be looked up in the base data (fallback). The code point is used for fallbacks, context and implicit weights. It is ignored when the returned CE32 is not special (e.g., FFFD_CE32). Returns the code point in bits 63..32 (signed) and the CE32 in bits 31..0. Annotations @Override

handleNextCE32

back to summary

protected long handleNextCE32()

Overrides com.ibm.icu.impl.coll.CollationIterator.handleNextCE32.

Doc from com.ibm.icu.impl.coll.CollationIterator.handleNextCE32.

Returns the next code point and its local CE32 value. Returns Collation.FALLBACK_CE32 at the end of the text (c<0) or when c's CE32 value is to be looked up in the base data (fallback). The code point is used for fallbacks, context and implicit weights. It is ignored when the returned CE32 is not special (e.g., FFFD_CE32). Returns the code point in bits 63..32 (signed) and the CE32 in bits 31..0.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides com.ibm.icu.impl.coll.CollationIterator.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

public int hashCode()

Overrides com.ibm.icu.impl.coll.CollationIterator.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

nextCodePoint	back to summary
public int nextCodePoint() Implements abstract com.ibm.icu.impl.coll.CollationIterator.nextCodePoint. Doc from com.ibm.icu.impl.coll.CollationIterator.nextCodePoint. Returns the next code point (with post-increment). Public for identical-level comparison and for testing. Annotations @Override

nextCodePoint

back to summary

public int nextCodePoint()

Implements abstract com.ibm.icu.impl.coll.CollationIterator.nextCodePoint.

Doc from com.ibm.icu.impl.coll.CollationIterator.nextCodePoint.

Returns the next code point (with post-increment). Public for identical-level comparison and for testing.

Annotations

@Override

previousCodePoint	back to summary
public int previousCodePoint() Implements abstract com.ibm.icu.impl.coll.CollationIterator.previousCodePoint. Doc from com.ibm.icu.impl.coll.CollationIterator.previousCodePoint. Returns the previous code point (with pre-decrement). Public for identical-level comparison and for testing. Annotations @Override

previousCodePoint

back to summary

public int previousCodePoint()

Implements abstract com.ibm.icu.impl.coll.CollationIterator.previousCodePoint.

Doc from com.ibm.icu.impl.coll.CollationIterator.previousCodePoint.

Returns the previous code point (with pre-decrement). Public for identical-level comparison and for testing.

Annotations

@Override

resetToOffset	back to summary
public void resetToOffset(int newOffset) Implements abstract com.ibm.icu.impl.coll.CollationIterator.resetToOffset. Doc from com.ibm.icu.impl.coll.CollationIterator.resetToOffset. Resets the iterator state and sets the position to the specified offset. Subclasses must implement, and must call the parent class method, or CollationIterator.reset(). Annotations @Override

resetToOffset

back to summary

public void resetToOffset(int newOffset)

Implements abstract com.ibm.icu.impl.coll.CollationIterator.resetToOffset.

Doc from com.ibm.icu.impl.coll.CollationIterator.resetToOffset.

Resets the iterator state and sets the position to the specified offset. Subclasses must implement, and must call the parent class method, or CollationIterator.reset().

Annotations

@Override

setText	back to summary
public void setText(boolean numeric, CharSequence s, int p)

public Class UTF16CollationIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail