R
- The routepublic interface RouteMatch<R> extends Callable<R>, Predicate<HttpRequest>, RouteInfo<R>
Route
that is executable.EMPTY
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.
|
findStatus, getBodyType, getConsumes, getDeclaringType, isAsync, isAsyncOrReactive, isCompletable, isErrorRoute, isReactive, isSingleResult, isSpecifiedSingle, isSuspended, isVoid, isWebSocketRoute
findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotationMetadata, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType
getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeDeclared
Map<String,Object> getVariableValues()
R execute(Map<String,Object> argumentValues)
getRequiredArguments()
.argumentValues
- The argument valuesRouteMatch<R> fulfill(Map<String,Object> argumentValues)
RouteMatch
fulfilling arguments required by this route to execute. The new route will not
return the given arguments from the getRequiredArguments()
method.argumentValues
- The argument valuesRouteMatch<R> decorate(Function<RouteMatch<R>,R> executor)
executor
- The executorOptional<Argument<?>> getRequiredInput(String name)
name
- The name of the inputOptional<Argument<?>> getBodyArgument()
List<MediaType> getProduces()
getProduces
in interface RouteInfo<R>
MediaType
that this route can producedefault Collection<Argument> getRequiredArguments()
Returns the required arguments for this RouteMatch.
ReturnType<? extends R> getReturnType()
getReturnType
in interface RouteInfo<R>
default R execute()
getRequiredArguments()
this method will throw an IllegalArgumentException
.default boolean isExecutable()
execute()
default boolean isRequiredInput(String name)
name
- The name of the inputboolean doesConsume(@Nullable MediaType contentType)
contentType
- The content typeboolean doesProduce(@Nullable Collection<MediaType> acceptableTypes)
acceptableTypes
- The acceptable typesboolean doesProduce(@Nullable MediaType acceptableType)
acceptableType
- The acceptable typedefault boolean explicitlyConsumes(@Nullable MediaType contentType)
contentType
- The content typedefault boolean explicitlyProduces(@Nullable MediaType contentType)
contentType
- The content typedefault boolean isSatisfied(String name)
name
- The name of the input