Coleções devem implementar a interface genérica

Artigo
08/25/2010

TypeName	CollectionsShouldImplementGenericInterface
CheckId	CA1010
Category (Categoria)	Microsoft.Design
Quebrando alterar	Não separável

Causa

Um tipo visível externamente implementa o System.Collections.IEnumerable interface mas não implementa o System.Collections.Generic.IEnumerable<T> interface e os destinos de assembly contendo .NET Framework 2,0. Esta regra ignora tipos que implementam System.Collections.IDictionary.

Descrição da regra

Para expandir a capacidade de uso de uma coleção, implemente uma das interfaces de coleção genérica.A coleção pode ser usado para popular sistema autônomo tipos de coleção genéricas, sistema autônomo o seguinte:

Como corrigir violações

Para corrigir uma violação dessa regra, implemente uma das seguintes interfaces de coleção genéricos:

Quando suprimir avisos

É seguro eliminar um aviso da regra; no entanto, a coleção terá um uso mais limitado.

Violação de exemplo

Descrição

O exemplo a seguir mostra uma classe (tipo de referência) que deriva da não genérica CollectionBase classe viola essa regra.

Código

using System;
using System.Collections;

namespace Samples
{
    public class Book
    {
        public Book()
        {
        }
    }

    public class BookCollection : CollectionBase
    {
        public BookCollection()
        {
        }

        public void Add(Book value)
        {
            InnerList.Add(value);
        }

        public void Remove(Book value)
        {
            InnerList.Remove(value);
        }

        public void Insert(int index, Book value)
        {
            InnerList.Insert(index, value);
        }

        public Book this[int index]
        {
            get { return (Book)InnerList[index]; }
            set { InnerList[index] = value; }
        }

        public bool Contains(Book value)
        {
            return InnerList.Contains(value);
        }

        public int IndexOf(Book value)
        {
            return InnerList.IndexOf(value);
        }

        public void CopyTo(Book[] array, int arrayIndex)
        {
            InnerList.CopyTo(array, arrayIndex);
        }
    }
}

Comentários

Para corrigir uma violação dessa violação, você deve implementar interfaces genéricas ou alterar a classe base para um tipo que já implementa dois genéricas e não genéricas interfaces, sistema autônomo a Collection<T> classe.

Para corrigir, alterar classes base

Descrição

O exemplo a seguir corrige a violação alterando a classe base da coleção da não genérica CollectionBase classe para a genérica Collection<T> (Collection(Of T) em Visual Basic) classe.

Código

using System;
using System.Collections.ObjectModel; 

namespace Samples
{    
    public class Book        
    {               
        public Book()                
        {                
        }        
    }    

    public class BookCollection : Collection<Book>    
    {        
        public BookCollection()        
        {        
        }    
    }
}

Comentários

Alterar a classe base de uma classe já lançada é considerada uma alteração significativa aos clientes existentes.

Para corrigir, implementação de interface

Descrição

O exemplo a seguir corrige a violação ao implementar essas interfaces genéricas: IEnumerable<T>, ICollection<T>, e IList<T> (IEnumerable(Of T), ICollection(Of T), e IList(Of T) em Visual Basic).

Código

using System;
using System.Collections;
using System.Collections.Generic;

namespace Samples
{
    public class Book
    {
        public Book()
        {
        }
    }

    public class BookCollection : CollectionBase, IList<Book>
    {
        public BookCollection()
        {
        }

        int IList<Book>.IndexOf(Book item)
        {
            return this.List.IndexOf(item);
        }

        void IList<Book>.Insert(int location, Book item)
        {
        }

        Book IList<Book>.this[int index]
        {
            get { return (Book) this.List[index]; }
            set { }
        }

        void ICollection<Book>.Add(Book item)
        {
        }

        bool ICollection<Book>.Contains(Book item)
        {
            return true;
        }

        void ICollection<Book>.CopyTo(Book[] array, int arrayIndex)
        {
        }

        bool ICollection<Book>.IsReadOnly
        {
            get { return false; }
        }

        bool ICollection<Book>.Remove(Book item)
        {
            if (InnerList.Contains(item))
            {
                InnerList.Remove(item);
                return true;
            }
            return false;
        }

        IEnumerator<Book> IEnumerable<Book>.GetEnumerator()
        {
            return new BookCollectionEnumerator(InnerList.GetEnumerator());
        }

        private class BookCollectionEnumerator : IEnumerator<Book>
        {
            private IEnumerator _Enumerator;

            public BookCollectionEnumerator(IEnumerator enumerator)
            {
                _Enumerator = enumerator;
            }

            public Book Current
            {
                get { return (Book)_Enumerator.Current; }
            }

            object IEnumerator.Current
            {
                get { return _Enumerator.Current; }
            }

            public bool MoveNext()
            {
                return _Enumerator.MoveNext();
            }

            public void Reset()
            {
                _Enumerator.Reset();
            }

            public void Dispose()
            {
            }
        }
    }
}