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 <X> MatchingInstance<? extends java.lang.Object,X>	when(java.util.function.Function<CheckTypeAndValues<? extends java.lang.Object>,MatchingInstance<? extends java.lang.Object,X>> fn) Deprecated.
static StreamCase	whenFromStream() Create a builder that builds Pattern Matching Cases from Streams of data.
static <T,X> MatchingInstance<T,X>	whenFromStream(java.util.function.Function<CaseBeingBuilt,MatchingInstance<T,X>> fn) Deprecated.
static <USER_VALUE> IterableCase<USER_VALUE>	whenIterable() Create a builder for matching on the disaggregated elements of a collection.
static <X> MatchingInstance<? extends java.lang.Object,X>	whenIterable(java.util.function.Function<IterableCase<? extends java.lang.Object>,MatchingInstance<? extends java.lang.Object,X>> fn) Deprecated.
static <USER_VALUE> CheckTypeAndValues<USER_VALUE>	whenValues() Create a builder for Matching on Case classes.
static <X> MatchingInstance<? extends java.lang.Object,X>	whenValues(java.util.function.Function<ElementCase<X>,MatchingInstance<? extends java.lang.Object,X>> fn) Deprecated.

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

whenValues

public static final <USER_VALUE> CheckTypeAndValues<USER_VALUE> whenValues()

Create a builder for Matching on Case classes. This is the closest builder for Scala / ML style pattern matching. Case classes can be constructed succintly in Java with Lombok or jADT e.g.

 \@Value final class CaseClass implements Decomposable { int field1; String field2;}
 

Use with static imports from the Predicates class to get wildcards via '__' or ANY() And to apply nested / recursive matching via Predicates.type( ).with ( ) Match disaggregated elements by type, value, JDK 8 Predicate or Hamcrest Matcher

Returns:

Case Class style Pattern Matching 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

whenIterable

public static final <USER_VALUE> IterableCase<USER_VALUE> whenIterable()

Create a builder for matching on the disaggregated elements of a collection. Allows matching by type, value, JDK 8 Predicate, or Hamcrest Matcher per element

Returns:

Iterable / Collection based Pattern Matching Builder

whenFromStream

public static final StreamCase whenFromStream()

Create a builder that builds Pattern Matching Cases from Streams of data.

Returns:

Stream based Pattern Matching Builder

when

@Deprecated
public static final <X> MatchingInstance<? extends java.lang.Object,X> when(java.util.function.Function<CheckTypeAndValues<? extends java.lang.Object>,MatchingInstance<? extends java.lang.Object,X>> fn)

Deprecated.

Create a builder for Matching on Case classes. This is the closest builder for Scala / ML style pattern matching. Case classes can be constructed succintly in Java with Lombok or jADT e.g.

 \@Value final class CaseClass implements Decomposable { int field1; String field2;}
 

Use with static imports from the Predicates class to get wildcards via '__' or ANY() And to apply nested / recursive matching via Predicates.type( ).with ( ) Match disaggregated elements by type, value, JDK 8 Predicate or Hamcrest Matcher

Parameters:

fn - Function that accepts the Case for Case classes and returns the output of that builder

Returns:

Pattern Matching Builder

whenValues

@Deprecated
public static final <X> MatchingInstance<? extends java.lang.Object,X> whenValues(java.util.function.Function<ElementCase<X>,MatchingInstance<? extends java.lang.Object,X>> fn)

Deprecated.

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

Parameters:

fn - Function that accepts a Simplex Element based Pattern Matching Builder and returns it's output

Returns:

Pattern Matching Builder

whenIterable

@Deprecated
public static final <X> MatchingInstance<? extends java.lang.Object,X> whenIterable(java.util.function.Function<IterableCase<? extends java.lang.Object>,MatchingInstance<? extends java.lang.Object,X>> fn)

Deprecated.

Create a builder for matching on the disaggregated elements of a collection. Allows matching by type, value, JDK 8 Predicate, or Hamcrest Matcher per element

Parameters:

fn - a Function that accepts a Iterable / Collection based Pattern Matching Builder and returns it's output

Returns:

Pattern Matching Builder

whenFromStream

@Deprecated
public static final <T,X> MatchingInstance<T,X> whenFromStream(java.util.function.Function<CaseBeingBuilt,MatchingInstance<T,X>> fn)

Deprecated.

Create a builder that builds Pattern Matching Cases from Streams of data.

Parameters:

fn - a function that accepts a Stream based pattern matching builder

Returns:

Pattern Matching Builder