Interface InsertionPumpListener

All Superinterfaces:
InsertionListener
All Known Implementing Classes:
BeveragePourEngine

public interface InsertionPumpListener extends InsertionListener
Interface to be notified when a particular pump completes the insertion process by passing all filters. The inserted flag on the pump will be true to indicate that it is fully inserted.

When more than one pump is connected to a holder, or a container spans more than one holder, it is possible for one pump to be fully inserted while other related pumps are not. At this point the fully inserted pump is generally available for beverage pouring while the other pumps are not.

If a pump generates an insert event, it will also generate a remove event when removed.

Since:
1.0
Version:
2023-01-30
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    onContainerInserted(Container container, Pump<?> pump)
    Called when a container is inserted all the way to a pump.
    void
    onContainerRemoved(Container container, Pump<?> pump)
    Called when a container is removed.
  • Method Details

    • onContainerInserted

      void onContainerInserted(Container container, Pump<?> pump)
      Called when a container is inserted all the way to a pump. At this point the pump inserted flag is set the and pump can be used normally.
      Parameters:
      container - the container that was inserted
      pump - the pump inserted into
    • onContainerRemoved

      void onContainerRemoved(Container container, Pump<?> pump)
      Called when a container is removed. This callback will be called prior to the holder remove callback.
      Parameters:
      container - the container that was removed
      pump - the associated pump