Record Class HandlerMethodPreparation<M>

java.lang.Object
java.lang.Record
io.fluxzero.common.handling.HandlerMethodPreparation<M>
Type Parameters:
M - the message type used by the handling pipeline
Record Components:
status - the outcome of the preparation
plan - the reusable invocation plan when status is HandlerMethodPreparation.Status.PREPARED; otherwise null
public record HandlerMethodPreparation<M>(HandlerMethodPreparation.Status status, HandlerMethodPlan<M> plan) extends Record
The outcome of trying to prepare a handler method for repeated invocation.

A preparation distinguishes a successful match, a definitive non-match, and a case that cannot be prepared safely. This distinction lets callers cache non-matches while retaining the normal handling path for unsupported cases.

  • Constructor Details

    • HandlerMethodPreparation

      public HandlerMethodPreparation(HandlerMethodPreparation.Status status, HandlerMethodPlan<M> plan)
      Creates an instance of a HandlerMethodPreparation record class.
      Parameters:
      status - the value for the status record component
      plan - the value for the plan record component

  • Method Details

    • prepared

      public static <M> HandlerMethodPreparation<M> prepared(HandlerMethodPlan<M> plan)
      Creates a successful preparation.
      Parameters:
      plan - the reusable invocation plan
      Returns:
      a successful preparation containing the plan

    • noMatch

      public static <M> HandlerMethodPreparation<M> noMatch()

    • unsupported

      public static <M> HandlerMethodPreparation<M> unsupported()

    • isPrepared

      public boolean isPrepared()
      Returns whether preparation produced an invocation plan.
      Returns:
      true when plan() can be invoked

    • isUnsupported

      public boolean isUnsupported()
      Returns whether the normal per-message handling path must be used.
      Returns:
      true when safe preparation was not possible

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • status

      public HandlerMethodPreparation.Status status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • plan

      public HandlerMethodPlan<M> plan()
      Returns the value of the plan record component.
      Returns:
      the value of the plan record component