public interface

WebArgumentResolver

org.springframework.web.bind.support.WebArgumentResolver

Class Overview

SPI for resolving custom arguments for a specific handler method parameter. Typically implemented to detect special parameter types, resolving well-known argument values for them.

A typical implementation could look like as follows:

 public class MySpecialArgumentResolver implements WebArgumentResolver {

   public Object resolveArgument(MethodParameter methodParameter, NativeWebRequest webRequest) {
     if (methodParameter.getParameterType().equals(MySpecialArg.class)) {
       return new MySpecialArg("myValue");
     }
     return UNRESOLVED;
   }
 }

Summary

Fields
public static final Object UNRESOLVED Marker to be returned when the resolver does not know how to handle the given method parameter.
Public Methods
abstract Object resolveArgument(MethodParameter methodParameter, NativeWebRequest webRequest)
Resolve an argument for the given handler method parameter within the given web request.

Fields

public static final Object UNRESOLVED

Marker to be returned when the resolver does not know how to handle the given method parameter.

Public Methods

public abstract Object resolveArgument (MethodParameter methodParameter, NativeWebRequest webRequest)

Resolve an argument for the given handler method parameter within the given web request.

Parameters
methodParameter the handler method parameter to resolve
webRequest the current web request, allowing access to the native request as well
Returns
  • the argument value, or UNRESOLVED if not resolvable
Throws
Exception in case of resolution failure