BoundMatch (fdb-record-layer-core-pb3 2.10.164.0 API)

java.lang.Object
- com.apple.foundationdb.record.query.plan.temp.matching.BoundMatch<R>

Type Parameters:

R - result type
```
public class BoundMatch<R>
extends Object
```
Case class to represent a match for matchers that compute a result. Each bound map uses an AliasMap to describe the match itself together with an (optional) result of some sort of type R

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AliasMap`	`getAliasMap()`
`R`	`getMatchResult()`
`Optional<R>`	`getMatchResultOptional()`
`static <R> BoundMatch<R>`	`withAliasMap(AliasMap aliasMap)`	Factory method to create a bound match with no match result.
`static <R> BoundMatch<R>`	`withAliasMapAndMatchResult(AliasMap aliasMap, R matchResult)`	Factory method to create a bound match with a proper match result.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getAliasMap
```
@Nonnull
public AliasMap getAliasMap()
```
  - getMatchResultOptional
```
@Nonnull
public Optional<R> getMatchResultOptional()
```
  - getMatchResult
```
@Nonnull
public R getMatchResult()
```
  - withAliasMapAndMatchResult
```
@Nonnull
public static <R> BoundMatch<R> withAliasMapAndMatchResult(AliasMap aliasMap,
                                                           @Nonnull
                                                           R matchResult)
```
    Factory method to create a bound match with a proper match result.
    
    Type Parameters:
    
    R - result type
    
    Parameters:
    
    aliasMap - the alias map for this match containing all mappings necessary to describe this match (even bindings coming from external (deep) correlations
    
    matchResult - a match result
    
    Returns:
    
    a newly created bound match
  - withAliasMap
```
@Nonnull
public static <R> BoundMatch<R> withAliasMap(AliasMap aliasMap)
```
    Factory method to create a bound match with no match result.
    
    Type Parameters:
    
    R - result type
    
    Parameters:
    
    aliasMap - the alias map for this match containing all mappings necessary to describe this match (even bindings coming from external (deep) correlations
    
    Returns:
    
    a newly created bound match that does not hold a match result