ContractAbbreviatorAttribute Class

Definition

Namespace:

System.Diagnostics.Contracts

Assemblies:

netstandard.dll, System.Diagnostics.Contracts.dll

Source:

Contracts.cs

Defines abbreviations that you can use in place of the full contract syntax.

public ref class ContractAbbreviatorAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false)]
[System.Diagnostics.Conditional("CONTRACTS_FULL")]
public sealed class ContractAbbreviatorAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false)>]
[<System.Diagnostics.Conditional("CONTRACTS_FULL")>]
type ContractAbbreviatorAttribute = class
    inherit Attribute

Public NotInheritable Class ContractAbbreviatorAttribute
Inherits Attribute

Inheritance

Object

Attribute

ContractAbbreviatorAttribute

Attributes

AttributeUsageAttribute ConditionalAttribute

Examples

The following example demonstrates how to create abbreviated names for code contracts that are repeated in several methods.

using System.Diagnostics.Contracts;  

public class MyClass   
{  
   public int State { get; }  
   public int Data { get; }  

   [ ContractAbbreviator ]  
   private void DataAndStateUnchanged()   
   {  
      Contract.Ensures( this .State == Contract.OldValue(this.State));  
      Contract.Ensures( this .Data == Contract.OldValue(this.Data));  
   }  

   [ ContractAbbreviator ]  
   private void InStateZeroAndUnchanged()   
   {  
      Contract.Requires( this.State == 0);  
      DataAndStateUnchanged();  
   }  

   public void Method1(...)   
   {  
      InStateZeroAndUnchanged();  
      ...  
   }  

   public void Method2(...)   
   {  
      InStateZeroAndUnchanged();  
      ...  
   }  

   public void Method3(...)  
   {  
      Contract.Requires(this .State == 1);  
      DataAndStateUnchanged();  
   }  
}  

Constructors

Name	Description
ContractAbbreviatorAttribute()	Initializes a new instance of the ContractAbbreviatorAttribute class.

Properties

Name	Description
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Name	Description
Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)