com.aol.cyclops.matcher.builders

Class Matching

java.lang.Object

com.aol.cyclops.matcher.builders.Matching

public class Matching
extends java.lang.Object

Pattern Matching builder

Constructor Summary

Constructors

Constructor and Description
Matching()

Method Summary

Modifier and Type	Method and Description
static <T,X> MatchingInstance<T,X>	of(Cases<T,X,? extends java.util.function.Function<T,X>> cases) Create a Pattern Matcher Builder from supplied Cases
static <X> ElementCase<X>	when() Create a builder for Matching against a provided Object as is (i.e.
static <V,X> CaseBuilder.InMatchOfBuilder<V,X>	whenAllMatch(org.hamcrest.Matcher<V>... matchers) Build a Case which is triggered when all of the supplied Hamcrest Matchers holds
static <V,X> CaseBuilder.InMatchOfBuilder<V,X>	whenAnyMatch(org.hamcrest.Matcher<V>... matchers) Build a Case which is triggered when any of the supplied Hamcrest Matchers holds
static <V,X> CaseBuilder.InMatchOfBuilder<V,X>	whenIsMatch(org.hamcrest.Matcher<V> match) Build a Case which is triggered when the supplied Hamcrest Matcher holds
static <V> CaseBuilder.InCaseOfBuilder<V>	whenIsTrue(java.util.function.Predicate<V> match) Build a Case which is triggered when the supplied Predicate holds
static <T,R> MatchingInstance<T,R>	whenIsType(TypedFunction<T,R> a) Create a completed Case which is triggered when matching input is of the same type (T) as the input parameter to ActionWithReturn.
static <V,X> Step<V,X>	whenIsValue(V value) Build a Case which is triggered when the user input matches the supplied Value (via Objects.equals)
static <V,X> CaseBuilder.InMatchOfBuilder<V,X>	whenNoneMatch(org.hamcrest.Matcher<V>... matchers) Build a Case which is triggered when none of the supplied Hamcrest Matchers holds

Methods inherited from class java.lang.Object

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

Constructor Detail

Matching

public Matching()

Method Detail

of

public static final <T,X> MatchingInstance<T,X> of(Cases<T,X,? extends java.util.function.Function<T,X>> cases)

Create a Pattern Matcher Builder from supplied Cases

Parameters:

cases - to match on

Returns:

Pattern Mather Builder

when

public static final <X> ElementCase<X> when()

Create a builder for Matching against a provided Object as is (i.e. the Steps this builder provide assume you don't wish to disaggregate it and match on it's decomposed parts separately). Allows matching by type, value, JDK 8 Predicate, or Hamcrest Matcher

Returns:

Simplex Element based Pattern Matching Builder

whenIsValue

public static final <V,X> Step<V,X> whenIsValue(V value)

Build a Case which is triggered when the user input matches the supplied Value (via Objects.equals)

Parameters:

value - will be compared to input provided in match method

Returns:

Next step in this Case builder

whenIsType

public static final <T,R> MatchingInstance<T,R> whenIsType(TypedFunction<T,R> a)

Create a completed Case which is triggered when matching input is of the same type (T) as the input parameter to ActionWithReturn. The ActionWithReturn will then be executed and the result returned as the match result.

Parameters:

a - Action for the new Case, Predicate for the Case will be created from the input type to the Action.

Returns:

Completed Case

whenIsTrue

public static final <V> CaseBuilder.InCaseOfBuilder<V> whenIsTrue(java.util.function.Predicate<V> match)

Build a Case which is triggered when the supplied Predicate holds

Parameters:

match - Predicate which will trigger this case

Returns:

Next Step in the Case Builder process

whenIsMatch

public static final <V,X> CaseBuilder.InMatchOfBuilder<V,X> whenIsMatch(org.hamcrest.Matcher<V> match)

Build a Case which is triggered when the supplied Hamcrest Matcher holds

Parameters:

match - Hamcrest Matcher that will trigger this case

Returns:

Next Step in the Case Builder process

whenAllMatch

@SafeVarargs
public static final <V,X> CaseBuilder.InMatchOfBuilder<V,X> whenAllMatch(org.hamcrest.Matcher<V>... matchers)

Build a Case which is triggered when all of the supplied Hamcrest Matchers holds

Parameters:

matchers - Hamcrest Matchers that will trigger this case

Returns:

Next Step in the Case Builder process

whenAnyMatch

@SafeVarargs
public static final <V,X> CaseBuilder.InMatchOfBuilder<V,X> whenAnyMatch(org.hamcrest.Matcher<V>... matchers)

Build a Case which is triggered when any of the supplied Hamcrest Matchers holds

Parameters:

matchers - Hamcrest Matchers that will trigger this case

Returns:

Next Step in the Case Builder process

whenNoneMatch

@SafeVarargs
public static final <V,X> CaseBuilder.InMatchOfBuilder<V,X> whenNoneMatch(org.hamcrest.Matcher<V>... matchers)

Build a Case which is triggered when none of the supplied Hamcrest Matchers holds

Parameters:

matchers - Hamcrest Matchers that will trigger this case

Returns:

Next Step in the Case Builder process