RouteMatch (micronaut 3.3.1 API)

Type Parameters:

R - The route

All Superinterfaces:

AnnotationMetadataProvider, AnnotationSource, Callable<R>, Predicate<HttpRequest>, RouteInfo<R>

All Known Subinterfaces:

MethodBasedRouteMatch<T,R>, UriRouteMatch<T,R>

All Known Implementing Classes:

BasicObjectRouteMatch
```
public interface RouteMatch<R>
extends Callable<R>, Predicate<HttpRequest>, RouteInfo<R>
```
A Route that is executable.

Since:

1.0

Author:

Graeme Rocher

Field Summary
- Fields inherited from interface io.micronaut.core.annotation.AnnotationSource
  EMPTY

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default R`	`call()` Same as `execute()`.
`RouteMatch<R>`	`decorate(Function<RouteMatch<R>,R> executor)` Decorates the execution of the route with the given executor.
`boolean`	`doesConsume(MediaType contentType)` Whether the specified content type is an accepted type.
`boolean`	`doesProduce(Collection<MediaType> acceptableTypes)` Whether the route does produce any of the given types.
`boolean`	`doesProduce(MediaType acceptableType)` Whether the route does produce any of the given types.
`default R`	`execute()` Execute the route with the given values.
`R`	`execute(Map<String,Object> argumentValues)` Execute the route with the given values.
`default boolean`	`explicitlyConsumes(MediaType contentType)` Whether the specified content type is explicitly an accepted type.
`default boolean`	`explicitlyProduces(MediaType contentType)` Whether the specified content type is explicitly a producing type.
`RouteMatch<R>`	`fulfill(Map<String,Object> argumentValues)` Returns a new `RouteMatch` fulfilling arguments required by this route to execute.
`Optional<Argument<?>>`	`getBodyArgument()`
`List<MediaType>`	`getProduces()` The media types able to produced by this route.
`default Collection<Argument>`	`getRequiredArguments()` Returns the required arguments for this RouteMatch.
`Optional<Argument<?>>`	`getRequiredInput(String name)` Return whether the given named input is required by this route.
`ReturnType<? extends R>`	`getReturnType()`
`Map<String,Object>`	`getVariableValues()`
`default boolean`	`isExecutable()`
`default boolean`	`isRequiredInput(String name)` Return whether the given named input is required by this route.
`default boolean`	`isSatisfied(String name)` Is the given input satisfied.

Methods inherited from interface java.util.function.Predicate
and, isEqual, negate, or, test

Methods inherited from interface io.micronaut.web.router.RouteInfo
findStatus, getBodyType, getConsumes, getDeclaringType, isAsync, isAsyncOrReactive, isCompletable, isErrorRoute, isReactive, isSingleResult, isSpecifiedSingle, isSuspended, isVoid, isWebSocketRoute

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataProvider
findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotationMetadata, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Methods inherited from interface io.micronaut.core.annotation.AnnotationSource
getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeDeclared

- Method Detail
  - getVariableValues
```
Map<String,Object> getVariableValues()
```
    Returns:
    
    The variable values following a successful match.
  - execute
```
R execute(Map<String,Object> argumentValues)
```
    Execute the route with the given values. The passed map should contain values for every argument returned by getRequiredArguments().
    
    Parameters:
    
    argumentValues - The argument values
    
    Returns:
    
    The result
  - fulfill
```
RouteMatch<R> fulfill(Map<String,Object> argumentValues)
```
    Returns a new RouteMatch fulfilling arguments required by this route to execute. The new route will not return the given arguments from the getRequiredArguments() method.
    
    Parameters:
    
    argumentValues - The argument values
    
    Returns:
    
    The fulfilled route
  - decorate
```
RouteMatch<R> decorate(Function<RouteMatch<R>,R> executor)
```
    Decorates the execution of the route with the given executor.
    
    Parameters:
    
    executor - The executor
    
    Returns:
    
    A new route match
  - getRequiredInput
```
Optional<Argument<?>> getRequiredInput(String name)
```
    Return whether the given named input is required by this route.
    
    Parameters:
    
    name - The name of the input
    
    Returns:
    
    True if it is
  - getBodyArgument
```
Optional<Argument<?>> getBodyArgument()
```
    Returns:
    
    The argument that represents the body
  - getProduces
```
List<MediaType> getProduces()
```
    The media types able to produced by this route.
    
    Specified by:
    
    getProduces in interface RouteInfo<R>
    
    Returns:
    
    A list of MediaType that this route can produce
  - getRequiredArguments
```
default Collection<Argument> getRequiredArguments()
```
    Returns the required arguments for this RouteMatch.
    
    Returns:
    
    The required arguments in order to invoke this route
  - getReturnType
```
ReturnType<? extends R> getReturnType()
```
    Specified by:
    
    getReturnType in interface RouteInfo<R>
    
    Returns:
    
    The return type
  - execute
```
default R execute()
```
    Execute the route with the given values. Note if there are required arguments returned from getRequiredArguments() this method will throw an IllegalArgumentException.
    
    Returns:
    
    The result
  - call
```
default R call()
        throws Exception
```
    Same as execute().
    
    Specified by:
    
    call in interface Callable<R>
    
    Returns:
    
    The result
    
    Throws:
    
    Exception - When an exception occurs
  - isExecutable
```
default boolean isExecutable()
```
    Returns:
    
    Whether the route match can be executed without passing any additional arguments ie. via execute()
  - isRequiredInput
```
default boolean isRequiredInput(String name)
```
    Return whether the given named input is required by this route.
    
    Parameters:
    
    name - The name of the input
    
    Returns:
    
    True if it is
  - doesConsume
```
boolean doesConsume(@Nullable
                    MediaType contentType)
```
    Whether the specified content type is an accepted type.
    
    Parameters:
    
    contentType - The content type
    
    Returns:
    
    True if it is
  - doesProduce
```
boolean doesProduce(@Nullable
                    Collection<MediaType> acceptableTypes)
```
    Whether the route does produce any of the given types.
    
    Parameters:
    
    acceptableTypes - The acceptable types
    
    Returns:
    
    True if it is
  - doesProduce
```
boolean doesProduce(@Nullable
                    MediaType acceptableType)
```
    Whether the route does produce any of the given types.
    
    Parameters:
    
    acceptableType - The acceptable type
    
    Returns:
    
    True if it is
  - explicitlyConsumes
```
default boolean explicitlyConsumes(@Nullable
                                   MediaType contentType)
```
    Whether the specified content type is explicitly an accepted type.
    
    Parameters:
    
    contentType - The content type
    
    Returns:
    
    True if it is
  - explicitlyProduces
```
default boolean explicitlyProduces(@Nullable
                                   MediaType contentType)
```
    Whether the specified content type is explicitly a producing type.
    
    Parameters:
    
    contentType - The content type
    
    Returns:
    
    True if it is
    
    Since:
    
    2.5.0
  - isSatisfied
```
default boolean isSatisfied(String name)
```
    Is the given input satisfied.
    
    Parameters:
    
    name - The name of the input
    
    Returns:
    
    True if it is

Interface RouteMatch<R>

Field Summary

Fields inherited from interface io.micronaut.core.annotation.AnnotationSource

Method Summary

Methods inherited from interface java.util.function.Predicate

Methods inherited from interface io.micronaut.web.router.RouteInfo

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataProvider

Methods inherited from interface io.micronaut.core.annotation.AnnotationSource

Method Detail

getVariableValues

execute

fulfill

decorate

getRequiredInput

getBodyArgument

getProduces

getRequiredArguments

getReturnType

execute

call

isExecutable

isRequiredInput

doesConsume

doesProduce

doesProduce

explicitlyConsumes

explicitlyProduces

isSatisfied