Spring Framework 6.1.4 · org.springframework.messaging.handler.HandlerMethod

Field Summary

Modifier and Type	Field and Description
private final Object	bean
private final BeanFactory	beanFactory
private final Class<?>	beanType
public static final Log	defaultLogger Public for wrapping with fallback logger.
protected Log	logger
private HandlerMethod	resolvedFromHandlerMethod

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
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.
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.
public boolean	equals(Object the reference object with which to compare. other) Overrides org.springframework.core.annotation.AnnotatedMethod.equals. Indicates whether some other object is "equal to" this one.
protected String	formatInvokeError(String text, Object[] args)
public Object	getBean() Return the bean for this handler method.
public Class<?>	getBeanType() This method returns the type of the handler for this handler method.
protected Class<?>	getContainingClass() Overrides org.springframework.core.annotation.AnnotatedMethod.getContainingClass. Expose the containing class for method parameters.
public Log	getLogger() Return the currently configured Logger.
public HandlerMethod	getResolvedFromHandlerMethod() Return the HandlerMethod from which this HandlerMethod instance was resolved via `createWithResolvedBean()`.
public String	getShortLogMessage() Return a short representation of this handler method for log message purposes.
public int	hashCode() Overrides org.springframework.core.annotation.AnnotatedMethod.hashCode. Returns a hash code value for this object.
public void	setLogger(Log the logger to use logger) Set an alternative logger to use than the one based on the class name.

Inherited from org.springframework.core.annotation.AnnotatedMethod:: findProvidedArgument formatArgumentError getBridgedMethod getMethod getMethodAnnotation getMethodParameters getReturnType getReturnValueType hasMethodAnnotation isVoid toString

Field Detail

bean	back to summary
private final Object bean

beanFactory	back to summary
private final BeanFactory beanFactory Annotations @Nullable

beanType	back to summary
private final Class<?> beanType

defaultLogger	back to summary
public static final Log defaultLogger Public for wrapping with fallback logger.

logger	back to summary
protected Log logger

resolvedFromHandlerMethod	back to summary
private HandlerMethod resolvedFromHandlerMethod Annotations @Nullable

Constructor Detail

HandlerMethod	back to summary
public HandlerMethod(Object bean, Method method) Create an instance from a bean instance and a method.

HandlerMethod	back to summary
public HandlerMethod(Object bean, String methodName, Class<?>... parameterTypes) throws NoSuchMethodException Create an instance from a bean instance, method name, and parameter types. Exceptions NoSuchMethodException: when the method cannot be found

HandlerMethod

back to summary

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

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

Exceptions

NoSuchMethodException:: when the method cannot be found

HandlerMethod	back to summary
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	back to summary
protected HandlerMethod(HandlerMethod handlerMethod) Copy constructor for use in subclasses.

HandlerMethod	back to summary
private HandlerMethod(HandlerMethod handlerMethod, Object handler) Re-create HandlerMethod with the resolved handler.

Method Detail

assertTargetBean	back to summary
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 endpoint instance at request- processing time may be a JDK dynamic proxy (lazy initialization, prototype beans, and others). Endpoint classes that require proxying should prefer class-based proxy mechanisms.

assertTargetBean

back to summary

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 endpoint instance at request- processing time may be a JDK dynamic proxy (lazy initialization, prototype beans, and others). Endpoint classes that require proxying should prefer class-based proxy mechanisms.

createWithResolvedBean	back to summary
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.

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides org.springframework.core.annotation.AnnotatedMethod.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides org.springframework.core.annotation.AnnotatedMethod.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

formatInvokeError	back to summary
protected String formatInvokeError(String text, Object[] args)

getBean	back to summary
public Object getBean() Return the bean for this handler method.

getBeanType	back to summary
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.

getBeanType

back to summary

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.

getContainingClass	back to summary
protected Class<?> getContainingClass() Overrides org.springframework.core.annotation.AnnotatedMethod.getContainingClass. Doc from org.springframework.core.annotation.AnnotatedMethod.getContainingClass. Expose the containing class for method parameters. Annotations @Override

getContainingClass

back to summary

protected Class<?> getContainingClass()

Overrides org.springframework.core.annotation.AnnotatedMethod.getContainingClass.

Doc from org.springframework.core.annotation.AnnotatedMethod.getContainingClass.

Expose the containing class for method parameters.

Annotations

@Override

getLogger	back to summary
public Log getLogger() Return the currently configured Logger. Since 5.1

getLogger

back to summary

public Log getLogger()

Return the currently configured Logger.

Since: 5.1

getResolvedFromHandlerMethod back to summary

getResolvedFromHandlerMethod	back to summary
public HandlerMethod getResolvedFromHandlerMethod() Return the HandlerMethod from which this HandlerMethod instance was resolved via `createWithResolvedBean()`. Annotations @Nullable Since 4.3

public HandlerMethod getResolvedFromHandlerMethod()

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

Annotations

@Nullable

Since

4.3

getShortLogMessage	back to summary
public String getShortLogMessage() Return a short representation of this handler method for log message purposes.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides org.springframework.core.annotation.AnnotatedMethod.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides org.springframework.core.annotation.AnnotatedMethod.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

setLogger	back to summary
public void setLogger(Log logger) Set an alternative logger to use than the one based on the class name. Parameters logger:Log the logger to use Since 5.1

setLogger

back to summary

public void setLogger(Log logger)

Set an alternative logger to use than the one based on the class name.

Parameters

logger:Log: the logger to use

Since

5.1

public Class HandlerMethod

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail