com.codepoetics.fluvius.api.Condition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fluvius-api Show documentation

There is a newer version: 1.10

package com.codepoetics.fluvius.api;

import com.codepoetics.fluvius.api.scratchpad.Scratchpad;

import java.io.Serializable;
import java.util.UUID;

/**
 * A Condition tests a Scratchpad, returning true or false depending on the Scratchpad's state.
 */
public interface Condition extends Serializable {
  /**
   * Get the description of the Condition.
   *
   * @return The description of the Condition.
   */
  String getDescription();

  /**
   * Test the supplied Scratchpad.
   *
   * @param flowId The id of the running flow.
   * @param scratchpad The Scratchpad to test.
   * @return True if the Scratchpad matches this Condition, false otherwise.
   */
  boolean test(UUID flowId, Scratchpad scratchpad);
}