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
Resolves method parameters annotated with@DestinationVariable
.- 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 String
DESTINATION_TEMPLATE_VARIABLES_HEADER
Constructor Summary
Constructors Constructor Description DestinationVariableMethodArgumentResolver(ConversionService cs)
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected AbstractNamedValueMethodArgumentResolver.NamedValueInfo
createNamedValueInfo(MethodParameter parameter)
Create theAbstractNamedValueMethodArgumentResolver.NamedValueInfo
object for the given method parameter.protected void
handleMissingValue(String name, MethodParameter parameter, Message<?> message)
Invoked when a named value is required, butAbstractNamedValueMethodArgumentResolver.resolveArgumentInternal(MethodParameter, Message, String)
returnednull
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
Field Detail
DESTINATION_TEMPLATE_VARIABLES_HEADER
public static final String DESTINATION_TEMPLATE_VARIABLES_HEADER
Constructor Detail
DestinationVariableMethodArgumentResolver
public DestinationVariableMethodArgumentResolver(ConversionService cs)
Method Detail
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 theAbstractNamedValueMethodArgumentResolver.NamedValueInfo
object for the given method parameter. Implementations typically retrieve the method annotation by means ofMethodParameter.getParameterAnnotation(Class)
.- Specified by:
createNamedValueInfo
in classAbstractNamedValueMethodArgumentResolver
- Parameters:
parameter
- the method parameter- Returns:
- the named value information
resolveArgumentInternal
protected Object resolveArgumentInternal(MethodParameter parameter, Message<?> message, String name) throws Exception
Description copied from class:AbstractNamedValueMethodArgumentResolver
Resolves the given parameter type and value name into an argument value.- Specified by:
resolveArgumentInternal
in classAbstractNamedValueMethodArgumentResolver
- Parameters:
parameter
- the method parameter to resolve to an argument valuemessage
- the current requestname
- the name of the value being resolved- Returns:
- the resolved argument. May be
null
- Throws:
Exception
- in case of errors
handleMissingValue
protected void handleMissingValue(String name, MethodParameter parameter, Message<?> message)
Description copied from class:AbstractNamedValueMethodArgumentResolver
Invoked when a named value is required, butAbstractNamedValueMethodArgumentResolver.resolveArgumentInternal(MethodParameter, Message, String)
returnednull
and there is no default value. Subclasses typically throw an exception in this case.- Specified by:
handleMissingValue
in classAbstractNamedValueMethodArgumentResolver
- Parameters:
name
- the name for the valueparameter
- the method parametermessage
- the message being processed