Top Description Fields Constructors Methods
com.ibm.icu.impl.coll

public final Class FCDUTF16CollationIterator

extends UTF16CollationIterator
Class Inheritance
Imports
com.ibm.icu.impl.Normalizer2Impl
Incrementally checks the input text for FCD and normalizes where necessary.

Field Summary

Modifier and TypeField and Description
private int
checkDir

private final Normalizer2Impl
nfcImpl

private StringBuilder
normalized

private int
rawLimit

private CharSequence
rawSeq

private static final int
rawStart

private int
segmentLimit

private int
segmentStart

Inherited from com.ibm.icu.impl.coll.UTF16CollationIterator:
limitposseqstart

Constructor Summary

AccessConstructor and Description
public
FCDUTF16CollationIterator(CollationData d)

Partial constructor, see CollationIterator#CollationIterator(CollationData).

public
FCDUTF16CollationIterator(CollationData data, boolean numeric, CharSequence s, int p)

Method Summary

Modifier and TypeMethod and Description
protected void
backwardNumCodePoints(int num)

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.backwardNumCodePoints.

public boolean
equals(Object
the reference object with which to compare.
other)

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.equals.

Indicates whether some other object is "equal to" this one.
protected void
forwardNumCodePoints(int num)

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.forwardNumCodePoints.

public int
getOffset()

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.getOffset.

protected long
handleNextCE32()

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

Returns the next code point and its local CE32 value.
public int
hashCode()

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.hashCode.

Returns a hash code value for the object.
public int
nextCodePoint()

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.nextCodePoint.

Returns the next code point (with post-increment).
private void
nextSegment()

Extend the FCD text segment forward or normalize around pos.

private void
normalize(int from, int to)

public int
previousCodePoint()

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.previousCodePoint.

Returns the previous code point (with pre-decrement).
private void
previousSegment()

Extend the FCD text segment backward or normalize around pos.

public void
resetToOffset(int newOffset)

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.resetToOffset.

Resets the iterator state and sets the position to the specified offset.
public void
setText(boolean numeric, CharSequence s, int p)

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.setText.

private void
switchToBackward()

Switches to backward checking.

private void
switchToForward()

Switches to forward checking if possible.

Inherited from com.ibm.icu.impl.coll.UTF16CollationIterator:
handleGetTrailSurrogate

Field Detail

checkDirback to summary
private int checkDir
nfcImplback to summary
private final Normalizer2Impl nfcImpl
normalizedback to summary
private StringBuilder normalized
rawLimitback to summary
private int rawLimit
rawSeqback to summary
private CharSequence rawSeq
rawStartback to summary
private static final int rawStart
segmentLimitback to summary
private int segmentLimit
segmentStartback to summary
private int segmentStart

Constructor Detail

FCDUTF16CollationIteratorback to summary
public FCDUTF16CollationIterator(CollationData d)

Partial constructor, see CollationIterator#CollationIterator(CollationData).

FCDUTF16CollationIteratorback to summary
public FCDUTF16CollationIterator(CollationData data, boolean numeric, CharSequence s, int p)

Method Detail

backwardNumCodePointsback to summary
protected void backwardNumCodePoints(int num)

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.backwardNumCodePoints.

Annotations
@Override
equalsback to summary
public boolean equals(Object other)

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.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
forwardNumCodePointsback to summary
protected void forwardNumCodePoints(int num)

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.forwardNumCodePoints.

Annotations
@Override
getOffsetback to summary
public int getOffset()

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.getOffset.

Annotations
@Override
handleNextCE32back to summary
protected long handleNextCE32()

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

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.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
nextCodePointback to summary
public int nextCodePoint()

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.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
nextSegmentback to summary
private void nextSegment()

Extend the FCD text segment forward or normalize around pos. To be called when checkDir > 0 && pos != limit. Returns with checkDir == 0 and pos != limit.

normalizeback to summary
private void normalize(int from, int to)
previousCodePointback to summary
public int previousCodePoint()

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.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
previousSegmentback to summary
private void previousSegment()

Extend the FCD text segment backward or normalize around pos. To be called when checkDir < 0 && pos != start. Returns with checkDir == 0 and pos != start.

resetToOffsetback to summary
public void resetToOffset(int newOffset)

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.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
setTextback to summary
public void setText(boolean numeric, CharSequence s, int p)

Overrides com.ibm.icu.impl.coll.UTF16CollationIterator.setText.

Annotations
@Override
switchToBackwardback to summary
private void switchToBackward()

Switches to backward checking. To be called when checkDir > 0 || (checkDir == 0 && pos == start). Returns with checkDir < 0 || (checkDir == 0 && pos != start).

switchToForwardback to summary
private void switchToForward()

Switches to forward checking if possible. To be called when checkDir < 0 || (checkDir == 0 && pos == limit). Returns with checkDir > 0 || (checkDir == 0 && pos != limit).