Package io.micronaut.web.router

Class DefaultUriRouteMatch<T,R>

java.lang.Object

io.micronaut.web.router.DefaultUriRouteMatch<T,R>

Type Parameters:

T - The target type

R - The return type

All Implemented Interfaces:

AnnotatedElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, Named, UriMatchInfo, ExecutionHandle<T,R>, MethodExecutionHandle<T,R>, MethodReference<T,R>, MethodBasedRouteMatch<T,R>, RouteMatch<R>, UriRouteMatch<T,R>, Callable<R>

@Internal
public final class DefaultUriRouteMatch<T,R>
extends Object
implements UriRouteMatch<T,R>

Default implementation of the RouteMatch interface for matches to URIs.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConversionService	conversionService
protected final ExecutableMethod<T,R>	executableMethod
protected final MethodExecutionHandle<T,R>	methodExecutionHandle
protected final MethodBasedRouteInfo<T,R>	routeInfo
protected final UnsafeExecutionHandle<T,R>	unsafeMethodExecutionHandle

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 Type	Method	Description
R	execute()	Execute the route with the given values.
void	fulfill(Map<String,Object> newValues)	Fulfill argument values.
void	fulfillAfterFilters(RequestBinderRegistry requestBinderRegistry, HttpRequest<?> request)	Attempt to satisfy the arguments of the given route with the data from the given request.
void	fulfillBeforeFilters(RequestBinderRegistry requestBinderRegistry, HttpRequest<?> request)	Attempt to satisfy the arguments of the given route with the data from the given request.
@NonNull AnnotationMetadata	getAnnotationMetadata()	Supplies the metadata.
Argument<?>[]	getArguments()
Class<T>	getDeclaringType()
@NonNull ExecutableMethod<T,R>	getExecutableMethod()	The underlying ExecutableMethod reference.
HttpMethod	getHttpMethod()
String	getMethodName()
Optional<Argument<?>>	getRequiredInput(String name)	Return whether the given named input is required by this route.
ReturnType<R>	getReturnType()
UriRouteInfo<T,R>	getRouteInfo()
T	getTarget()	The target of the method invocation.
Method	getTargetMethod()
String	getUri()
Map<String,UriMatchVariable>	getVariableMap()
List<UriMatchVariable>	getVariables()
Map<String,Object>	getVariableValues()
R	invoke(Object... arguments)	Invokes the method.
boolean	isFulfilled()
boolean	isSatisfied(String name)	Is the given input satisfied.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, hasEvaluatedExpressions, hasStereotypeNonRepeating, 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.RouteMatch

call, execute, fulfill, fulfillAfterFilters, fulfillBeforeFilters, getRequiredInput, isFulfilled, isSatisfied

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

getRequiredArguments

Field Details

conversionService

protected final ConversionService conversionService

routeInfo

protected final MethodBasedRouteInfo<T,R> routeInfo

methodExecutionHandle

protected final MethodExecutionHandle<T,R> methodExecutionHandle

unsafeMethodExecutionHandle

protected final UnsafeExecutionHandle<T,R> unsafeMethodExecutionHandle

executableMethod

protected final ExecutableMethod<T,R> executableMethod

Method Details

getUri

public String getUri()

Specified by:

getUri in interface UriMatchInfo

Returns:

The matched URI

getVariableValues

public Map<String,Object> getVariableValues()

Specified by:

getVariableValues in interface RouteMatch<T>

Specified by:

getVariableValues in interface UriMatchInfo

Returns:

The variable values following a successful match

getVariables

public List<UriMatchVariable> getVariables()

Specified by:

getVariables in interface UriMatchInfo

Returns:

The list of template variables

getVariableMap

public Map<String,UriMatchVariable> getVariableMap()

Specified by:

getVariableMap in interface UriMatchInfo

Returns:

A map of the variables.

getRouteInfo

public UriRouteInfo<T,R> getRouteInfo()

Specified by:

getRouteInfo in interface RouteMatch<T>

Specified by:

getRouteInfo in interface UriRouteMatch<T,R>

Returns:

The route info

getHttpMethod

public HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface UriRouteMatch<T,R>

Returns:

The matched HTTP method

toString

public String toString()

Overrides:

toString in class Object

getTarget

public T getTarget()

Description copied from interface: ExecutionHandle

The target of the method invocation.

Specified by:

getTarget in interface ExecutionHandle<T,R>

Returns:

The target object

getExecutableMethod

@NonNull
public @NonNull ExecutableMethod<T,R> getExecutableMethod()

Description copied from interface: MethodExecutionHandle

The underlying ExecutableMethod reference.

Specified by:

getExecutableMethod in interface MethodExecutionHandle<T,R>

Returns:

The underlying method reference.

getAnnotationMetadata

@NonNull
public @NonNull AnnotationMetadata getAnnotationMetadata()

Description copied from interface: AnnotationMetadataProvider

Supplies the metadata. Defaults to AnnotationMetadata.EMPTY_METADATA.

Specified by:

getAnnotationMetadata in interface AnnotationMetadataProvider

Returns:

The AnnotationMetadata

getRequiredInput

public Optional<Argument<?>> getRequiredInput(String name)

Description copied from interface: RouteMatch

Return whether the given named input is required by this route.

Specified by:

getRequiredInput in interface RouteMatch<T>

Parameters:

name - The name of the input

Returns:

True if it is

isFulfilled

public boolean isFulfilled()

Specified by:

isFulfilled in interface RouteMatch<T>

Returns:

Whether the route match can be executed without passing any additional arguments i.e. via RouteMatch.execute()

isSatisfied

public boolean isSatisfied(String name)

Description copied from interface: RouteMatch

Is the given input satisfied.

Specified by:

isSatisfied in interface RouteMatch<T>

Parameters:

name - The name of the input

Returns:

True if it is

getTargetMethod

public Method getTargetMethod()

Specified by:

getTargetMethod in interface MethodReference<T,R>

Returns:

The target method

getMethodName

public String getMethodName()

Specified by:

getMethodName in interface MethodReference<T,R>

Returns:

The name of the method

getDeclaringType

public Class<T> getDeclaringType()

Specified by:

getDeclaringType in interface ExecutionHandle<T,R>

Specified by:

getDeclaringType in interface MethodReference<T,R>

Returns:

The declaring type

getArguments

public Argument<?>[] getArguments()

Specified by:

getArguments in interface ExecutionHandle<T,R>

Specified by:

getArguments in interface MethodReference<T,R>

Returns:

The required argument types.

getReturnType

public ReturnType<R> getReturnType()

Specified by:

getReturnType in interface MethodReference<T,R>

Returns:

Return the return type

invoke

public R invoke(Object... arguments)

Description copied from interface: ExecutionHandle

Invokes the method.

Specified by:

invoke in interface ExecutionHandle<T,R>

Parameters:

arguments - The arguments

Returns:

The result

execute

public R execute()

Description copied from interface: RouteMatch

Execute the route with the given values. Note if there are required arguments returned from RouteMatch.getRequiredArguments() this method will throw an IllegalArgumentException.

Specified by:

execute in interface RouteMatch<T>

Returns:

The result

fulfill

public void fulfill(Map<String,Object> newValues)

Description copied from interface: RouteMatch

Fulfill argument values.

Specified by:

fulfill in interface RouteMatch<T>

Parameters:

newValues - The argument values

fulfillBeforeFilters

public void fulfillBeforeFilters(RequestBinderRegistry requestBinderRegistry,
 HttpRequest<?> request)

Description copied from interface: RouteMatch

Attempt to satisfy the arguments of the given route with the data from the given request.

Specified by:

fulfillBeforeFilters in interface RouteMatch<T>

Parameters:

requestBinderRegistry - The request binder registry

request - The request

fulfillAfterFilters

public void fulfillAfterFilters(RequestBinderRegistry requestBinderRegistry,
 HttpRequest<?> request)

Description copied from interface: RouteMatch

Attempt to satisfy the arguments of the given route with the data from the given request.

Specified by:

fulfillAfterFilters in interface RouteMatch<T>

Parameters:

requestBinderRegistry - The request binder registry

request - The request