io.micronaut.web.router

Class BasicObjectRouteMatch

java.lang.Object

io.micronaut.web.router.BasicObjectRouteMatch

All Implemented Interfaces:

AnnotationMetadataProvider, AnnotationSource, RouteInfo<Object>, RouteMatch<Object>, Callable<Object>, Predicate<HttpRequest>

public class BasicObjectRouteMatch
extends Object
implements RouteMatch<Object>

A route match designed to return an existing object.

Since:

1.0

Author:

James Kleeh

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
BasicObjectRouteMatch(Object object)

Method Summary

Modifier and Type	Method and Description
RouteMatch<Object>	decorate(Function<RouteMatch<Object>,Object> 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.
Object	execute(Map<String,Object> argumentValues) Execute the route with the given values.
RouteMatch<Object>	fulfill(Map<String,Object> argumentValues) Returns a new RouteMatch fulfilling arguments required by this route to execute.
Optional<Argument<?>>	getBodyArgument()
Class<?>	getDeclaringType()
List<MediaType>	getProduces() The media types able to produced by this route.
Optional<Argument<?>>	getRequiredInput(String name) Return whether the given named input is required by this route.
ReturnType<?>	getReturnType()
Map<String,Object>	getVariableValues()
boolean	test(HttpRequest httpRequest)

Methods inherited from class java.lang.Object

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

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

call, execute, explicitlyConsumes, explicitlyProduces, getRequiredArguments, isExecutable, isRequiredInput, isSatisfied

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

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

findStatus, getBodyType, getConsumes, 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

Constructor Detail

BasicObjectRouteMatch

public BasicObjectRouteMatch(Object object)

Parameters:

object - An object

Method Detail

getDeclaringType

public Class<?> getDeclaringType()

Specified by:

getDeclaringType in interface RouteInfo<Object>

Returns:

The declaring type of the route.

getVariableValues

public Map<String,Object> getVariableValues()

Specified by:

getVariableValues in interface RouteMatch<Object>

Returns:

The variable values following a successful match.

execute

public Object execute(Map<String,Object> argumentValues)

Description copied from interface: RouteMatch

Execute the route with the given values. The passed map should contain values for every argument returned by RouteMatch.getRequiredArguments().

Specified by:

execute in interface RouteMatch<Object>

Parameters:

argumentValues - The argument values

Returns:

The result

fulfill

public RouteMatch<Object> fulfill(Map<String,Object> argumentValues)

Description copied from interface: RouteMatch

Returns a new RouteMatch fulfilling arguments required by this route to execute. The new route will not return the given arguments from the RouteMatch.getRequiredArguments() method.

Specified by:

fulfill in interface RouteMatch<Object>

Parameters:

argumentValues - The argument values

Returns:

The fulfilled route

decorate

public RouteMatch<Object> decorate(Function<RouteMatch<Object>,Object> executor)

Description copied from interface: RouteMatch

Decorates the execution of the route with the given executor.

Specified by:

decorate in interface RouteMatch<Object>

Parameters:

executor - The executor

Returns:

A new route match

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<Object>

Parameters:

name - The name of the input

Returns:

True if it is

getBodyArgument

public Optional<Argument<?>> getBodyArgument()

Specified by:

getBodyArgument in interface RouteMatch<Object>

Returns:

The argument that represents the body

getProduces

public List<MediaType> getProduces()

Description copied from interface: RouteMatch

The media types able to produced by this route.

Specified by:

getProduces in interface RouteInfo<Object>

Specified by:

getProduces in interface RouteMatch<Object>

Returns:

A list of MediaType that this route can produce

getReturnType

public ReturnType<?> getReturnType()

Specified by:

getReturnType in interface RouteInfo<Object>

Specified by:

getReturnType in interface RouteMatch<Object>

Returns:

The return type

doesConsume

public boolean doesConsume(@Nullable
                           MediaType contentType)

Description copied from interface: RouteMatch

Whether the specified content type is an accepted type.

Specified by:

doesConsume in interface RouteMatch<Object>

Parameters:

contentType - The content type

Returns:

True if it is

doesProduce

public boolean doesProduce(@Nullable
                           Collection<MediaType> acceptableTypes)

Description copied from interface: RouteMatch

Whether the route does produce any of the given types.

Specified by:

doesProduce in interface RouteMatch<Object>

Parameters:

acceptableTypes - The acceptable types

Returns:

True if it is

doesProduce

public boolean doesProduce(@Nullable
                           MediaType acceptableType)

Description copied from interface: RouteMatch

Whether the route does produce any of the given types.

Specified by:

doesProduce in interface RouteMatch<Object>

Parameters:

acceptableType - The acceptable type

Returns:

True if it is

test

public boolean test(HttpRequest httpRequest)

Specified by:

test in interface Predicate<HttpRequest>