org.springframework.messaging.handler

Class HandlerMethod

java.lang.Object

org.springframework.messaging.handler.HandlerMethod

Direct Known Subclasses:

InvocableHandlerMethod

public class HandlerMethod
extends java.lang.Object

Encapsulates information about a handler method consisting of a method and a bean. Provides convenient access to method parameters, method return value, method annotations.

The class may be created with a bean instance or with a bean name (e.g. lazy-init bean, prototype bean). Use createWithResolvedBean() to obtain a HandlerMethod instance with a bean instance resolved through the associated BeanFactory.

Since:

4.0

Author:

Arjen Poutsma, Rossen Stoyanchev, Juergen Hoeller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HandlerMethod.HandlerMethodParameter A MethodParameter with HandlerMethod-specific behavior.
private class	HandlerMethod.ReturnValueMethodParameter A MethodParameter for a HandlerMethod return type based on an actual return value.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object	bean
private BeanFactory	beanFactory
private java.lang.Class<?>	beanType
private java.lang.reflect.Method	bridgedMethod
protected Log	logger Logger that is available to subclasses
private java.lang.reflect.Method	method
private MethodParameter[]	parameters

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HandlerMethod(HandlerMethod handlerMethod) Copy constructor for use in subclasses.
private	HandlerMethod(HandlerMethod handlerMethod, java.lang.Object handler) Re-create HandlerMethod with the resolved handler.
	HandlerMethod(java.lang.Object bean, java.lang.reflect.Method method) Create an instance from a bean instance and a method.
	HandlerMethod(java.lang.Object bean, java.lang.String methodName, java.lang.Class<?>... parameterTypes) Create an instance from a bean instance, method name, and parameter types.
	HandlerMethod(java.lang.String beanName, BeanFactory beanFactory, java.lang.reflect.Method method) Create an instance from a bean name, a method, and a BeanFactory.

Method Summary

Modifier and Type	Method and Description
HandlerMethod	createWithResolvedBean() If the provided instance contains a bean name rather than an object instance, the bean name is resolved before a HandlerMethod is created and returned.
boolean	equals(java.lang.Object other)
java.lang.Object	getBean() Returns the bean for this handler method.
java.lang.Class<?>	getBeanType() This method returns the type of the handler for this handler method.
protected java.lang.reflect.Method	getBridgedMethod() If the bean method is a bridge method, this method returns the bridged (user-defined) method.
java.lang.reflect.Method	getMethod() Returns the method for this handler method.
<A extends java.lang.annotation.Annotation> A	getMethodAnnotation(java.lang.Class<A> annotationType) Returns a single annotation on the underlying method traversing its super methods if no annotation can be found on the given method itself.
MethodParameter[]	getMethodParameters() Returns the method parameters for this handler method.
MethodParameter	getReturnType() Return the HandlerMethod return type.
MethodParameter	getReturnValueType(java.lang.Object returnValue) Return the actual return value type.
java.lang.String	getShortLogMessage()
int	hashCode()
private MethodParameter[]	initMethodParameters()
boolean	isVoid() Returns true if the method return type is void, false otherwise.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

logger

protected final Log logger

Logger that is available to subclasses

bean

private final java.lang.Object bean

beanFactory

private final BeanFactory beanFactory

beanType

private final java.lang.Class<?> beanType

method

private final java.lang.reflect.Method method

bridgedMethod

private final java.lang.reflect.Method bridgedMethod

parameters

private final MethodParameter[] parameters

Constructor Detail

HandlerMethod

public HandlerMethod(java.lang.Object bean,
                     java.lang.reflect.Method method)

Create an instance from a bean instance and a method.

HandlerMethod

public HandlerMethod(java.lang.Object bean,
                     java.lang.String methodName,
                     java.lang.Class<?>... parameterTypes)
              throws java.lang.NoSuchMethodException

Create an instance from a bean instance, method name, and parameter types.

Throws:

java.lang.NoSuchMethodException - when the method cannot be found

HandlerMethod

public HandlerMethod(java.lang.String beanName,
                     BeanFactory beanFactory,
                     java.lang.reflect.Method method)

Create an instance from a bean name, a method, and a BeanFactory. The method createWithResolvedBean() may be used later to re-create the HandlerMethod with an initialized the bean.

HandlerMethod

protected HandlerMethod(HandlerMethod handlerMethod)

Copy constructor for use in subclasses.

HandlerMethod

private HandlerMethod(HandlerMethod handlerMethod,
                      java.lang.Object handler)

Re-create HandlerMethod with the resolved handler.

Method Detail

initMethodParameters

private MethodParameter[] initMethodParameters()

getBean

public java.lang.Object getBean()

Returns the bean for this handler method.

getMethod

public java.lang.reflect.Method getMethod()

Returns the method for this handler method.

getBeanType

public java.lang.Class<?> getBeanType()

This method returns the type of the handler for this handler method.

Note that if the bean type is a CGLIB-generated class, the original user-defined class is returned.

getBridgedMethod

protected java.lang.reflect.Method getBridgedMethod()

If the bean method is a bridge method, this method returns the bridged (user-defined) method. Otherwise it returns the same method as getMethod().

getMethodParameters

public MethodParameter[] getMethodParameters()

Returns the method parameters for this handler method.

getReturnType

public MethodParameter getReturnType()

Return the HandlerMethod return type.

getReturnValueType

public MethodParameter getReturnValueType(java.lang.Object returnValue)

Return the actual return value type.

isVoid

public boolean isVoid()

Returns true if the method return type is void, false otherwise.

getMethodAnnotation

public <A extends java.lang.annotation.Annotation> A getMethodAnnotation(java.lang.Class<A> annotationType)

Returns a single annotation on the underlying method traversing its super methods if no annotation can be found on the given method itself.

Parameters:

annotationType - the type of annotation to introspect the method for.

Returns:

the annotation, or null if none found

createWithResolvedBean

public HandlerMethod createWithResolvedBean()

If the provided instance contains a bean name rather than an object instance, the bean name is resolved before a HandlerMethod is created and returned.

getShortLogMessage

public java.lang.String getShortLogMessage()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object