io.micronaut.core.bind

Interface ArgumentBinder<T,S>

Type Parameters:

T - The argument type

S - The source type

All Known Subinterfaces:

AnnotatedArgumentBinder<A,T,S>, AnnotatedRequestArgumentBinder<A,T>, BeanPropertyBinder, BodyArgumentBinder<T>, NonBlockingBodyArgumentBinder<T>, RequestArgumentBinder<T>, TypeArgumentBinder<T,S>, TypedRequestArgumentBinder<T>, WebSocketStateBinder<T>

All Known Implementing Classes:

AbstractAnnotatedArgumentBinder, BasicAuthArgumentBinder, CompletableFutureBodyBinder, CookieAnnotationBinder, DefaultBodyAnnotationBinder, HeaderAnnotationBinder, JacksonBeanPropertyBinder, MaybeBodyBinder, MultipartBodyArgumentBinder, ObservableBodyBinder, OptionalSessionArgumentBinder, OptionalSessionValueArgumentBinder, ParameterAnnotationBinder, PathVariableAnnotationBinder, PublisherBodyBinder, RequestAttributeAnnotationBinder, RequestBeanAnnotationBinder, SessionArgumentBinder, SessionValueArgumentBinder, SingleBodyBinder

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ArgumentBinder<T,S>

An interface capable of binding the value of an Argument from a source

.

The selection of an ArgumentBinder is done by the ArgumentBinderRegistry. Selection could be based on type, annotation or other factors such as the request media type

Unlike TypeConverter instances binders can potentially handle complex objects and typically work on conjunction with a ConvertibleValues instance

An ArgumentBinder can either be registered as a bean or by META-INF/services. In the case of the latter it will be globally available at all times, whilst the former is only present when a io.micronaut.context.BeanContext is initialized

Since:

1.0

Author:

Graeme Rocher

See Also:

TypeConverter, ConvertibleValues

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ArgumentBinder.BindingResult<T> The result of binding.

Method Summary

Modifier and Type	Method and Description
ArgumentBinder.BindingResult<T>	bind(ArgumentConversionContext<T> context, S source) Bind the given argument from the given source.

Method Detail

bind

ArgumentBinder.BindingResult<T> bind(ArgumentConversionContext<T> context,
                                     S source)

Bind the given argument from the given source.

Parameters:

context - The ArgumentConversionContext

source - The source

Returns:

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