org.unbrokendome.gradle.plugins.gitversion.core

Interface MatcherFacade

All Superinterfaces:

java.lang.Iterable<java.lang.String>

All Known Implementing Classes:

DefaultMatcherFacade

public interface MatcherFacade
extends java.lang.Iterable<java.lang.String>

Facade object for the result of a regular expression pattern match, for more convenient use in Groovy code.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAt(int groupIndex) Gets the input subsequence captured by the given group during the match operation.
java.lang.String	getAt(java.lang.String groupName) Gets the input subsequence captured by the given named group during the match operation.
default java.util.Iterator<java.lang.String>	iterator()
int	size() Gets the number of matches.
default java.util.List<java.lang.String>	toList() Returns a list containing all capturing results.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

size

int size()

Gets the number of matches.

Returns:

the number of matches

getAt

@Nonnull
java.lang.String getAt(int groupIndex)

Gets the input subsequence captured by the given group during the match operation. Capturing groups start at index one. The match at index 0 contains the entire input sequence that was matched.

Parameters:

groupIndex - the index of the capturing group

Returns:

the input subsequence captured by the given group

See Also:

Matcher.group(int)

getAt

@Nonnull
java.lang.String getAt(java.lang.String groupName)

Gets the input subsequence captured by the given named group during the match operation.

Parameters:

groupName - the name of a capturing group

Returns:

the input subsequence of the given group

See Also:

Matcher.group(String)

toList

@Nonnull
default java.util.List<java.lang.String> toList()

Returns a list containing all capturing results.

Returns:

a list containing the group capture results, as if returned by getAt(int)

iterator

@Nonnull
default java.util.Iterator<java.lang.String> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>