Class NoSpecimenOutputGuard

Namespace: AutoFixture.Kernel
Assembly: AutoFixture.dll

Prevents a decorated ISpecimenBuilder from returning a NoSpecimen instance.

public class NoSpecimenOutputGuard : ISpecimenBuilderNode, ISpecimenBuilder, IEnumerable<ISpecimenBuilder>, IEnumerable

Inheritance

object ← NoSpecimenOutputGuard

Implements

ISpecimenBuilderNode, ISpecimenBuilder, IEnumerable<ISpecimenBuilder>, IEnumerable

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Extension Methods

SpecimenFactory.Create<T>(ISpecimenBuilder), SpecimenFactory.CreateMany<T>(ISpecimenBuilder), SpecimenFactory.CreateMany<T>(ISpecimenBuilder, int), SpecimenCommand.Do<T>(ISpecimenBuilder, Action<T>), SpecimenCommand.Do<T1, T2>(ISpecimenBuilder, Action<T1, T2>), SpecimenCommand.Do<T1, T2, T3>(ISpecimenBuilder, Action<T1, T2, T3>), SpecimenCommand.Do<T1, T2, T3, T4>(ISpecimenBuilder, Action<T1, T2, T3, T4>), SpecimenQuery.Get<T, TResult>(ISpecimenBuilder, Func<T, TResult>), SpecimenQuery.Get<T1, T2, TResult>(ISpecimenBuilder, Func<T1, T2, TResult>), SpecimenQuery.Get<T1, T2, T3, TResult>(ISpecimenBuilder, Func<T1, T2, T3, TResult>), SpecimenQuery.Get<T1, T2, T3, T4, TResult>(ISpecimenBuilder, Func<T1, T2, T3, T4, TResult>), SpecimenBuilderNode.GraphEquals(ISpecimenBuilderNode, ISpecimenBuilderNode), SpecimenBuilderNode.GraphEquals(ISpecimenBuilderNode, ISpecimenBuilderNode, IEqualityComparer<ISpecimenBuilder>), CustomizationExtensions.ToCustomization(ISpecimenBuilder)

Constructors

NoSpecimenOutputGuard(ISpecimenBuilder)

Initializes a new instance of the NoSpecimenOutputGuard class with an ISpecimenBuilder to decorate.

public NoSpecimenOutputGuard(ISpecimenBuilder builder)

Parameters

builder ISpecimenBuilder

The builder to decorate.

NoSpecimenOutputGuard(ISpecimenBuilder, IRequestSpecification)

Initializes a new instance of the NoSpecimenOutputGuard class with an ISpecimenBuilder to decorate and an IRequestSpecification that is used to determine whether an exception should be thrown based on the request.

public NoSpecimenOutputGuard(ISpecimenBuilder builder, IRequestSpecification specification)

Parameters

builder ISpecimenBuilder

The builder to decorate.

specification IRequestSpecification

The specification.

Properties

Builder

Gets the decorated builder.

public ISpecimenBuilder Builder { get; }

Property Value

ISpecimenBuilder

See Also

NoSpecimenOutputGuard.NoSpecimenOutputGuard(ISpecimenBuilder), NoSpecimenOutputGuard.NoSpecimenOutputGuard(ISpecimenBuilder, IRequestSpecification)

Specification

Gets the specification that is used to determine whether an exception should be thrown for a request that returns a NoSpecimen instance.

public IRequestSpecification Specification { get; }

Property Value

IRequestSpecification

See Also

NoSpecimenOutputGuard.NoSpecimenOutputGuard(ISpecimenBuilder), NoSpecimenOutputGuard.NoSpecimenOutputGuard(ISpecimenBuilder, IRequestSpecification)

Methods

Compose(IEnumerable<ISpecimenBuilder>)

Composes the supplied builders.

public ISpecimenBuilderNode Compose(IEnumerable<ISpecimenBuilder> builders)

Parameters

builders IEnumerable<ISpecimenBuilder>

The builders to compose.

Returns

ISpecimenBuilderNode

A new ISpecimenBuilderNode instance containing builders as child nodes.

Create(object, ISpecimenContext)

Creates a new specimen by delegating to the decorated Builder.

public object Create(object request, ISpecimenContext context)

Parameters

request object

The request that describes what to create.

context ISpecimenContext

A context that can be used to create other specimens.

Returns

object

The requested specimen if possible; otherwise an exception is thrown or a NoSpecimen instance is returned.

Exceptions

ObjectCreationException

The decorated Builder returned a NoSpecimen result and Specification returned true for request.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<ISpecimenBuilder> GetEnumerator()

Returns

IEnumerator<ISpecimenBuilder>

A IEnumerator%601 that can be used to iterate through the collection.