com.github.fge.grappa.matchers.join

Class JoinMatcherBuilder<V>

java.lang.Object

com.github.fge.grappa.misc.RangeMatcherBuilder<V>

com.github.fge.grappa.matchers.join.JoinMatcherBuilder<V>

@ParametersAreNonnullByDefault
@Beta
public final class JoinMatcherBuilder<V>
extends RangeMatcherBuilder<V>

The final step to building a JoinMatcher

At this step of the build, we have both rules (the "joined" rule and the "joining" rule). The final information to feed to the matcher is the number of cycles.

The number of cycles can be bounded on the lower end and on the upper end. The "true" building method is RangeMatcherBuilder.range(Range); all other methods ultimately call this one to generate the result.

The real matcher generated depends on the number of cycles required (for the notation used here, see the javadoc for Range):

• [0..0]: an EmptyMatcher;
• [0..1]: an OptionalMatcher with the joined rule as a submatcher;
• [1..1]: the "joined" rule itself;
• [n..+∞) for whatever n: a BoundedDownJoinMatcher;
• [0..n] for n >= 2: a BoundedUpJoinMatcher;
• [n..n] for n >= 2: an ExactMatchesJoinMatcher;
• [n..m]: a BoundedBothJoinMatcher.

See Also:

JoinMatcher, Range

Field Summary

Fields inherited from class com.github.fge.grappa.misc.RangeMatcherBuilder

parser, rule

Method Summary

Methods

Modifier and Type	Method and Description
protected Rule	boundedBoth(int minCycles, int maxCycles) Build a rule which is expected to match a number of times between two end points
protected Rule	boundedDown(int minCycles) Build a rule which is expected to match a minimum number of times
protected Rule	boundedUp(int maxCycles) Build a rule which is expected to match a maximum number of times
protected Rule	exactly(int nrCycles) Build a rule which is expected to match a fixed number of times

Methods inherited from class com.github.fge.grappa.misc.RangeMatcherBuilder

max, min, range, times, times

Methods inherited from class java.lang.Object

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

Method Detail

boundedDown

protected Rule boundedDown(int minCycles)

Description copied from class: RangeMatcherBuilder

Build a rule which is expected to match a minimum number of times

The returned matcher will attempt to match indefinitely its input until it fails. Success should be declared if and only if the number of times the matcher has succeeded is greater than, or equal to, the number of cycles given as an argument (including 0).

Specified by:

boundedDown in class RangeMatcherBuilder<V>

Parameters:

minCycles - the minimum number of cycles (inclusive)

Returns:

a rule

boundedUp

protected Rule boundedUp(int maxCycles)

Description copied from class: RangeMatcherBuilder

Build a rule which is expected to match a maximum number of times

The returned matcher will attempt to match repeatedly up to, and including, the number of cycles returned as an argument. Note that the argument will always be greater than or equal to 2.

One consequence is that this matcher always succeeds.

Specified by:

boundedUp in class RangeMatcherBuilder<V>

Parameters:

maxCycles - the maximum number of cycles (inclusive)

Returns:

a rule

exactly

protected Rule exactly(int nrCycles)

Description copied from class: RangeMatcherBuilder

Build a rule which is expected to match a fixed number of times

The returned matcher will attempt to match repeatedly up to, and including, the number of cycles given as an argument. Success should be declared if and only if the number of cycles matched is exactly this number.

Specified by:

exactly in class RangeMatcherBuilder<V>

Parameters:

nrCycles - the number of cycles (inclusive)

Returns:

a rule

boundedBoth

protected Rule boundedBoth(int minCycles,
               int maxCycles)

Description copied from class: RangeMatcherBuilder

Build a rule which is expected to match a number of times between two end points

The returned matcher will attempt to match repeatedly up to, and including, the maximum number of cycles specified as the second argument. Success should be declared if and only if the number of cycles performed is at least equal to the number of cycles specified as the first argument.

Note that the first argument will always be strictly greater than 0, and that the second argument will always be strictly greater than the first.

Specified by:

boundedBoth in class RangeMatcherBuilder<V>

Parameters:

minCycles - the minimum number of cycles (inclusive)

maxCycles - the maximum number of cycles (exclusive)

Returns:

a rule