ContractAbbreviatorAttribute Class

.NET Framework 4.5

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

System.Object
  System.Attribute
    System.Diagnostics.Contracts.ContractAbbreviatorAttribute

Namespace:  System.Diagnostics.Contracts
Assembly:  mscorlib (in mscorlib.dll)

[AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple = false)]
[ConditionalAttribute("CONTRACTS_FULL")]
public sealed class ContractAbbreviatorAttribute : Attribute

The ContractAbbreviatorAttribute type exposes the following members.

  NameDescription
Public methodContractAbbreviatorAttributeInitializes a new instance of the ContractAbbreviatorAttribute class.
Top

  NameDescription
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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();
   }
}

.NET Framework

Supported in: 4.6, 4.5

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft