com.ibm.icu.impl.coll

Class UTF16CollationIterator

java.lang.Object

com.ibm.icu.impl.coll.CollationIterator

com.ibm.icu.impl.coll.UTF16CollationIterator

Direct Known Subclasses:

FCDUTF16CollationIterator

public class UTF16CollationIterator
extends CollationIterator

UTF-16 collation element and character iterator. Handles normalized UTF-16 text, with length or NUL-terminated. Unnormalized text is handled by a subclass.

Field Summary

Fields

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

Fields inherited from class com.ibm.icu.impl.coll.CollationIterator

data, NO_CP_AND_CE32, trie

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	backwardNumCodePoints(int num)
boolean	equals(Object other) Compares this instance with the specified object and indicates if they are equal.
protected void	forwardNumCodePoints(int num)
int	getOffset()
protected char	handleGetTrailSurrogate() Called when handleNextCE32() returns a LEAD_SURROGATE_TAG for a lead surrogate code unit.
protected long	handleNextCE32() Returns the next code point and its local CE32 value.
int	hashCode() Returns an integer hash code for this object.
int	nextCodePoint() Returns the next code point (with post-increment).
int	previousCodePoint() Returns the previous code point (with pre-decrement).
void	resetToOffset(int newOffset) Resets the iterator state and sets the position to the specified offset.
void	setText(boolean numeric, CharSequence s, int p)

Methods inherited from class com.ibm.icu.impl.coll.CollationIterator

appendCEsFromCE32, clearCEsIfNoneRemaining, fetchCEs, forbidSurrogateCodePoints, getCE, getCE32FromBuilderData, getCEs, getCEsLength, getDataCE32, isLeadSurrogate, isTrailSurrogate, makeCodePointAndCE32Pair, nextCE, previousCE, reset, reset

Methods inherited from class java.lang.Object

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

Field Detail

seq

protected CharSequence seq

start

protected int start

pos

protected int pos

limit

protected int limit

Constructor Detail

UTF16CollationIterator

public UTF16CollationIterator(CollationData d)

Partial constructor, see CollationIterator(CollationData).

UTF16CollationIterator

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

Method Detail

equals

public boolean equals(Object other)

Description copied from class: Object

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 CollationIterator

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

public int hashCode()

Description copied from class: Object

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)

resetToOffset

public void resetToOffset(int newOffset)

Description copied from class: CollationIterator

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().

Specified by:

resetToOffset in class CollationIterator

getOffset

public int getOffset()

Specified by:

getOffset in class CollationIterator

setText

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

nextCodePoint

public int nextCodePoint()

Description copied from class: CollationIterator

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

Specified by:

nextCodePoint in class CollationIterator

previousCodePoint

public int previousCodePoint()

Description copied from class: CollationIterator

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

Specified by:

previousCodePoint in class CollationIterator

handleNextCE32

protected long handleNextCE32()

Description copied from class: CollationIterator

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.

Overrides:

handleNextCE32 in class CollationIterator

handleGetTrailSurrogate

protected char handleGetTrailSurrogate()

Description copied from class: CollationIterator

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.

Overrides:

handleGetTrailSurrogate in class CollationIterator

forwardNumCodePoints

protected void forwardNumCodePoints(int num)

Specified by:

forwardNumCodePoints in class CollationIterator

backwardNumCodePoints

protected void backwardNumCodePoints(int num)

Specified by:

backwardNumCodePoints in class CollationIterator