SearchIterator

public abstract class SearchIterator
extends Object

java.lang.Object
↳	android.icu.text.SearchIterator

Known direct subclasses

StringSearch

StringSearch StringSearch is a SearchIterator that provides language-sensitive text searching based on the comparison rules defined in a RuleBasedCollator object.

SearchIterator is an abstract base class that provides methods to search for a pattern within a text string. Instances of SearchIterator maintain a current position and scan over the target text, returning the indices the pattern is matched and the length of each match.

SearchIterator defines a protocol for text searching. Subclasses provide concrete implementations of various search algorithms. For example, StringSearch implements language-sensitive pattern matching based on the comparison rules defined in a RuleBasedCollator object.

Other options for searching include using a BreakIterator to restrict the points at which matches are detected.

SearchIterator provides an API that is similar to that of other text iteration classes such as BreakIterator. Using this class, it is easy to scan through text looking for all occurrences of a given pattern. The following example uses a StringSearch object to find all instances of "fox" in the target string. Any other subclass of SearchIterator can be used in an identical manner.

 String target = "The quick brown fox jumped over the lazy fox"; String pattern = "fox"; SearchIterator iter = new StringSearch(pattern, target); for (int pos = iter.first(); pos != SearchIterator.DONE; pos = iter.next()) { System.out.println("Found match at " + pos + ", length is " + iter.getMatchLength()); }

See also:

Summary

Constants
`int`	`DONE` DONE is returned by previous() and next() after all valid matches have been returned, and by first() and last() if there are no matches at all.

Fields
`protected BreakIterator`	`breakIterator` The BreakIterator to define the boundaries of a logical match.
`protected int`	`matchLength` Length of the most current match in target text.
`protected CharacterIterator`	`targetText` Target text for searching.

Protected constructors
`SearchIterator(CharacterIterator target, BreakIterator breaker)` Protected constructor for use by subclasses.

Public methods
`final int`	`first()` Returns the first index at which the string text matches the search pattern.
`final int`	`following(int position)` Returns the first index equal or greater than `position` at which the string text matches the search pattern.
`BreakIterator`	`getBreakIterator()` Returns the BreakIterator that is used to restrict the indexes at which matches are detected.
`SearchIterator.ElementComparisonType`	`getElementComparisonType()` Returns the collation element comparison type.
`abstract int`	`getIndex()` Return the current index in the text being searched.
`int`	`getMatchLength()` Returns the length of text in the string which matches the search pattern.
`int`	`getMatchStart()` Returns the index to the match in the text string that was searched.
`String`	`getMatchedText()` Returns the text that was matched by the most recent call to `first()`, `next()`, `previous()`, or `last()`.
`CharacterIterator`	`getTarget()` Return the string text to be searched.
`boolean`	`isOverlapping()` Return true if the overlapping property has been set.
`final int`	`last()` Returns the last index in the target text at which it matches the search pattern.
`int`	`next()` Returns the index of the next point at which the text matches the search pattern, starting from the current position The iterator is adjusted so that its current index (as returned by `getIndex()`) is the match position if one was found.
`final int`	`preceding(int position)` Returns the first index less than `position` at which the string text matches the search pattern.
`int`	`previous()` Returns the index of the previous point at which the string text matches the search pattern, starting at the current position.
`void`	`reset()` Resets the iteration.
`void`	`setBreakIterator(BreakIterator breakiter)` Set the BreakIterator that will be used to restrict the points at which matches are detected.
`void`	`setElementComparisonType(SearchIterator.ElementComparisonType type)` Sets the collation element comparison type.
`void`	`setIndex(int position)` Sets the position in the target text at which the next search will start.
`void`	`setOverlapping(boolean allowOverlap)` Determines whether overlapping matches are returned.
`void`	`setTarget(CharacterIterator text)` Set the target text to be searched.

Protected methods
`abstract int`	`handleNext(int start)` Abstract method which subclasses override to provide the mechanism for finding the next match in the target text.
`abstract int`	`handlePrevious(int startAt)` Abstract method which subclasses override to provide the mechanism for finding the previous match in the target text.
`void`	`setMatchLength(int length)` Sets the length of the most recent match in the target text.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Parameters
`target`	`CharacterIterator`: The target text to be searched.
`breaker`	`BreakIterator`: A `BreakIterator` that is used to determine the boundaries of a logical match. This argument can be null.

SearchIterator

Summary

Constants

Fields

Protected constructors

Public methods

Protected methods

Inherited methods

Constants

DONE

Fields

breakIterator

matchLength

targetText

Protected constructors

SearchIterator

Public methods

first

following

getBreakIterator

getElementComparisonType

getIndex

getMatchLength

getMatchStart

getMatchedText

getTarget

isOverlapping

last

next

preceding

previous

reset

setBreakIterator

setElementComparisonType

setIndex

setOverlapping

setTarget

Protected methods

handleNext

handlePrevious

setMatchLength