com.aol.cyclops.matcher.builders

Class CollectionMatchingInstance<T,X>

java.lang.Object

com.aol.cyclops.matcher.builders.CollectionMatchingInstance<T,X>

All Implemented Interfaces:

java.util.function.Function<T,java.util.Optional<X>>

public class CollectionMatchingInstance<T,X>
extends java.lang.Object
implements java.util.function.Function<T,java.util.Optional<X>>

Constructor Summary

Constructors

Constructor and Description
CollectionMatchingInstance()

Method Summary

Modifier and Type	Method and Description
java.util.Optional<X>	apply(java.lang.Object t)
java.util.function.Function<T,java.util.stream.Stream<X>>	asStreamFunction()
java.util.function.Function<T,X>	asUnwrappedFunction()
com.aol.cyclops.matcher.Cases<T,X,com.aol.cyclops.matcher.TypedFunction<T,X>>	cases()
java.util.Optional<X>	match(java.lang.Object... t) Aggregates supplied objects into a List for matching against
java.util.Optional<X>	match(java.lang.Object t)
<R> java.util.stream.Stream<R>	matchFromStream(java.util.stream.Stream s) Each input element can generated a single matched value
<R> java.util.stream.Stream<R>	matchMany(java.lang.Object t)
<R> java.util.stream.Stream<R>	matchManyFromStream(java.util.stream.Stream s) Each input element can generated multiple matched values
java.util.Optional<X>	unapply(com.aol.cyclops.objects.Decomposable decomposableObject) Immediately decompose the supplied parameter and pass it to the PatternMatcher for matching
StreamCase	whenFromStream() Create a builder that builds Pattern Matching Cases from Streams of data.
IterableCase<X>	whenIterable() Create a builder for matching on the disaggregated elements of a collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

CollectionMatchingInstance

public CollectionMatchingInstance()

Method Detail

cases

public final com.aol.cyclops.matcher.Cases<T,X,com.aol.cyclops.matcher.TypedFunction<T,X>> cases()

whenIterable

public final IterableCase<X> 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 final StreamCase whenFromStream()

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

Returns:

Stream based Pattern Matching Builder

asUnwrappedFunction

public java.util.function.Function<T,X> asUnwrappedFunction()

Returns:

Pattern Matcher as function that will return the 'unwrapped' result when apply is called. i.e. Optional#get will be called.

asStreamFunction

public java.util.function.Function<T,java.util.stream.Stream<X>> asStreamFunction()

Returns:

Pattern Matcher as a function that will return a Stream of results

apply

public java.util.Optional<X> apply(java.lang.Object t)

Specified by:

apply in interface java.util.function.Function<T,java.util.Optional<X>>

matchManyFromStream

public <R> java.util.stream.Stream<R> matchManyFromStream(java.util.stream.Stream s)

Each input element can generated multiple matched values

Parameters:

s - Stream of data to match against (input to matcher)

Returns:

Stream of values from matched cases

matchMany

public <R> java.util.stream.Stream<R> matchMany(java.lang.Object t)

Parameters:

t - input to match against - can generate multiple values

Returns:

Stream of values from matched cases for the input

matchFromStream

public <R> java.util.stream.Stream<R> matchFromStream(java.util.stream.Stream s)

Each input element can generated a single matched value

Parameters:

s - Stream of data to match against (input to matcher)

Returns:

Stream of matched values, one case per input value can match

match

public java.util.Optional<X> match(java.lang.Object... t)

Aggregates supplied objects into a List for matching against

 assertThat(Cases.of(Case.of((List<Integer> input) -> input.size()==3, input -> "hello"),
                        Case.of((List<Integer> input) -> input.size()==2, input -> "ignored"),
                        Case.of((List<Integer> input) -> input.size()==1, input -> "world")).match(1,2,3).get(),is("hello"));

 

Parameters:

t - Array to match on

Returns:

Matched value wrapped in Optional

match

public java.util.Optional<X> match(java.lang.Object t)

Parameters:

t - Object to match against supplied cases

Returns:

Value returned from matched case (if present) otherwise Optional.empty()

unapply

public java.util.Optional<X> unapply(com.aol.cyclops.objects.Decomposable decomposableObject)

Immediately decompose the supplied parameter and pass it to the PatternMatcher for matching

Parameters:

decomposableObject - Object to match on after decomposed via unapply method

Returns:

Matching result