Interface HandlerDescriptor

All Known Subinterfaces:
HandlerInvoker, HandlerMethod<M>
All Known Implementing Classes:
DocumentHandlerDecorator.DocumentHandler.DocumentHandlerInvoker, HandlerInspector.MethodHandlerMatcher.MethodHandlerInvoker, HandlerInvoker.DelegatingHandlerInvoker, HandlerInvoker.SimpleInvoker, HandlerMethod.DelegatingHandlerMethod, StatefulHandler.StatefulEntryInvoker, StatefulHandler.StatefulHandlerInvoker, StatefulHandler.StatefulMemberInvoker
public interface HandlerDescriptor
Describes the handler method that is involved in a handling operation.

A descriptor carries stable metadata only. It does not imply that the handler is already bound to a specific message, nor that it can be invoked through this interface.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    expectResult()
    Indicates whether the handler method has a return value.
    Executable
    getMethod()
    The Executable representing the handler method (can be a static or instance Method or Constructor).
    <A extends Annotation>
    A
    getMethodAnnotation()
    Retrieves the configured handler annotation from the handler method, if present.
    Class<?>
    getTargetClass()
    The target class that contains the handler method.
    boolean
    isPassive()
    Indicates whether this handler operates in passive mode (i.e., results will not be published).

  • Method Details

    • getTargetClass

      Class<?> getTargetClass()
      The target class that contains the handler method.
      Returns:
      the declaring class of the handler

    • getMethod

      Executable getMethod()
      The Executable representing the handler method (can be a static or instance Method or Constructor).
      Returns:
      the executable method

    • getMethodAnnotation

      <A extends Annotation> A getMethodAnnotation()
      Retrieves the configured handler annotation from the handler method, if present.
      Type Parameters:
      A - the annotation type
      Returns:
      the annotation instance, or null if not found

    • expectResult

      boolean expectResult()
      Indicates whether the handler method has a return value.
      Returns:
      true if the method returns a value; false if it is void

    • isPassive

      boolean isPassive()
      Indicates whether this handler operates in passive mode (i.e., results will not be published).
      Returns:
      true if passive; otherwise false