Class Spec<TModel>

Namespace

Motiv

Assembly

Motiv.dll

Represents a proposition that defines a condition for a model of type TModel. This proposition is associated with a string metadata.

public class Spec<TModel> : SpecBase<TModel, string>

Type Parameters

TModel

The type of the model.

Inheritance

object

SpecBase

SpecBase<TModel>

SpecBase<TModel, string>

Spec<TModel>

Inherited Members

SpecBase<TModel, string>.Matches(TModel)

SpecBase<TModel, string>.Evaluate(TModel)

SpecBase<TModel, string>.IsSatisfiedBy(TModel)

SpecBase<TModel, string>.And(SpecBase<TModel, string>)

SpecBase<TModel, string>.AndAlso(SpecBase<TModel, string>)

SpecBase<TModel, string>.Or(SpecBase<TModel, string>)

SpecBase<TModel, string>.OrElse(SpecBase<TModel, string>)

SpecBase<TModel, string>.XOr(SpecBase<TModel, string>)

SpecBase<TModel, string>.Not()

SpecBase<TModel, string>.ChangeModelTo<TNewModel>(Func<TNewModel, TModel>)

SpecBase<TModel, string>.ChangeModelTo<TDerivedModel>()

SpecBase<TModel, string>.ToExplanationSpec()

SpecBase<TModel, string>.ToAsyncSpec()

SpecBase<TModel, string>.And(AsyncSpecBase<TModel, string>)

SpecBase<TModel, string>.AndAlso(AsyncSpecBase<TModel, string>)

SpecBase<TModel, string>.Or(AsyncSpecBase<TModel, string>)

SpecBase<TModel, string>.OrElse(AsyncSpecBase<TModel, string>)

SpecBase<TModel, string>.XOr(AsyncSpecBase<TModel, string>)

SpecBase<TModel, string>.AndConcurrently(AsyncSpecBase<TModel, string>)

SpecBase<TModel, string>.OrConcurrently(AsyncSpecBase<TModel, string>)

SpecBase<TModel, string>.XOrConcurrently(AsyncSpecBase<TModel, string>)

SpecBase<TModel, string>.ToString()

SpecBase<TModel, string>.EvaluateSpec(TModel)

SpecBase<TModel>.Evaluate(TModel)

SpecBase<TModel>.IsSatisfiedBy(TModel)

SpecBase<TModel>.ToExplanationSpec()

SpecBase<TModel>.And(SpecBase<TModel>)

SpecBase<TModel>.AndAlso(SpecBase<TModel>)

SpecBase<TModel>.Or(SpecBase<TModel>)

SpecBase<TModel>.OrElse(SpecBase<TModel>)

SpecBase<TModel>.XOr(SpecBase<TModel>)

SpecBase<TModel>.Not()

SpecBase<TModel>.ToString()

SpecBase.Name

SpecBase.Expression

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

TapExtensions.TapWhenFalse<TModel, TMetadata>(SpecBase<TModel, TMetadata>, Action<TModel, BooleanResultBase<TMetadata>>)

TapExtensions.TapWhenTrue<TModel, TMetadata>(SpecBase<TModel, TMetadata>, Action<TModel, BooleanResultBase<TMetadata>>)

TapExtensions.Tap<TModel, TMetadata>(SpecBase<TModel, TMetadata>, Action<TModel, BooleanResultBase<TMetadata>>)

EnumerableExtensions.ToEnumerable<T>(T)

Constructors

Spec(SpecBase<TModel, string>)

Initializes a new instance of the Spec class with a SpecBase instance.

protected Spec(SpecBase<TModel, string> spec)

Parameters

spec SpecBase<TModel, string>

The base proposition associated with the Spec instance.

Spec(Func<SpecBase<TModel, string>>)

Initializes a new instance of the Spec class with a specification factory.

protected Spec(Func<SpecBase<TModel, string>> specFactory)

Parameters

specFactory Func<SpecBase<TModel, string>>

The specification factory to create the Spec instance.

Properties

Description

Gets the description of the proposition.

public override ISpecDescription Description { get; }

Property Value

ISpecDescription

Underlying

Gets the underlying specifications that make up this composite proposition.

public override IEnumerable<SpecBase> Underlying { get; }

Property Value

IEnumerable<SpecBase>

Methods

EvaluateSpec(TModel)

Determines whether the specified model satisfies the proposition.

protected override BooleanResultBase<string> EvaluateSpec(TModel model)

Parameters

model TModel

The model to be checked against the proposition.

Returns

BooleanResultBase<string>

A BooleanResultBase containing the result of the proposition being applied to a model and the associated metadata.

Matches(TModel)

Evaluates the proposition against the model and returns a boolean indicating whether it is satisfied, without allocating result objects.

public override bool Matches(TModel model)

Parameters

model TModel

The model to evaluate the specification against.

Returns

bool

true if the model satisfies the proposition; otherwise, false.