Package com.tccc.kos.ext.dispense.pipeline.beverage

Class BeveragePourBuilder

java.lang.Object
com.tccc.kos.ext.dispense.pipeline.beverage.BeveragePourBuilder
public class BeveragePourBuilder extends Object
Builder for constructing pours. This can be used to build simple pours as well as complex sequences of pours. The builder constructs a PourSequence as a list of Pourable objects, each with an associated volume, that can be poured as an atomic operation. A builder is bound to a pour pipeline and is single use. The builder can be used to construct a sequence by calling the various pour api's ending with a call to pour(). This will generate the final sequence and pass it to the associated pipeline to be converted to a FutureWork(). The future can then be started to perform the physical pour. Once pour() has been called, the builder can no longer be used and all methods will throw an exception.

The builder provides access to pours based on the currently selected beverage. This leverages the associated BeveragePipelineService class which has a concept of selected beverage and corresponding endpoints. This typically allows developers to avoid introducing custom code or endpoints to manage beverage selection, although doesn't preclude it.

The builder also leverages named volumes to handle common use cases such as pre-configured cup sizes. The BeverageNozzlePipeline supports a BeveragePipelineDelegate which defines the max volume pour as well as resolves named volumes to actual numeric values. This allows the pipeline to route volume resolution to any user defined process.

Virtually all methods in the builder operate on Pourable objects. A Pourable defines the beverage to pour and can contain a volume. In some cases the volume from the provided pourable is used, but in many cases a new volume is computed based on inputs. In every instance, the provided Pourable is first cloned and then updated to use the computed volume, leaving the original pourable unchanged.

Since:
1.0
Version:
2023-09-09

  • Method Details

    • addSelectedMaxVolumePour

      public BeveragePourBuilder addSelectedMaxVolumePour()
      Add the currently selected Pourable using the max pour volume from the PourServiceDelegate as the limit. This is typically used for pouring triggered by a hold-to-pour button where releasing the button will cancel the pour.
      Throws:
      BeveragePourBuilderException - if PourEngineDelegate isn't set

    • addSelectedVolumePour

      public BeveragePourBuilder addSelectedVolumePour(double volume)
      Add the currently selected Pourable using the specified volume.
      Parameters:
      volume - the volume to pour in milliliters
      Throws:
      BeveragePourBuilderException - if no Pourable is currently selected

    • addVolumePour

      public BeveragePourBuilder addVolumePour(Pourable pourable, double volume)
      Add the specified Pourable using the specified volume. This will clone the pourable and set the totalVolume to the specified volume and set start / stop percent as specified.

      The specified Pourable will be cloned and the volume will be set on the clone. Any volume on the incoming pourable will be ignored.

      Parameters:
      pourable - the pourable to pour
      volume - the volume to pour in milliliters

    • addPour

      public BeveragePourBuilder addPour(Pourable pourable)
      Add the specified Pourable using the effective volume specified in the pourable. This will clone the pourable.

      The specified Pourable will be cloned and added to the sequence. The volume of the original pourable can be changed after this call without impacting the sequence.

      Parameters:
      pourable - the pourable to pour

    • addSelectedFixedPour

      public BeveragePourBuilder addSelectedFixedPour(String fixedName)
      Add the currently selected Pourable using the named pour volume. PourServiceDelegate is used to convert FixedName to a volume.

      If the pourable implements FixedPourAware then the pour will be split based on the information from the pourable. If not, the pour will not be split.

      The specified Pourable will be cloned and the volume will be set on the clone. Any volume on the incoming pourable will be ignored.

      Parameters:
      fixedName - the name to resolve to a volume using PourServiceDelegate

    • addSelectedFixedPour

      public BeveragePourBuilder addSelectedFixedPour(String fixedName, double splitPercent, int delay)
      Add the currently selected Pourable using the named pour volume and optionally split into two separate pours at the specified percent using the specified delay. PourServiceDelegate is used to convert FixedName to a volume.

      If splitPercent is <=0 or >=100 then there will be a single pour for the entire volume and the delay will be ignored. For any other value of splitPercent, the pour will be split and the specified delay inserted.

      Parameters:
      fixedName - the name to resolve to a volume using PourServiceDelegate
      splitPercent - where to split the pour into two pours with the delay
      delay - the delay between two parts of a split pour in milliseconds

    • addFixedPour

      public BeveragePourBuilder addFixedPour(Pourable pourable, String fixedName)
      Add the specified Pourable using the named pour volume. PourServiceDelegate is used to convert FixedName to a volume.

      If the pourable implements FixedPourAware then the pour will be split based on the information from the pourable. If not, the pour will not be split.

      The specified Pourable will be cloned and the volume will be set on the clone. Any volume on the incoming pourable will be ignored.

      Parameters:
      pourable - the pourable to add
      fixedName - the name to resolve to a volume using PourServiceDelegate

    • addFixedPour

      public BeveragePourBuilder addFixedPour(Pourable pourable, String fixedName, double splitPercent, int delay)
      Add the specified Pourable using the named pour volume and optionally split into two separate pours at the specified percent using the specified delay. PourServiceDelegate is used to convert FixedName to a volume.

      If splitPercent is <=0 or >=100 then there will be a single pour for the entire volume and the delay will be ignored. For any other value of splitPercent splitPercent, the pour will be split into two parts with the delay between them.

      The specified Pourable will be cloned and the volume will be set on the clone. Any volume on the incoming pourable will be ignored.

      Parameters:
      pourable - the pourable to add
      fixedName - the name to resolve to a volume using PourServiceDelegate
      splitPercent - where to split the pour into two pours with the delay
      delay - the delay between two parts of a split pour in milliseconds

    • pour

      public com.tccc.kos.commons.util.concurrent.future.FutureWork pour()
      Pour the sequence defined by the current state of the builder.