Package csw.command.api

Interface StateMatcher

All Known Implementing Classes:
DemandMatcher, DemandMatcherAll, PresenceMatcher
public interface StateMatcher
The base trait to build Matchers to match given state against a predicate

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    check(CurrentState current)
    A predicate to match the current state
    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

  • Method Details

    • check

      boolean check(CurrentState current)
      A predicate to match the current state

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

    • prefix

      Prefix prefix()
      The prefix of the destination component for which the current state is being matched

      Returns:
      the prefix of destination component

    • stateName

      StateName stateName()
      The name of the state to match for

      Returns:
      the name of the state

    • timeout

      akka.util.Timeout timeout()
      The maximum duration for which the matching is executed if not completed either successfully or unsuccessfully
      Returns:
      (undocumented)