MatchingInstance (cyclops-pattern-matching 5.1.0 API)

java.lang.Object
- com.aol.cyclops.matcher.builders.MatchingInstance<T,X>

Type Parameters:

T -

X -

All Implemented Interfaces:

java.util.function.Function<T,java.util.Optional<X>>
```
public class MatchingInstance<T,X>
extends java.lang.Object
implements java.util.function.Function<T,java.util.Optional<X>>
```
Pattern Matching builder instance

Constructor Summary

Constructors
Constructor and Description

MatchingInstance()

Constructors
Constructor and Description
`MatchingInstance()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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()`
`Cases<T,X,ActionWithReturn<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.lambda.api.Decomposable decomposableObject)` Immediately decompose the supplied parameter and pass it to the PatternMatcher for matching
`ElementCase<X>`	`when()` Create a builder for Matching against a provided Object as is (i.e.
`MatchingInstance<? extends java.lang.Object,X>`	`when(java.util.function.Function<ElementCase<X>,MatchingInstance<? extends java.lang.Object,X>> fn)` Deprecated.
`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.
`MatchingInstance<? extends java.lang.Object,X>`	`whenIterable(java.util.function.Function<IterableCase<? extends java.lang.Object>,MatchingInstance<? extends java.lang.Object,X>> fn)` Create a builder for matching on the disaggregated elements of a collection.
`MatchingInstance<T,X>`	`whenStream(java.util.function.Function<CaseBeingBuilt,MatchingInstance<T,X>> fn)` Deprecated.
`CheckTypeAndValues<X>`	`whenValues()` Create a builder for Matching on Case classes.
`MatchingInstance<? extends java.lang.Object,X>`	`whenValues(java.util.function.Function<CheckTypeAndValues<? extends java.lang.Object>,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

Methods inherited from interface java.util.function.Function
andThen, compose, identity

- Constructor Detail
  - MatchingInstance
```
public MatchingInstance()
```
- Method Detail
  - cases
```
public final Cases<T,X,ActionWithReturn<T,X>> cases()
```
  - whenValues
```
public final CheckTypeAndValues<X> 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 final 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 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
  - whenValues
```
@Deprecated
public final MatchingInstance<? extends java.lang.Object,X> whenValues(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
  - when
```
@Deprecated
public final MatchingInstance<? extends java.lang.Object,X> when(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
```
public final MatchingInstance<? extends java.lang.Object,X> whenIterable(java.util.function.Function<IterableCase<? extends java.lang.Object>,MatchingInstance<? extends java.lang.Object,X>> fn)
```
    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
  - whenStream
```
@Deprecated
public final MatchingInstance<T,X> whenStream(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
  - 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.lambda.api.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

Class MatchingInstance<T,X>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.function.Function

Constructor Detail

MatchingInstance

Method Detail

cases

whenValues

when

whenIterable

whenFromStream

whenValues

when

whenIterable

whenStream

asUnwrappedFunction

asStreamFunction

apply

matchManyFromStream

matchMany

matchFromStream

match

match

unapply