Enumerable.Contains Método

Definição

Namespace:

System.Linq

Assembly:

System.Linq.dll

Determina se uma sequência contém um elemento especificado.

Sobrecargas

Contains<TSource>(IEnumerable<TSource>, TSource)	Determina se uma sequência contém um elemento especificado usando o comparador de igualdade padrão.
Contains<TSource>(IEnumerable<TSource>, TSource, IEqualityComparer<TSource>)	Determina se uma sequência contém um elemento especificado usando um IEqualityComparer<T> especificado.

Contains<TSource>(IEnumerable<TSource>, TSource)

Origem:

Contains.cs

Determina se uma sequência contém um elemento especificado usando o comparador de igualdade padrão.

C#

public static bool Contains<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, TSource value);

Parâmetros de tipo

TSource

O tipo dos elementos de source.

Parâmetros

source

IEnumerable<TSource>

Uma sequência na qual um valor será localizado.

value

TSource

O valor a ser localizado na sequência.

Retornos

Boolean

true se a sequência de origem contiver um elemento que tem o valor especificado; caso contrário, false.

Exceções

ArgumentNullException

source é null.

Exemplos

O exemplo de código a seguir demonstra como usar Contains<TSource>(IEnumerable<TSource>, TSource) para determinar se uma matriz contém um elemento específico.

C#

string[] fruits = { "apple", "banana", "mango", "orange", "passionfruit", "grape" };

string fruit = "mango";

bool hasMango = fruits.Contains(fruit);

Console.WriteLine(
    "The array {0} contain '{1}'.",
    hasMango ? "does" : "does not",
    fruit);

// This code produces the following output:
//
// The array does contain 'mango'.

Comentários

Se o tipo de source implementar ICollection<T>, o Contains método nessa implementação será invocado para obter o resultado. Caso contrário, esse método determina se source contém o elemento especificado.

A enumeração é encerrada assim que um elemento correspondente é encontrado.

Os elementos são comparados com o valor especificado usando o comparador de igualdade padrão, Default.

Contains<TSource>(IEnumerable<TSource>, TSource, IEqualityComparer<TSource>)

Origem:

Contains.cs

Determina se uma sequência contém um elemento especificado usando um IEqualityComparer<T> especificado.

C#

public static bool Contains<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, TSource value, System.Collections.Generic.IEqualityComparer<TSource>? comparer);

Parâmetros de tipo

TSource

O tipo dos elementos de source.

Parâmetros

source

IEnumerable<TSource>

Uma sequência na qual um valor será localizado.

value

TSource

O valor a ser localizado na sequência.

comparer

IEqualityComparer<TSource>

Um comparador de igualdade para comparar valores.

Retornos

Boolean

true se a sequência de origem contiver um elemento que tem o valor especificado; caso contrário, false.

Exceções

ArgumentNullException

source é null.

Exemplos

O exemplo a seguir mostra como implementar um comparador de igualdade que pode ser usado no Contains método .

C#

public class Product
{
    public string Name { get; set; }
    public int Code { get; set; }
}

// Custom comparer for the Product class
class ProductComparer : IEqualityComparer<Product>
{
    // Products are equal if their names and product numbers are equal.
    public bool Equals(Product x, Product y)
    {

        //Check whether the compared objects reference the same data.
        if (Object.ReferenceEquals(x, y)) return true;

        //Check whether any of the compared objects is null.
        if (Object.ReferenceEquals(x, null) || Object.ReferenceEquals(y, null))
            return false;

        //Check whether the products' properties are equal.
        return x.Code == y.Code && x.Name == y.Name;
    }

    // If Equals() returns true for a pair of objects
    // then GetHashCode() must return the same value for these objects.

    public int GetHashCode(Product product)
    {
        //Check whether the object is null
        if (Object.ReferenceEquals(product, null)) return 0;

        //Get hash code for the Name field if it is not null.
        int hashProductName = product.Name == null ? 0 : product.Name.GetHashCode();

        //Get hash code for the Code field.
        int hashProductCode = product.Code.GetHashCode();

        //Calculate the hash code for the product.
        return hashProductName ^ hashProductCode;
    }
}

Depois de implementar esse comparador, você pode usar uma sequência de Product objetos no Contains método , conforme mostrado no exemplo a seguir:

C#

Product[] fruits = { new Product { Name = "apple", Code = 9 },
                       new Product { Name = "orange", Code = 4 },
                       new Product { Name = "lemon", Code = 12 } };

Product apple = new Product { Name = "apple", Code = 9 };
Product kiwi = new Product { Name = "kiwi", Code = 8 };

ProductComparer prodc = new ProductComparer();

bool hasApple = fruits.Contains(apple, prodc);
bool hasKiwi = fruits.Contains(kiwi, prodc);

Console.WriteLine("Apple? " + hasApple);
Console.WriteLine("Kiwi? " + hasKiwi);

/*
    This code produces the following output:

    Apple? True
    Kiwi? False
*/

Comentários

A enumeração é encerrada assim que um elemento correspondente é encontrado.

Se comparer for null, o comparador de igualdade padrão, Default, será usado para comparar elementos com o valor especificado.