io.micronaut.http.bind.binders

Class HeaderAnnotationBinder<T>

java.lang.Object

io.micronaut.core.bind.annotation.AbstractAnnotatedArgumentBinder<Header,T,HttpRequest<?>>

io.micronaut.http.bind.binders.HeaderAnnotationBinder<T>

Type Parameters:

T - A type

All Implemented Interfaces:

AnnotatedArgumentBinder<Header,T,HttpRequest<?>>, ArgumentBinder<T,HttpRequest<?>>, AnnotatedRequestArgumentBinder<Header,T>, RequestArgumentBinder<T>

public class HeaderAnnotationBinder<T>
extends AbstractAnnotatedArgumentBinder<Header,T,HttpRequest<?>>
implements AnnotatedRequestArgumentBinder<Header,T>

An AnnotatedArgumentBinder implementation that uses the Header annotation to trigger binding from an HTTP header.

Since:

1.0

Author:

Graeme Rocher

See Also:

HttpHeaders

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.core.bind.ArgumentBinder

ArgumentBinder.BindingResult<T>

Constructor Summary

Constructors

Constructor and Description
HeaderAnnotationBinder(ConversionService<?> conversionService)

Method Summary

Modifier and Type	Method and Description
ArgumentBinder.BindingResult<T>	bind(ArgumentConversionContext<T> argument, HttpRequest<?> source) Bind the given argument from the given source.
Class<Header>	getAnnotationType()
protected String	getFallbackFormat(Argument argument)

Methods inherited from class io.micronaut.core.bind.annotation.AbstractAnnotatedArgumentBinder

doBind, doConvert, doResolve

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.bind.binders.AnnotatedRequestArgumentBinder

of

Constructor Detail

HeaderAnnotationBinder

public HeaderAnnotationBinder(ConversionService<?> conversionService)

Parameters:

conversionService - The conversion service

Method Detail

bind

public ArgumentBinder.BindingResult<T> bind(ArgumentConversionContext<T> argument,
                                            HttpRequest<?> source)

Description copied from interface: ArgumentBinder

Bind the given argument from the given source.

Specified by:

bind in interface ArgumentBinder<T,HttpRequest<?>>

Parameters:

argument - The ArgumentConversionContext

source - The source

Returns:

An Optional of the value. If no binding was possible Optional.empty()

getAnnotationType

public Class<Header> getAnnotationType()

Specified by:

getAnnotationType in interface AnnotatedArgumentBinder<Header,T,HttpRequest<?>>

Returns:

The annotation type.

getFallbackFormat

protected String getFallbackFormat(Argument argument)

Overrides:

getFallbackFormat in class AbstractAnnotatedArgumentBinder<Header,T,HttpRequest<?>>

Parameters:

argument - The argument

Returns:

The fallback format