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 ratio. The sequence can be assigned a total volume which is then spread across the pourables based on their ratios.

Examples based on a sequence configured with a total volume of 100ml:

  • The sequence contains a single pourable with a non-zero ratio. The pourable will pour the entire 100ml as it is the only pourable.
  • The sequence contains two pourbles, both with a ratio of 1. Each pourable will pour 50ml as a ratio of 1 represents 50% of the ratio total for the sequence
  • The sequence contains two pourables with ratios of 7 and 3 respectively. The first pourable will pour 70ml as 7 represents 70 percent of the ratio total of 10. The second pourable will pour 30ml.

The use of ratios allows for volume independent sequences, effectively allowing the sequence to be scaled by setting the total volume after the sequence is constructed. It is also possible to use actual volumes as the ratios and call... todo...

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

      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.

      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.

      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.