csw
API
Generated with
csw/csw/csw.command/csw.command.api

csw.command.api

package csw.command.api

Members list

Packages

package csw.command.api.client
package csw.command.api.codecs
package csw.command.api.javadsl
package csw.command.api.messages
package csw.command.api.scaladsl
package csw.command.api.utils

Type members

Classlikes

case class DemandMatcher(demand: DemandState, withUnits: Boolean, timeout: Timeout) extends StateMatcher

The DemandMatcher checks the CurrentStatus for equality with the items in the DemandState. This version tests for equality so it may not work the best with floating point values. Note: If the withUnits flag is set, the equality check with also compare units. False is the default so normally units are ignored for this purpose.

The DemandMatcher checks the CurrentStatus for equality with the items in the DemandState. This version tests for equality so it may not work the best with floating point values. Note: If the withUnits flag is set, the equality check with also compare units. False is the default so normally units are ignored for this purpose.

Value parameters

demand

a DemandState that will provide the items for determining completion with the CurrentState

timeout

a timeout for which the matching should be executed. Once the timeout occurs, complete the match with MatchFailed response and appropriate failure exception.

withUnits

when True, units are compared. When false, units are not compared. Default is false.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait StateMatcher
class Object
trait Matchable
class Any
Show all
case class DemandMatcherAll(demand: DemandState, timeout: Timeout) extends StateMatcher

A StateMatcher which matches the CurrentState against the DemandState

A StateMatcher which matches the CurrentState against the DemandState

Value parameters

demand

a DemandState that will provide the items for determining completion with the CurrentState

timeout

a timeout for which the matching should be executed. Once the timeout occurs, complete the match with MatchFailed response and appropriate failure exception.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait StateMatcher
class Object
trait Matchable
class Any
Show all
case class PresenceMatcher(prefix: Prefix, stateName: StateName, timeout: Timeout) extends StateMatcher

PresenceMatcher only checks for the existence of a CurrentState with a given prefix and name

PresenceMatcher only checks for the existence of a CurrentState with a given prefix and name

Value parameters

prefix

the prefix to match against the CurrentState

stateName

the name to match against the stateName of CurrentState

timeout

A timeout for which the matching should be executed. Once the timeout occurs, complete the match with MatchFailed response and appropriate failure exception.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait StateMatcher
class Object
trait Matchable
class Any
Show all
trait StateMatcher

The base trait to build Matchers to match given state against a predicate

The base trait to build Matchers to match given state against a predicate

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
Generated with