Class Omitter

Namespace: AutoFixture.Kernel
Assembly: AutoFixture.dll

Issues OmitSpecimen instances if its encapsulated IRequestSpecification is satisfied.

public class Omitter : ISpecimenBuilder

Inheritance

object ← Omitter

Implements

ISpecimenBuilder

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>), CustomizationExtensions.ToCustomization(ISpecimenBuilder)

Constructors

Omitter()

Initializes a new instance of the Omitter class.

public Omitter()

Omitter(IRequestSpecification)

Initializes a new instance of the Omitter class with the supplied IRequestSpecification.

public Omitter(IRequestSpecification specification)

Parameters

specification IRequestSpecification

A specification used to control whether or not an OmitSpecimen instance should be issued.

Exceptions

ArgumentNullException

specification.

See Also

Omitter.Specification

Properties

Specification

Gets the specification used to control whether an OmitSpecimen instance should be issued upon request.

public IRequestSpecification Specification { get; }

Property Value

IRequestSpecification

Remarks

If the constructor overload that takes an `IRequestSpecification` as input was used, this property returns that instance.

See Also

Omitter.Create(object, ISpecimenContext), Omitter.Omitter(IRequestSpecification)

Methods

Create(object, ISpecimenContext)

Creates a new specimen based on a request.

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

An OmitSpecimen instance if Specification allows it; otherwise a NoSpecimen instance.

Remarks

The request can be any object, but will often be a `Type` or other `MemberInfo` instances.

Exceptions

ArgumentNullException

request.