Package io.micronaut.web.router.version.resolution

Class ParameterVersionResolver

java.lang.Object

io.micronaut.web.router.version.resolution.ParameterVersionResolver

All Implemented Interfaces:

RequestVersionResolver, VersionResolver<io.micronaut.http.HttpRequest<?>,String>

@Singleton
@Requires(beans={RoutesVersioningConfiguration.class,ParameterVersionResolverConfiguration.class})
public class ParameterVersionResolver
extends Object
implements RequestVersionResolver

A RequestVersionResolver responsible for extracting version from HttpParameters.

Since:

1.1.0

Constructor Summary

Constructors

Constructor	Description
ParameterVersionResolver(ParameterVersionResolverConfiguration configuration)	Creates a RequestVersionResolver to extract version from request parameter.

Method Summary

Modifier and Type	Method	Description
Optional<String>	resolve(io.micronaut.http.HttpRequest<?> request)	Resolves a version from a given object.

Methods inherited from class java.lang.Object

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

Constructor Details

ParameterVersionResolver

public ParameterVersionResolver(ParameterVersionResolverConfiguration configuration)

Creates a RequestVersionResolver to extract version from request parameter.

Parameters:

configuration - A configuration to pick correct request parameter names.

Method Details

resolve

public Optional<String> resolve(io.micronaut.http.HttpRequest<?> request)

Description copied from interface: VersionResolver

Resolves a version from a given object.

Specified by:

resolve in interface VersionResolver<io.micronaut.http.HttpRequest<?>,String>

Parameters:

request - The type of object to resolve from

Returns:

An optional object representing the version