Package csw.command.api

Class PresenceMatcher

java.lang.Object
csw.command.api.PresenceMatcher
All Implemented Interfaces:
StateMatcher, Serializable, scala.Equals, scala.Product
public class PresenceMatcher extends Object implements StateMatcher, scala.Product, Serializable
PresenceMatcher only checks for the existence of a CurrentState with a given prefix and name

param: prefix the prefix to match against the CurrentState param: stateName the name to match against the stateName of CurrentState param: timeout A timeout for which the matching should be executed. Once the timeout occurs, complete the match with MatchFailed response and appropriate failure exception.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    PresenceMatcher(Prefix prefix, StateName stateName, akka.util.Timeout timeout)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract static R
    apply(T1 v1, T2 v2, T3 v3)
     
    boolean
    check(CurrentState current)
    A predicate that returns true when a CurrentState is published that matches the prefix and stateName that are arguments to the PresenceMatcher
    Prefix
    prefix()
    The prefix of the destination component for which the current state is being matched
    StateName
    stateName()
    The name of the state to match for
    akka.util.Timeout
    timeout()
    The maximum duration for which the matching is executed if not completed either successfully or unsuccessfully
    static String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface scala.Equals

    canEqual, equals

    Methods inherited from interface scala.Product

    productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

  • Constructor Details

    • PresenceMatcher

      public PresenceMatcher(Prefix prefix, StateName stateName, akka.util.Timeout timeout)

  • Method Details

    • apply

      public abstract static R apply(T1 v1, T2 v2, T3 v3)

    • toString

      public static String toString()

    • prefix

      public Prefix prefix()
      Description copied from interface: StateMatcher
      The prefix of the destination component for which the current state is being matched

      Specified by:
      prefix in interface StateMatcher
      Returns:
      the prefix of destination component

    • stateName

      public StateName stateName()
      Description copied from interface: StateMatcher
      The name of the state to match for

      Specified by:
      stateName in interface StateMatcher
      Returns:
      the name of the state

    • timeout

      public akka.util.Timeout timeout()
      Description copied from interface: StateMatcher
      The maximum duration for which the matching is executed if not completed either successfully or unsuccessfully
      Specified by:
      timeout in interface StateMatcher
      Returns:
      (undocumented)

    • check

      public boolean check(CurrentState current)
      A predicate that returns true when a CurrentState is published that matches the prefix and stateName that are arguments to the PresenceMatcher

      Specified by:
      check in interface StateMatcher
      Parameters:
      current - current state to be matched as represented by CurrentState
      Returns:
      true if match is successful, false otherwise