Package org.springframework.messaging.handler.annotation.support

Class DestinationVariableMethodArgumentResolver

java.lang.Object

org.springframework.messaging.handler.annotation.support.AbstractNamedValueMethodArgumentResolver

org.springframework.messaging.handler.annotation.support.DestinationVariableMethodArgumentResolver

All Implemented Interfaces:

HandlerMethodArgumentResolver

public class DestinationVariableMethodArgumentResolver
extends AbstractNamedValueMethodArgumentResolver

Resolve for @DestinationVariable method parameters.

Since:

4.0

Author:

Brian Clozel

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.messaging.handler.annotation.support.AbstractNamedValueMethodArgumentResolver

AbstractNamedValueMethodArgumentResolver.NamedValueInfo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESTINATION_TEMPLATE_VARIABLES_HEADER	The name of the header used to for template variables.

Constructor Summary

Constructors

Constructor	Description
DestinationVariableMethodArgumentResolver(ConversionService conversionService)

Method Summary

Modifier and Type	Method	Description
protected AbstractNamedValueMethodArgumentResolver.NamedValueInfo	createNamedValueInfo(MethodParameter parameter)	Create the AbstractNamedValueMethodArgumentResolver.NamedValueInfo object for the given method parameter.
protected void	handleMissingValue(String name, MethodParameter parameter, Message<?> message)	Invoked when a value is required, but AbstractNamedValueMethodArgumentResolver.resolveArgumentInternal(org.springframework.core.MethodParameter, org.springframework.messaging.Message<?>, java.lang.String) returned null and there is no default value.
protected Object	resolveArgumentInternal(MethodParameter parameter, Message<?> message, String name)	Resolves the given parameter type and value name into an argument value.
boolean	supportsParameter(MethodParameter parameter)	Whether the given method parameter is supported by this resolver.

Methods inherited from class org.springframework.messaging.handler.annotation.support.AbstractNamedValueMethodArgumentResolver

handleResolvedValue, resolveArgument

Methods inherited from class java.lang.Object

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

Field Details

DESTINATION_TEMPLATE_VARIABLES_HEADER

public static final String DESTINATION_TEMPLATE_VARIABLES_HEADER

The name of the header used to for template variables.

Constructor Details

DestinationVariableMethodArgumentResolver

public DestinationVariableMethodArgumentResolver(ConversionService conversionService)

Method Details

supportsParameter

public boolean supportsParameter(MethodParameter parameter)

Description copied from interface: HandlerMethodArgumentResolver

Whether the given method parameter is supported by this resolver.

Parameters:

parameter - the method parameter to check

Returns:

true if this resolver supports the supplied parameter; false otherwise

createNamedValueInfo

protected AbstractNamedValueMethodArgumentResolver.NamedValueInfo createNamedValueInfo(MethodParameter parameter)

Description copied from class: AbstractNamedValueMethodArgumentResolver

Create the AbstractNamedValueMethodArgumentResolver.NamedValueInfo object for the given method parameter. Implementations typically retrieve the method annotation by means of MethodParameter.getParameterAnnotation(Class).

Specified by:

createNamedValueInfo in class AbstractNamedValueMethodArgumentResolver

Parameters:

parameter - the method parameter

Returns:

the named value information

resolveArgumentInternal

@Nullable
protected Object resolveArgumentInternal(MethodParameter parameter,
 Message<?> message,
 String name)

Description copied from class: AbstractNamedValueMethodArgumentResolver

Resolves the given parameter type and value name into an argument value.

Specified by:

resolveArgumentInternal in class AbstractNamedValueMethodArgumentResolver

Parameters:

parameter - the method parameter to resolve to an argument value

message - the current request

name - the name of the value being resolved

Returns:

the resolved argument. May be null

handleMissingValue

protected void handleMissingValue(String name,
 MethodParameter parameter,
 Message<?> message)

Description copied from class: AbstractNamedValueMethodArgumentResolver

Invoked when a value is required, but AbstractNamedValueMethodArgumentResolver.resolveArgumentInternal(org.springframework.core.MethodParameter, org.springframework.messaging.Message<?>, java.lang.String) returned null and there is no default value. Subclasses can throw an appropriate exception for this case.

Specified by:

handleMissingValue in class AbstractNamedValueMethodArgumentResolver

Parameters:

name - the name for the value

parameter - the target method parameter

message - the message being processed