Package io.micronaut.http.filter

Record Class GenericHttpFilter.Async

java.lang.Object
java.lang.Record
io.micronaut.http.filter.GenericHttpFilter.Async
Record Components:
actual - Actual filter
executor - Executor to run the filter on
All Implemented Interfaces:
Ordered, GenericHttpFilter
Enclosing interface:
GenericHttpFilter
@Internal public static record GenericHttpFilter.Async(GenericHttpFilter actual, Executor executor) extends Record implements GenericHttpFilter, Ordered
Wrapper around a filter that signifies the filter should be run asynchronously on the given executor. Usually from an ExecuteOn annotation.

  • Constructor Details

    • Async

      public Async(GenericHttpFilter actual, Executor executor)
      Creates an instance of a Async record class.
      Parameters:
      actual - the value for the actual record component
      executor - the value for the executor record component

  • Method Details

    • isSuspended

      public boolean isSuspended()
      Description copied from interface: GenericHttpFilter
      When the filter is using the continuation it needs to be suspended and wait for the response.
      Specified by:
      isSuspended in interface GenericHttpFilter
      Returns:
      true if suspended

    • isFiltersException

      public boolean isFiltersException()
      Specified by:
      isFiltersException in interface GenericHttpFilter
      Returns:
      true if the filter can receive the processing exception.

    • getOrder

      public int getOrder()
      Specified by:
      getOrder in interface Ordered
      Returns:
      The order of the object. Defaults to zero (no order).

    • 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.

    • actual

      public GenericHttpFilter actual()
      Returns the value of the actual record component.
      Returns:
      the value of the actual record component

    • executor

      public Executor executor()
      Returns the value of the executor record component.
      Returns:
      the value of the executor record component