Package io.micronaut.web.router
Interface UriRouteMatch<T,R>
- Type Parameters:
T
- The target typeR
- The return type
- All Superinterfaces:
AnnotatedElement
,AnnotationMetadata
,AnnotationMetadataDelegate
,AnnotationMetadataProvider
,AnnotationSource
,Callable<R>
,ExecutionHandle<T,
,R> MethodBasedRouteMatch<T,
,R> MethodExecutionHandle<T,
,R> MethodReference<T,
,R> Named
,Predicate<HttpRequest>
,RouteInfo<R>
,RouteMatch<R>
,UriMatchInfo
A
RouteMatch
that matches a URI and HttpMethod
.- Since:
- 1.0
- Author:
- Graeme Rocher
-
Field Summary
Fields inherited from interface io.micronaut.core.annotation.AnnotationMetadata
CLASS_NAME_SUFFIX, EMPTY_METADATA, VALUE_MEMBER
Fields inherited from interface io.micronaut.core.annotation.AnnotationSource
EMPTY
-
Method Summary
Modifier and TypeMethodDescriptiondecorate
(Function<RouteMatch<R>, R> executor) Decorates the execution of the route with the given executor.Returns a newRouteMatch
fulfilling arguments required by this route to execute.Returns the required arguments for this RouteMatch.getRoute()
Methods inherited from interface io.micronaut.core.annotation.AnnotatedElement
isDeclaredNonNull, isDeclaredNullable, isNonNull, isNullable
Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadata
enumValuesSet, enumValuesSet, getValues, hasDeclaredStereotype, isAnnotationPresent, isDeclaredAnnotationPresent
Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataDelegate
booleanValue, booleanValue, booleanValue, booleanValue, classValue, classValue, classValue, classValue, classValues, classValues, classValues, classValues, copyAnnotationMetadata, doubleValue, doubleValue, doubleValue, enumValue, enumValue, enumValue, enumValue, enumValues, enumValues, enumValues, enumValues, findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, findRepeatableAnnotation, findRepeatableAnnotation, getAnnotation, getAnnotation, getAnnotationNameByStereotype, getAnnotationNameByStereotype, getAnnotationNames, getAnnotationNamesByStereotype, getAnnotationNamesByStereotype, getAnnotationType, getAnnotationType, getAnnotationTypeByStereotype, getAnnotationTypeByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getAnnotationValuesByName, getAnnotationValuesByStereotype, getAnnotationValuesByType, getDeclaredAnnotation, getDeclaredAnnotation, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationValuesByName, getDeclaredAnnotationValuesByType, getDeclaredMetadata, getDeclaredStereotypeAnnotationNames, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValues, getStereotypeAnnotationNames, getTargetAnnotationMetadata, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, getValues, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasDeclaredStereotype, hasDeclaredStereotype, hasPropertyExpressions, hasSimpleAnnotation, hasSimpleDeclaredAnnotation, hasStereotype, hasStereotype, hasStereotype, hasStereotype, intValue, intValue, intValue, isAnnotationPresent, isDeclaredAnnotationPresent, isEmpty, isFalse, isFalse, isPresent, isPresent, isRepeatableAnnotation, isRepeatableAnnotation, isTrue, isTrue, longValue, longValue, stringValue, stringValue, stringValue, stringValue, stringValues, stringValues, stringValues, stringValues, synthesize, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType
Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataProvider
getAnnotationMetadata
Methods inherited from interface io.micronaut.inject.ExecutionHandle
getArguments, getDeclaringType, getTarget, invoke
Methods inherited from interface io.micronaut.inject.MethodExecutionHandle
getExecutableMethod
Methods inherited from interface io.micronaut.inject.MethodReference
getArgumentNames, getArguments, getArgumentTypes, getDeclaringType, getMethodName, getName, getReturnType, getTargetMethod
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.web.router.RouteMatch
call, doesConsume, doesProduce, doesProduce, execute, execute, explicitlyConsumes, explicitlyProduces, getBodyArgument, getProduces, getRequiredInput, getReturnType, getVariableValues, isExecutable, isRequiredInput, isSatisfied
Methods inherited from interface io.micronaut.http.uri.UriMatchInfo
getUri, getVariableMap, getVariables, getVariableValues
-
Method Details
-
getRoute
UriRoute getRoute()- Returns:
- The backing
UriRoute
-
getRequiredArguments
Returns the required arguments for this RouteMatch.
Note that this is not the save as
ExecutionHandle.getArguments()
as it will include a subset of the arguments excluding those that have been subtracted from the URI variables- Specified by:
getRequiredArguments
in interfaceMethodBasedRouteMatch<T,
R> - Specified by:
getRequiredArguments
in interfaceRouteMatch<T>
- Returns:
- The required arguments in order to invoke this route
-
getHttpMethod
HttpMethod getHttpMethod()- Returns:
- The matched HTTP method
-
fulfill
Description copied from interface:RouteMatch
Returns a newRouteMatch
fulfilling arguments required by this route to execute. The new route will not return the given arguments from theRouteMatch.getRequiredArguments()
method.- Specified by:
fulfill
in interfaceRouteMatch<T>
- Parameters:
argumentValues
- The argument values- Returns:
- The fulfilled route
-
decorate
Description copied from interface:RouteMatch
Decorates the execution of the route with the given executor.- Specified by:
decorate
in interfaceRouteMatch<T>
- Parameters:
executor
- The executor- Returns:
- A new route match
-