net.morilib.rena

Interface PatternMatcher<A>

Type Parameters:

A - attribute

All Known Subinterfaces:

LookaheadMatcher<A>, OperationMatcher<A>, OrMatcher<A>, ThenMatcher<A>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface PatternMatcher<A>

A functional interface of matchers used in this framework.

Method Summary

Modifier and Type	Method and Description
default PatternResult<A>	match(java.lang.String match, A attribute) matches the given string starts with 0. returns an instance of PatternResult if it matches, or returns null if it does not match.
PatternResult<A>	match(java.lang.String match, int index, A attribute) matches the given string starts with the given index. returns an instance of PatternResult if it matches, or returns null if it does not match.
default PatternResult<A>	parse(java.lang.String match, A attribute) An alias of match.
default PatternResult<A>	parsePart(java.lang.String match, A attribute) searches this pattern in the given string. returns an instance of PatternResult if the pattern found in the string.
default PatternResult<A>	parsePart(java.lang.String match, int index, A attribute) searches this pattern in the given string from the given index. returns an instance of PatternResult if the pattern found in the string from the index.
default A	parsePartGlobal(java.lang.String match, A init, java.util.function.BiFunction<A,A,A> action) searches all patterns in the given string. returns accumulated attribute by the given action.
default A	parsePartGlobal(java.lang.String match, int index, A init, java.util.function.BiFunction<A,A,A> action) searches all patterns in the given string from the given index. returns accumulated attribute by the given action.
default java.util.List<A>	parsePartGlobalList(java.lang.String match) searches all patterns in the given string. returns a list of all attributes.
default java.util.List<A>	parsePartGlobalList(java.lang.String match, int index) searches all patterns in the given string from the given index. returns a list of all attributes.

Method Detail

match

PatternResult<A> match(java.lang.String match,
                       int index,
                       A attribute)

matches the given string starts with the given index.
returns an instance of PatternResult if it matches, or returns null if it does not match.

Parameters:

match - a string to be matched

index - an index to start matching

attribute - inherited attribute

Returns:

matched attribute or null

match

default PatternResult<A> match(java.lang.String match,
                               A attribute)

matches the given string starts with 0.
returns an instance of PatternResult if it matches, or returns null if it does not match.

Parameters:

match - a string to be matched

attribute - inherited attribute

Returns:

matched attribute or null

parse

default PatternResult<A> parse(java.lang.String match,
                               A attribute)

An alias of match.

Parameters:

match - a string to be matched

attribute - inherited attribute

Returns:

matched attribute or null

parsePart

default PatternResult<A> parsePart(java.lang.String match,
                                   int index,
                                   A attribute)

searches this pattern in the given string from the given index.
returns an instance of PatternResult if the pattern found in the string from the index. or returns null if the pattern is not found.

Parameters:

match - a string to be matched

index - an index to start matching

attribute - inherited attribute

Returns:

matched attribute or null

parsePart

default PatternResult<A> parsePart(java.lang.String match,
                                   A attribute)

searches this pattern in the given string.
returns an instance of PatternResult if the pattern found in the string. or returns null if the pattern is not found.

Parameters:

match - a string to be matched

attribute - inherited attribute

Returns:

matched attribute or null

parsePartGlobal

default A parsePartGlobal(java.lang.String match,
                          int index,
                          A init,
                          java.util.function.BiFunction<A,A,A> action)

searches all patterns in the given string from the given index.
returns accumulated attribute by the given action.

Parameters:

match - a string to be matched

index - an index to start matching

init - initial attribute

action - an accumulator

Returns:

accumulated attribute

parsePartGlobal

default A parsePartGlobal(java.lang.String match,
                          A init,
                          java.util.function.BiFunction<A,A,A> action)

searches all patterns in the given string.
returns accumulated attribute by the given action.

Parameters:

match - a string to be matched

init - initial attribute

action - an accumulator

Returns:

accumulated attribute

parsePartGlobalList

default java.util.List<A> parsePartGlobalList(java.lang.String match,
                                              int index)

searches all patterns in the given string from the given index.
returns a list of all attributes.

Parameters:

match - a string to be matched

index - an index to start matching

Returns:

a list of all attributes

parsePartGlobalList

default java.util.List<A> parsePartGlobalList(java.lang.String match)

searches all patterns in the given string.
returns a list of all attributes.

Parameters:

match - a string to be matched

Returns:

a list of all attributes