Package org.kiwiproject.regex

Class MatchSpliterator

java.lang.Object

java.util.Spliterators.AbstractSpliterator<MatchResult>

org.kiwiproject.regex.MatchSpliterator

All Implemented Interfaces:

Spliterator<MatchResult>

public class MatchSpliterator
extends Spliterators.AbstractSpliterator<MatchResult>

This is a Spliterator that lets you traverse MatchResults of a Matcher. Generally you should use one of the stream methods, but if you need a Spliterator instance you can use the constructor directly.

Gratefully included here in Kiwi courtesy of Philipp Wagner from his "A Spliterator for MatchResults in Java" blog entry. Slightly modified to check arguments and add an instance stream method.

Original blog post: A Spliterator for MatchResults in Java by Philipp Wagner.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Spliterator

Spliterator.OfDouble, Spliterator.OfInt, Spliterator.OfLong, Spliterator.OfPrimitive<T extends Object,T_CONS extends Object,T_SPLITR extends Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>

Field Summary

Fields inherited from interface java.util.Spliterator

CONCURRENT, DISTINCT, IMMUTABLE, NONNULL, ORDERED, SIZED, SORTED, SUBSIZED

Constructor Summary

Constructors

Constructor	Description
MatchSpliterator(Matcher matcher)	Create a new instance from the given Matcher.

Method Summary

Modifier and Type	Method	Description
Stream<MatchResult>	stream()	Create a Stream of MatchResult from this instance.
static Stream<MatchResult>	stream(String regex, String input)	Create a Stream of MatchResult using the given regular expression and String input.
static Stream<MatchResult>	stream(Matcher matcher)	Create a Stream of MatchResult using the given Matcher
static Stream<MatchResult>	stream(Pattern pattern, String input)	Create a Stream of MatchResult using the given Pattern and String input.
boolean	tryAdvance(Consumer<? super MatchResult> action)

Methods inherited from class java.util.Spliterators.AbstractSpliterator

characteristics, estimateSize, trySplit

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Spliterator

forEachRemaining, getComparator, getExactSizeIfKnown, hasCharacteristics

Constructor Details

MatchSpliterator

public MatchSpliterator(Matcher matcher)

Create a new instance from the given Matcher. Usually you won't use this directly. Instead, use the stream methods.

Parameters:

matcher - the Matcher to split

Method Details

tryAdvance

public boolean tryAdvance(Consumer<? super MatchResult> action)

stream

public Stream<MatchResult> stream()

Create a Stream of MatchResult from this instance.

Returns:

a stream of match results

stream

public static Stream<MatchResult> stream(String regex,
 String input)

Create a Stream of MatchResult using the given regular expression and String input.

This method will compile a new Pattern every time it is called, even if the same regular expression is supplied. Compiling regular expressions is considered an "expensive" operation. Therefore, you should generally prefer stream(Pattern, String) since you can precompile a Pattern and re-use it many times.

Parameters:

regex - the regular expression as a String

input - the input to match against

Returns:

a stream of match results

Throws:

IllegalArgumentException - if the regex is blank

stream

public static Stream<MatchResult> stream(Pattern pattern,
 String input)

Create a Stream of MatchResult using the given Pattern and String input.

Parameters:

pattern - the Pattern to use when matching the input

input - the input to match against

Returns:

a stream of match results

Throws:

IllegalArgumentException - if the pattern is null

stream

public static Stream<MatchResult> stream(Matcher matcher)

Create a Stream of MatchResult using the given Matcher

Parameters:

matcher - the Matcher to use

Returns:

a stream of match results

Throws:

IllegalArgumentException - if the matcher is null