Package org.eclipse.jface.text

Class MultiStringMatcher

java.lang.Object

org.eclipse.jface.text.MultiStringMatcher

public class MultiStringMatcher
extends Object

Fast matcher to find the occurrences of any of a fixed set of constant strings. Supports finding all (possibly overlapping) matches, or only the leftmost longest match.

Since:

3.9

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MultiStringMatcher.Builder	A Builder for creating a MultiStringMatcher.
static interface	MultiStringMatcher.Match	Describes a match result of indexOf(CharSequence, int), giving access to the matched string and the offset in the text it was matched at.

Method Summary

Modifier and Type	Method	Description
static MultiStringMatcher.Builder	builder()	Creates an initially empty MultiStringMatcher.Builder.
static MultiStringMatcher	create(String... searchStrings)	Creates a MultiStringMatcher for the given searchStrings.
List<MultiStringMatcher.Match>	find(CharSequence text, int offset)	Finds all occurrences of any of the search strings of the MultiStringMatcher in the given text starting at the given offset, including overlapping occurrences.
void	find(CharSequence text, int offset, Consumer<MultiStringMatcher.Match> matches)	Finds all occurrences of any of the search strings of the MultiStringMatcher in the given text starting at the given offset, including overlapping occurrences.
MultiStringMatcher.Match	indexOf(CharSequence text, int offset)	Find the next occurrence of any of the search strings of the MultiStringMatcher in the given text starting at the given offset.
static MultiStringMatcher.Match	indexOf(CharSequence text, int offset, String... searchStrings)	Finds the leftmost longest occurrence of any of the given searchStrings in the text starting at the given offset.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static MultiStringMatcher.Builder builder()

Creates an initially empty MultiStringMatcher.Builder.

Returns:

the MultiStringMatcher.Builder

find

public void find(CharSequence text,
                 int offset,
                 Consumer<MultiStringMatcher.Match> matches)

Finds all occurrences of any of the search strings of the MultiStringMatcher in the given text starting at the given offset, including overlapping occurrences.

Parameters:

text - to search (not null)

offset - to start searching at

matches - Consumer all matches are fed to

Since:

3.10

find

public List<MultiStringMatcher.Match> find(CharSequence text,
                                           int offset)

Finds all occurrences of any of the search strings of the MultiStringMatcher in the given text starting at the given offset, including overlapping occurrences.

Parameters:

text - to search (not null)

offset - to start searching at

Returns:

a possibly empty list of matches

indexOf

public MultiStringMatcher.Match indexOf(CharSequence text,
                                        int offset)

Find the next occurrence of any of the search strings of the MultiStringMatcher in the given text starting at the given offset.

Performs a simultaneous search for all the strings, returning the leftmost match. If multiple search strings match at the same index, the longest match is returned.

Parameters:

text - to search (not null)

offset - to start searching at

Returns:

the leftmost longest match found, or null if no match was found.

indexOf

public static MultiStringMatcher.Match indexOf(CharSequence text,
                                               int offset,
                                               String... searchStrings)

Finds the leftmost longest occurrence of any of the given searchStrings in the text starting at the given offset.

To match the same set of search strings repeatedly against texts it is more efficient to build and re-use a MultiStringMatcher.

Parameters:

text - to search (not null)

offset - to start searching at

searchStrings - to look for; non-null and non-empty strings are ignored

Returns:

a MultiStringMatcher.Match describing the match found, or null if no match was found or there are no non-null non-empty searchStrings

create

public static MultiStringMatcher create(String... searchStrings)

Creates a MultiStringMatcher for the given searchStrings.

If there are no non-null non-empty searchStrings, the returned MultiStringMatcher will never match anything.

Parameters:

searchStrings - to look for; non-null and non-empty strings are ignored

Returns:

the MultiStringMatcher