Class FrozenAttribute

Namespace: AutoFixture.Xunit2
Assembly: AutoFixture.Xunit2.dll

An attribute that can be applied to parameters in an AutoDataAttribute-driven Theory to indicate that the parameter value should be frozen so that the same instance is returned every time the IFixture creates an instance of that type.

[AttributeUsage(AttributeTargets.Parameter, AllowMultiple = false)]
public sealed class FrozenAttribute : CustomizeAttribute, IParameterCustomizationSource

Inheritance

object ← Attribute ← CustomizeAttribute ← FrozenAttribute

Implements

IParameterCustomizationSource

Inherited Members

CustomizeAttribute.GetCustomization(ParameterInfo), Attribute.GetCustomAttributes(MemberInfo, Type), Attribute.GetCustomAttributes(MemberInfo, Type, bool), Attribute.GetCustomAttributes(MemberInfo), Attribute.GetCustomAttributes(MemberInfo, bool), Attribute.IsDefined(MemberInfo, Type), Attribute.IsDefined(MemberInfo, Type, bool), Attribute.GetCustomAttribute(MemberInfo, Type), Attribute.GetCustomAttribute(MemberInfo, Type, bool), Attribute.GetCustomAttributes(ParameterInfo), Attribute.GetCustomAttributes(ParameterInfo, Type), Attribute.GetCustomAttributes(ParameterInfo, Type, bool), Attribute.GetCustomAttributes(ParameterInfo, bool), Attribute.IsDefined(ParameterInfo, Type), Attribute.IsDefined(ParameterInfo, Type, bool), Attribute.GetCustomAttribute(ParameterInfo, Type), Attribute.GetCustomAttribute(ParameterInfo, Type, bool), Attribute.GetCustomAttributes(Module, Type), Attribute.GetCustomAttributes(Module), Attribute.GetCustomAttributes(Module, bool), Attribute.GetCustomAttributes(Module, Type, bool), Attribute.IsDefined(Module, Type), Attribute.IsDefined(Module, Type, bool), Attribute.GetCustomAttribute(Module, Type), Attribute.GetCustomAttribute(Module, Type, bool), Attribute.GetCustomAttributes(Assembly, Type), Attribute.GetCustomAttributes(Assembly, Type, bool), Attribute.GetCustomAttributes(Assembly), Attribute.GetCustomAttributes(Assembly, bool), Attribute.IsDefined(Assembly, Type), Attribute.IsDefined(Assembly, Type, bool), Attribute.GetCustomAttribute(Assembly, Type), Attribute.GetCustomAttribute(Assembly, Type, bool), Attribute.Equals(object?), Attribute.GetHashCode(), Attribute.Match(object?), Attribute.IsDefaultAttribute(), Attribute.TypeId, object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors

FrozenAttribute()

Initializes a new instance of the FrozenAttribute class.

public FrozenAttribute()

Remarks

The Matching criteria used to determine which requests will be satisfied by the frozen parameter value is ExactType.

FrozenAttribute(Matching)

Initializes a new instance of the FrozenAttribute class.

public FrozenAttribute(Matching by)

Parameters

by Matching

The Matching criteria used to determine which requests will be satisfied by the frozen parameter value.

Properties

As

Gets or sets the Type that the frozen parameter value should be mapped to in the IFixture.

[Obsolete("The ability to map a frozen object to a specific type is deprecated and will likely be removed in the future. If you wish to map a frozen type to its implemented interfaces, use [Frozen(Matching.ImplementedInterfaces)]. If you instead wish to map it to its direct base type, use [Frozen(Matching.DirectBaseType)].", true)]
public Type As { get; set; }

Property Value

Type

By

Gets the Matching criteria used to determine which requests will be satisfied by the frozen parameter value.

public Matching By { get; }

Property Value

Matching

Methods

GetCustomization(ParameterInfo)

Gets a FreezeOnMatchCustomization configured to match requests based on the Type and optionally the name of the parameter.

public override ICustomization GetCustomization(ParameterInfo parameter)

Parameters

parameter ParameterInfo

The parameter for which the customization is requested.

Returns

ICustomization

A FreezeOnMatchCustomization configured to match requests based on the Type and optionally the name of the parameter.