Class HandlerMethod

Field Detail

• logger

  protected final Log logger

  Logger that is available to subclasses.

Constructor Detail

• HandlerMethod

  public HandlerMethod​(Object bean,
                       Method method)

  Create an instance from a bean instance and a method.

• HandlerMethod

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

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

  Throws:

  NoSuchMethodException - when the method cannot be found

• HandlerMethod

  public HandlerMethod​(String beanName,
                       BeanFactory beanFactory,
                       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 bean.

• HandlerMethod

  protected HandlerMethod​(HandlerMethod handlerMethod)

  Copy constructor for use in subclasses.

Method Detail

• getBean

  public Object getBean()

  Return the bean for this handler method.

• getMethod

  public Method getMethod()

  Return the method for this handler method.

• getBeanType

  public 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 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()

  Return the method parameters for this handler method.

• getResponseStatus

  @Nullable
  protected HttpStatus getResponseStatus()

  Return the specified response status, if any.

  Since:

  4.3.8

  See Also:

  ResponseStatus.code()

• getResponseStatusReason

  @Nullable
  protected String getResponseStatusReason()

  Return the associated response status reason, if any.

  Since:

  4.3.8

  See Also:

  ResponseStatus.reason()

• getReturnType

  public MethodParameter getReturnType()

  Return the HandlerMethod return type.

• getReturnValueType

  public MethodParameter getReturnValueType​(@Nullable
                                            Object returnValue)

  Return the actual return value type.

• isVoid

  public boolean isVoid()

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

• getMethodAnnotation

  @Nullable
  public <A extends Annotation> A getMethodAnnotation​(Class<A> annotationType)

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

  Also supports merged composed annotations with attribute overrides as of Spring Framework 4.2.2.

  Parameters:

  annotationType - the type of annotation to introspect the method for

  Returns:

  the annotation, or null if none found

  See Also:

  AnnotatedElementUtils.findMergedAnnotation(java.lang.reflect.AnnotatedElement, java.lang.Class<A>)

• hasMethodAnnotation

  public <A extends Annotation> boolean hasMethodAnnotation​(Class<A> annotationType)

  Return whether the parameter is declared with the given annotation type.

  Parameters:

  annotationType - the annotation type to look for

  Since:

  4.3

  See Also:

  AnnotatedElementUtils.hasAnnotation(java.lang.reflect.AnnotatedElement, java.lang.Class<? extends java.lang.annotation.Annotation>)

• getResolvedFromHandlerMethod

  @Nullable
  public HandlerMethod getResolvedFromHandlerMethod()

  Return the HandlerMethod from which this HandlerMethod instance was resolved via createWithResolvedBean().

• 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 String getShortLogMessage()

  Return a short representation of this handler method for log message purposes.

  Since:

  4.3

• equals

  public boolean equals​(@Nullable
                        Object other)

  Overrides:

  equals in class Object

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object

• toString

  public String toString()

  Overrides:

  toString in class Object

• findProvidedArgument

  @Nullable
  protected static Object findProvidedArgument​(MethodParameter parameter,
                                               @Nullable
                                               Object... providedArgs)

• formatArgumentError

  protected static String formatArgumentError​(MethodParameter param,
                                              String message)

• assertTargetBean

  protected void assertTargetBean​(Method method,
                                  Object targetBean,
                                  Object[] args)

  Assert that the target bean class is an instance of the class where the given method is declared. In some cases the actual controller instance at request- processing time may be a JDK dynamic proxy (lazy initialization, prototype beans, and others). @Controller's that require proxying should prefer class-based proxy mechanisms.

• formatInvokeError

  protected String formatInvokeError​(String text,
                                     Object[] args)