Package com.inductiveautomation.eventstream.gateway.stages

Record Class StageEvent.Shutdown

java.lang.Object
java.lang.Record
com.inductiveautomation.eventstream.gateway.stages.StageEvent.Shutdown
Record Components:
future - Completed once all previous events have been processed.
All Implemented Interfaces:
StageEvent
Enclosing interface:
StageEvent
public static record StageEvent.Shutdown(CompletableFuture<EventResult> future) extends Record implements StageEvent
Signals an EventStream has been shut down. All events will be flushed/processed before Shutdown completes.

  • Constructor Details

    • Shutdown

      public Shutdown(CompletableFuture<EventResult> future)
      Creates an instance of a Shutdown record class.
      Parameters:
      future - the value for the future record component

  • Method Details

    • create

      public static StageEvent.Shutdown create()

    • complete

      public void complete(EventResult result)
      Description copied from interface: StageEvent
      Must be called by Stage when it's done being processed by EventStream.
      Specified by:
      complete in interface StageEvent
      Parameters:
      result - True, Event was successfully handled. False, otherwise.

    • split

      public List<StageEvent> split(int count)
      Description copied from interface: StageEvent
      Splits an Event into multiple copies of the same Event. The originating Event will only complete once all of its copies have completed. Used when multiple stages need their own copy of events.
      Specified by:
      split in interface StageEvent
      Parameters:
      count - Amount of events to split into
      Returns:
      List of cloned Events

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

    • future

      public CompletableFuture<EventResult> future()
      Returns the value of the future record component.
      Specified by:
      future in interface StageEvent
      Returns:
      the value of the future record component