Post­Sharp Documentation / API Reference / Post­Sharp.​Patterns.​Threading Namespace / Immutable­Attribute Class

ImmutableAttribute Class

Custom attribute that, when applied to a class, implements the ImmutableThreadingModel to this class. The aspect introduces the IImmutable interface into the target class. Immutable objects cannot be modified after the constructor exits.
Inheritance Hierarchy
System.Object
  System.Attribute
    PostSharp.Extensibility.MulticastAttribute
      PostSharp.Aspects.Aspect
        PostSharp.Aspects.TypeLevelAspect
          PostSharp.Aspects.InstanceLevelAspect
            PostSharp.Patterns.Model.AggregatableClientAttribute
              PostSharp.Patterns.Threading.ThreadAwareAttribute
                PostSharp.Patterns.Threading.ReadOnlyThreadAwareAttribute
                  PostSharp.Patterns.Threading.ImmutableAttribute

Namespace:  PostSharp.Patterns.Threading
Assembly:  PostSharp.Patterns.Threading (in PostSharp.Patterns.Threading.dll) Version: 5.0.38.0 (5.0.38.0)
Syntax
C#
public sealed class ImmutableAttribute : ReadOnlyThreadAwareAttribute, 
	IImmutable, IThreadAware

The ImmutableAttribute type exposes the following members.

Constructors
  NameDescription
Public methodImmutableAttribute
Initializes a new instance of the ImmutableAttribute class
Properties
  NameDescription
Public propertyAspectPriority
Gets or sets the weaving priority of the aspect.
(Inherited from Aspect.)
Public propertyAttributeExclude
If true, indicates that this attribute removes all other instances of the same attribute type from the set of elements defined by the current instance.
(Inherited from MulticastAttribute.)
Public propertyAttributeInheritance
Determines whether this attribute is inherited
(Inherited from MulticastAttribute.)
Public propertyAttributePriority
Gets or sets the priority of the current attribute in case that multiple instances are defined on the same element (lower values are processed before).
(Inherited from MulticastAttribute.)
Public propertyAttributeReplace
Determines whether this attribute replaces other attributes found on the target declarations.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetAssemblies
Gets or sets the assemblies to which the current attribute apply.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetElements
Gets or sets the kind of elements to which this custom attributes applies.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetExternalMemberAttributes
Gets or sets the visibilities, scopes, virtualities, and implementation of members to which this attribute applies, when the member is external to the current module.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetExternalTypeAttributes
Gets or sets the visibilities of types to which this attribute applies, when this type is external to the current module.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetMemberAttributes
Gets or sets the visibilities, scopes, virtualities, and implementation of members to which this attribute applies.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetMembers
Gets or sets the expression specifying to which members this instance applies.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetParameterAttributes
Gets or sets the passing style (by value, out or ref) of parameters to which this attribute applies.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetParameters
Gets or sets the expression specifying to which parameters this instance applies.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetTypeAttributes
Gets or sets the visibilities of types to which this attribute applies.
(Inherited from MulticastAttribute.)
Public propertyAttributeTargetTypes
Gets or sets the expression specifying to which types this instance applies.
(Inherited from MulticastAttribute.)
Public propertyInstance
Gets the object to which the current aspect has been applied.
(Inherited from InstanceLevelAspect.)
Public propertyRuntimeVerificationEnabled
Determines whether the code should be verified against the model at runtime. The default value is true for the debug build configuration and false for the release build configuration.
(Inherited from ThreadAwareAttribute.)
Methods
  NameDescription
Public methodCompileTimeInitialize(Type, AspectInfo)
Method invoked at build time to initialize the instance fields of the current aspect. This method is invoked before any other build-time method.
(Inherited from TypeLevelAspect.)
Public methodCompileTimeInitialize(Type, AspectInfo)
Method invoked at build time to initialize the instance fields of the current aspect. This method is invoked before any other build-time method.
(Inherited from AggregatableClientAttribute.)
Public methodCompileTimeValidate(Object)
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from Aspect.)
Public methodCompileTimeValidate(Object)
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from TypeLevelAspect.)
Public methodCompileTimeValidate(Type)
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from TypeLevelAspect.)
Public methodCompileTimeValidate(Type)
Method invoked at build time to ensure that the aspect has been applied to the right target.
(Inherited from ThreadAwareAttribute.)
Public methodCreateInstance
Creates a new instance of the aspect based on the current instance, serving as a prototype.
(Inherited from InstanceLevelAspect.)
Public methodFinalize (Inherited from ThreadAwareAttribute.)
Public methodGetAspectConfiguration
Method invoked at build tome to get the imperative configuration of the current Aspect.
(Inherited from Aspect.)
Public methodOnCloned
Method called after the an object enhanced by the current aspect has been cloned using MemberwiseClone(). The this parameter refers to the new aspect instance in the cloned object.
(Inherited from InstanceLevelAspect.)
Public methodOnFieldGet<T> (Inherited from ThreadAwareAttribute.)
Public methodOnFieldSet<T> (Inherited from ThreadAwareAttribute.)
Public methodOnInstanceConstructed
Executed when the target instance gets fully initialized, i.e. just after all constructors have completed.
(Overrides AggregatableClientAttribute.OnInstanceConstructed().)
Public methodOnSerializing
Requires read access level to the current object before serialization can proceed. This method will be introduced into the target class.
(Inherited from ThreadAwareAttribute.)
Public methodRuntimeInitialize
Initializes the current aspect.
(Inherited from TypeLevelAspect.)
Public methodRuntimeInitializeInstance()
Initializes the aspect instance. This method is invoked when all system elements of the aspect (like member imports) have completed.
(Inherited from InstanceLevelAspect.)
Public methodRuntimeInitializeInstance()
Initializes the aspect instance. This method is invoked when all system elements of the aspect (like member imports) have completed.
(Inherited from ReadOnlyThreadAwareAttribute.)
Fields
  NameDescription
Public fieldBaseFinalizeMethod (Inherited from ThreadAwareAttribute.)
Extension Methods
  NameDescription
Public Extension MethodAcquireAccess(ObjectAccessLevel)Overloaded.
Acquires access to given object and returns the ConcurrentAccessToken.
(Defined by ThreadAwareExtensions.)
Public Extension MethodAcquireAccess(ObjectAccessLevel, ConcurrentAccessToken)Overloaded.
Acquires access for a given object and gets the ConcurrentAccessToken as a reference parameter.
(Defined by ThreadAwareExtensions.)
Public Extension MethodAcquireAccessAsync
Asynchronously acquires access for a given object.
(Defined by ThreadAwareExtensions.)
Public Extension MethodQueryInterface<T>
Gets the implementation of a specified interface for the specified object.
(Defined by QueryInterfaceExtensions.)
See Also