Package org.atmosphere.cpr

Record Class Action

java.lang.Object
java.lang.Record
org.atmosphere.cpr.Action
public record Action(Action.TYPE type, long timeout) extends Record
An Action is used by AtmosphereInterceptor, AsyncSupport and AtmosphereFramework to determine what to do with a request, e.g suspend it, resume it, etc.

  • Field Details

    • CANCELLED

      public static final Action CANCELLED

    • CONTINUE

      public static final Action CONTINUE

    • CREATED

      public static final Action CREATED

    • RESUME

      public static final Action RESUME

    • SUSPEND

      public static final Action SUSPEND

    • DESTROYED

      public static final Action DESTROYED

    • SKIP_ATMOSPHEREHANDLER

      public static final Action SKIP_ATMOSPHEREHANDLER

  • Constructor Details

    • Action

      public Action(Action.TYPE type)

    • Action

      public Action()

    • Action

      public Action(Action.TYPE type, long timeout)
      Creates an instance of a Action record class.
      Parameters:
      type - the value for the type record component
      timeout - the value for the timeout record component

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • type

      public Action.TYPE type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • timeout

      public long timeout()
      Returns the value of the timeout record component.
      Returns:
      the value of the timeout record component