com.aol.cyclops.internal.matcher2

Class PatternMatcher

java.lang.Object

com.aol.cyclops.internal.matcher2.PatternMatcher

All Implemented Interfaces:

java.util.function.Function

public class PatternMatcher
extends java.lang.Object
implements java.util.function.Function

PatternMatcher supports advanced pattern matching for Java 8 This is an API for creating Case instances and allows new type definitions to be supplied for each Case Features include -cases match by value -cases match by type -cases using predicates inCaseOfXXX caseOfXXX -cases using hamcrest Matchers inMatchOfXXX matchOfXXX -cases as expressions (return value) - inCaseOfXXX, inMatchOfXXX -cases as statements (no return value) - caseOfXXX, matchOfXXX -pre & post variable extraction via Extractor (@see com.aol.cyclops.matcher.Extractors) -match using iterables of predicates or hamcrest Matchers - see caseOfIterable, matchOfIterable, inCaseOfIterable, matchOfIterable -match using tuples of predicates or hamcreate Matchers - see caseOfTuple, matchOfTuple, inCaseOfTuple, inMatchOfTuple - single match (match method) - match many (matchMany) - match against a stream (single match, match many)

Constructor Summary

Constructors

Constructor and Description
PatternMatcher()

Method Summary

Modifier and Type	Method and Description
Maybe<java.lang.Object>	apply(java.lang.Object t)
<T,X> java.util.function.Function<T,X>	asUnwrappedFunction()
<V,X> PatternMatcher	inCaseOf(java.util.function.Predicate<V> match, java.util.function.Function<? super V,? extends X> a)
<T,V,X> PatternMatcher	inCaseOfManyType(java.util.function.Predicate master, java.util.function.Function<? super T,? extends X> a, java.util.function.Predicate<V>... predicates)
<R,T,X> PatternMatcher	inCaseOfThenExtract(java.util.function.Predicate<T> match, java.util.function.Function<? super R,? extends X> a, Extractor<T,R> extractor)
<R> Maybe<R>	match(java.lang.Object... t) Aggregates supplied objects into a List for matching against
<R> Maybe<R>	match(java.lang.Object t)
<R> Maybe<R>	unapply(Decomposable t) Decomposes the supplied input via it's unapply method Provides a List to the Matcher of values to match on

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

PatternMatcher

public PatternMatcher()

Method Detail

asUnwrappedFunction

public <T,X> 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.

apply

public Maybe<java.lang.Object> apply(java.lang.Object t)

Specified by:

apply in interface java.util.function.Function

match

public <R> Maybe<R> match(java.lang.Object... t)

Aggregates supplied objects into a List for matching against

Parameters:

t - Array to match on

Returns:

Matched value wrapped in Optional

unapply

public <R> Maybe<R> unapply(Decomposable t)

Decomposes the supplied input via it's unapply method Provides a List to the Matcher of values to match on

Parameters:

t - Object to decompose and match on

Returns:

Matched result wrapped in an Optional

match

public <R> Maybe<R> match(java.lang.Object t)

Parameters:

t - Object to match against supplied cases

Returns:

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

inCaseOfManyType

public <T,V,X> PatternMatcher inCaseOfManyType(java.util.function.Predicate master,
                                               java.util.function.Function<? super T,? extends X> a,
                                               java.util.function.Predicate<V>... predicates)

inCaseOf

public <V,X> PatternMatcher inCaseOf(java.util.function.Predicate<V> match,
                                     java.util.function.Function<? super V,? extends X> a)

inCaseOfThenExtract

public <R,T,X> PatternMatcher inCaseOfThenExtract(java.util.function.Predicate<T> match,
                                                  java.util.function.Function<? super R,? extends X> a,
                                                  Extractor<T,R> extractor)