ContractArgumentValidatorAttribute Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Permite a fatoração do código if-then-throw
herdado em métodos separados para reutilização e fornece controle total sobre as exceções lançadas e os argumentos.
public ref class ContractArgumentValidatorAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false)]
[System.Diagnostics.Conditional("CONTRACTS_FULL")]
public sealed class ContractArgumentValidatorAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false)>]
[<System.Diagnostics.Conditional("CONTRACTS_FULL")>]
type ContractArgumentValidatorAttribute = class
inherit Attribute
Public NotInheritable Class ContractArgumentValidatorAttribute
Inherits Attribute
- Herança
- Atributos
Comentários
Se o código usar código explícito if-then-throw
para validar parâmetros, você poderá estar empregando métodos auxiliares que executam verificações e geram exceções específicas em caso de falha, conforme mostrado no exemplo a seguir.
using System;
static class ValidationHelper
{
public static void NotNull(object argument, string parameterName)
{
if (argument == null) throw new ArgumentNullException(parameterName,
"The parameter cannot be null.");
}
}
public class Example
{
public void Execute(string value)
{
ValidationHelper.NotNull(value, "value");
// Body of method goes here.
}
}
Class ValidationHelper
Public Shared Sub NotNull(argument As Object, parameterName As String)
If argument Is Nothing Then
Throw New ArgumentNullException(parameterName,
"The parameter cannot be null.")
End If
End Sub
End Class
Module Example
Public Sub Execute(value As String)
ValidationHelper.NotNull(value, "value")
' Body of method goes here.
End Sub
End Module
Neste exemplo, Execute
tem uma pré-condição eletiva especificando que o valor do parâmetro não deve ser null
. Para permitir que as ferramentas de contrato reconheçam que a chamada para ValidationHelper.NotNull
representa um contrato, você pode marcar o método chamado com o ContractArgumentValidatorAttribute atributo . A Contract.EndContractBlock chamada de método deve ser usada para permitir que as ferramentas extraam as especificações adequadas para a geração de documentos e a verificação estática, da seguinte maneira.
using System;
using System.Diagnostics.Contracts;
static class ValidationHelper
{
[ContractArgumentValidator]
public static void NotNull(object argument, string parameterName)
{
if (argument == null) throw new ArgumentNullException(parameterName,
"The parameter cannot be null.");
Contract.EndContractBlock();
}
}
Imports System.Diagnostics.Contracts
Class ValidationHelper
<ContractArgumentValidator>
Public Shared Sub NotNull(argument As Object, parameterName As String)
If argument Is Nothing Then
Throw New ArgumentNullException(parameterName,
"The parameter cannot be null.")
Contract.EndContractBlock()
End If
End Sub
End Class
Além if-then-throw
das instruções, a seção de contrato dos métodos validadores de contrato pode conter chamadas para outros métodos validadores de contrato. No entanto, nenhum outro contrato (como Contract.Requiresou Contract.Ensures) é permitido. O código que segue a Contract.EndContractBlock chamada é ignorado por todas as ferramentas de contrato.
O exemplo a seguir mostra um validador de argumento de intervalo escrito em termos de um método validador existente NotNull
.
using System;
using System.Diagnostics.Contracts;
static class ValidationHelper
{
[ContractArgumentValidator]
public static void NotNull(object argument, string parameterName)
{
if (argument == null) throw new ArgumentNullException(parameterName,
"The parameter cannot be null.");
Contract.EndContractBlock();
}
[ContractArgumentValidator]
public static void InRange(object[] array, int index, string arrayName, string indexName)
{
NotNull(array, arrayName);
if (index < 0)
throw new ArgumentOutOfRangeException(indexName,
"The index cannot be negative.");
if (index >= array.Length)
throw new ArgumentOutOfRangeException(indexName,
"The index is outside the bounds of the array.");
Contract.EndContractBlock();
}
}
public class Example
{
public void Execute(object[] data, int position)
{
ValidationHelper.InRange(data, position, "data", "position");
// Body of method goes here.
}
}
Imports System.Diagnostics.Contracts
Class ValidationHelper
<ContractArgumentValidator>
Public Shared Sub NotNull(argument As Object, parameterName As String)
If argument Is Nothing Then
Throw New ArgumentNullException(parameterName,
"The parameter cannot be null.")
Contract.EndContractBlock()
End If
End Sub
<ContractArgumentValidator>
Public Shared Sub InRange(array() As Object, index As Integer,
arrayName As String, indexName As String)
NotNull(array, arrayName)
If index < 0 Then
Throw New ArgumentOutOfRangeException(indexName,
"The index cannot be negative.")
End If
If index >= array.Length Then
Throw New ArgumentOutOfRangeException(indexName,
"The index is outside the bounds of the array.")
End If
Contract.EndContractBlock()
End Sub
End Class
Module Example
Public Sub Execute(data() As Object, position As Integer)
ValidationHelper.InRange(data, position, "data", "position")
' Body of method goes here.
End Sub
End Module
Do ponto de vista de especificação, o Execute
método tem os três seguintes contratos:
Contract.Requires<ArgumentNullException>(data != null);
Contract.Requires<ArgumentOutOfRangeException>(position >= 0);
Contract.Requires<ArgumentOutOfRangeException>(position < data.Length);
Em métodos padrão, as chamadas para métodos de validador de contrato podem ser livremente misturadas com outros contratos, como Contract.Ensures ou Contract.Requires.
Construtores
ContractArgumentValidatorAttribute() |
Inicializa uma nova instância da classe ContractArgumentValidatorAttribute. |
Propriedades
TypeId |
Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute) |
Métodos
Equals(Object) |
Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute) |
GetHashCode() |
Retorna o código hash para a instância. (Herdado de Attribute) |
GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
IsDefaultAttribute() |
Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute) |
Match(Object) |
Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute) |
MemberwiseClone() |
Cria uma cópia superficial do Object atual. (Herdado de Object) |
ToString() |
Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object) |
Implantações explícitas de interface
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) |
Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição. (Herdado de Attribute) |
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) |
Recupera as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface. (Herdado de Attribute) |
_Attribute.GetTypeInfoCount(UInt32) |
Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1). (Herdado de Attribute) |
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) |
Fornece acesso a propriedades e métodos expostos por um objeto. (Herdado de Attribute) |