TestimoX

API Reference

Class

ScaleBuilder

Edit on GitHub
Namespace TestimoX.Testing
Assembly TestimoX
Source TestimoX/Testing/ScaleDefinition.cs:90

Fluent builder for ScaleDefinition. Bands are matched in the order they are added.

Inheritance

  • Object
  • ScaleBuilder

Constructors

public ScaleBuilder(Boolean useCountIfCollection = true) #
TestimoX/Testing/ScaleDefinition.cs:90

Creates a new scale builder.

Parameters

useCountIfCollection System.Boolean = true optionalposition: 0
When true, collections are evaluated by their Count.

Methods

public ScaleBuilder Above(Double minExclusive, TestimoStatus status, Nullable<Boolean> pass = null, Nullable<Importance> importance = null, Nullable<ActionType> action = null, String message = null) #
TestimoX/Testing/ScaleDefinition.cs:144
Returns: ScaleBuilder

Adds a band for values greater than minExclusive (exclusive).

Parameters

minExclusive System.Double requiredposition: 0
status TestimoX.Definitions.TestimoStatus requiredposition: 1
pass System.Nullable{System.Boolean} = null optionalposition: 2
importance System.Nullable{TestimoX.Definitions.Importance} = null optionalposition: 3
action System.Nullable{TestimoX.Definitions.ActionType} = null optionalposition: 4
message System.String = null optionalposition: 5
public ScaleBuilder AboveParameter(String minKey, TestimoStatus status, Nullable<Boolean> pass = null, Nullable<Importance> importance = null, Nullable<ActionType> action = null, String message = null) #
TestimoX/Testing/ScaleDefinition.cs:206
Returns: ScaleBuilder

Adds a parameterized band for values greater than Parameter(minKey).

Parameters

minKey System.String requiredposition: 0
status TestimoX.Definitions.TestimoStatus requiredposition: 1
pass System.Nullable{System.Boolean} = null optionalposition: 2
importance System.Nullable{TestimoX.Definitions.Importance} = null optionalposition: 3
action System.Nullable{TestimoX.Definitions.ActionType} = null optionalposition: 4
message System.String = null optionalposition: 5
public ScaleBuilder Between(Double minInclusive, Double maxExclusive, TestimoStatus status, Nullable<Boolean> pass = null, Nullable<Importance> importance = null, Nullable<ActionType> action = null, String message = null) #
TestimoX/Testing/ScaleDefinition.cs:125
Returns: ScaleBuilder

Adds a band for minInclusive ≤ value < maxExclusive.

Parameters

minInclusive System.Double requiredposition: 0
maxExclusive System.Double requiredposition: 1
status TestimoX.Definitions.TestimoStatus requiredposition: 2
pass System.Nullable{System.Boolean} = null optionalposition: 3
importance System.Nullable{TestimoX.Definitions.Importance} = null optionalposition: 4
action System.Nullable{TestimoX.Definitions.ActionType} = null optionalposition: 5
message System.String = null optionalposition: 6
public ScaleBuilder BetweenParameter(String minKey, String maxKey, TestimoStatus status, Nullable<Boolean> pass = null, Nullable<Importance> importance = null, Nullable<ActionType> action = null, String message = null) #
TestimoX/Testing/ScaleDefinition.cs:187
Returns: ScaleBuilder

Adds a parameterized band for Parameter(minKey) ≤ value < Parameter(maxKey).

Parameters

minKey System.String requiredposition: 0
maxKey System.String requiredposition: 1
status TestimoX.Definitions.TestimoStatus requiredposition: 2
pass System.Nullable{System.Boolean} = null optionalposition: 3
importance System.Nullable{TestimoX.Definitions.Importance} = null optionalposition: 4
action System.Nullable{TestimoX.Definitions.ActionType} = null optionalposition: 5
message System.String = null optionalposition: 6
public ScaleDefinition Build() #
TestimoX/Testing/ScaleDefinition.cs:160
Returns: ScaleDefinition

Builds the immutable scale definition.

public ScaleBuilder Passing(params TestimoStatus[] statuses) #
TestimoX/Testing/ScaleDefinition.cs:98
Returns: ScaleBuilder

Sets which statuses should be considered a passing outcome for this scale.

Parameters

statuses TestimoX.Definitions.TestimoStatus[] requiredposition: 0
public ScaleBuilder UpTo(Double maxInclusive, TestimoStatus status, Nullable<Boolean> pass = null, Nullable<Importance> importance = null, Nullable<ActionType> action = null, String message = null) #
TestimoX/Testing/ScaleDefinition.cs:106
Returns: ScaleBuilder

Adds a band from negative infinity up to and including maxInclusive.

Parameters

maxInclusive System.Double requiredposition: 0
status TestimoX.Definitions.TestimoStatus requiredposition: 1
pass System.Nullable{System.Boolean} = null optionalposition: 2
importance System.Nullable{TestimoX.Definitions.Importance} = null optionalposition: 3
action System.Nullable{TestimoX.Definitions.ActionType} = null optionalposition: 4
message System.String = null optionalposition: 5
public ScaleBuilder UpToParameter(String maxKey, TestimoStatus status, Nullable<Boolean> pass = null, Nullable<Importance> importance = null, Nullable<ActionType> action = null, String message = null) #
TestimoX/Testing/ScaleDefinition.cs:168
Returns: ScaleBuilder

Adds a parameterized band from negative infinity up to and including the value of Parameter(maxKey).

Parameters

maxKey System.String requiredposition: 0
status TestimoX.Definitions.TestimoStatus requiredposition: 1
pass System.Nullable{System.Boolean} = null optionalposition: 2
importance System.Nullable{TestimoX.Definitions.Importance} = null optionalposition: 3
action System.Nullable{TestimoX.Definitions.ActionType} = null optionalposition: 4
message System.String = null optionalposition: 5