« Les méthodes d'extension » : différence entre les versions

De Banane Atomic
Aller à la navigationAller à la recherche
 
(8 versions intermédiaires par le même utilisateur non affichées)
Ligne 24 : Ligne 24 :


= Useful extension methods =
= Useful extension methods =
== CollectionExtensions ==
== CollectionExtension ==
<kode lang="cs" collapsed>
<filebox fn="CollectionExtension.cs" collapsed>
public static class CollectionExtensions
/// <summary>
/// Adds each item to the list.
/// </summary>
/// <remarks>
/// The <see cref="IList{T}" /> interface does not have AddRange in its contract, contrary to the <see cref="List{T}" /> implementation.
/// The latter uses an optimized routine for adding a range of elements, and naming this extension method AddRange too would give the wrong impression of performance.
/// Additionally, for collections that notify of their changes, AddRange reads as if there would be only one notification of change after all elements have been added, when in fact there would probably by as many notifications as items being added.
/// </remarks>
public static void AddEach<T>(this ICollection<T> collection, IEnumerable<T> elements)
{
{
     /// <summary>
     ArgumentNullException.ThrowIfNull(collection);
     /// Adds each item to the list.
     ArgumentNullException.ThrowIfNull(elements);
    /// </summary>
 
     /// <remarks>
     if (collection is List<T> list)
     /// The <see cref="IList{T}" /> interface does not have AddRange in its contract, contrary to the <see cref="List{T}" /> implementation.
     {
    /// The latter uses an optimized routine for adding a range of elements, and naming this extension method AddRange too would give the wrong impression of performance.
        list.AddRange(elements);
    /// Additionally, for collections that notify of their changes, AddRange reads as if there would be only one notification of change after all elements have been added, when in fact there would probably by as many notifications as items being added.
     }
     /// </remarks>
     else
     public static void AddEach<T>(this ICollection<T> collection, IEnumerable<T> elements)
     {
     {
         if (collection == null)
         foreach (var element in elements)
         {
         {
             throw new ArgumentNullException(nameof(collection));
             collection.Add(element);
         }
         }
    }
}


        if (elements == null)
/// <summary>
        {
/// Removes each item from the list.
            throw new ArgumentNullException(nameof(elements));
/// </summary>
        }
/// <remarks>
/// This method is not named RemoveRange, because it does not have the same purpose as <see cref="List{T}.RemoveRange" />.
/// </remarks>
public static void RemoveEach<T>(this ICollection<T> collection, IEnumerable<T> elements)
{
    ArgumentNullException.ThrowIfNull(collection);
    ArgumentNullException.ThrowIfNull(elements);


        if (collection is List<T> list)
    foreach (var element in elements)
        {
    {
            list.AddRange(elements);
        collection.Remove(element);
        }
        else
        {
            foreach (var element in elements)
            {
                collection.Add(element);
            }
        }
     }
     }
}
public static void Remove<T>(this ICollection<T> collection, Func<T, bool> predicate)
{
    ArgumentNullException.ThrowIfNull(collection);


     /// <summary>
     collection.RemoveEach(collection.Where(predicate));
    /// Removes each item from the list.
}
    /// </summary>
 
    /// <remarks>
public static void RemoveSingle<T>(this ICollection<T> collection, Func<T, bool> predicate)
    /// This method is not named RemoveRange, because it does not have the same purpose as <see cref="List{T}.RemoveRange" />.
{
    /// </remarks>
    ArgumentNullException.ThrowIfNull(collection);
    public static void RemoveEach<T>(this ICollection<T> collection, IEnumerable<T> elements)
    {
        if (collection == null)
        {
            throw new ArgumentNullException(nameof(collection));
        }


        if (elements == null)
    collection.Remove(collection.Single(predicate));
        {
}
            throw new ArgumentNullException(nameof(elements));
</filebox>
        }


        foreach (var element in elements)
== IEnumerableExtension ==
        {
<filebox fn='IEnumerableExtension.cs' collapsed>
            collection.Remove(element);
/// <summary>
        }
/// Update all the items of the collection.
/// </summary>
public static IEnumerable<T> SetValue<T>(this IEnumerable<T> items, Action<T> updateMethod)
{
    foreach (T item in items)
    {
        updateMethod(item);
     }
     }


     public static void Remove<T>(this ICollection<T> collection, Func<T, bool> predicate)
     return items;
    {
}
        if (collection == null)
        {
            throw new ArgumentNullException(nameof(collection));
        }


        collection.RemoveEach(collection.Where(predicate));
/// <summary>
    }
/// Sorts the elements of a sequence according to an element's property.
/// </summary>
public static IEnumerable<T> OrderBy<T>(
    this IEnumerable<T> source,
    string propertyName,
    bool ascendingOrder)
{
    var propertyDescriptor = TypeDescriptor.GetProperties(typeof(T))
                                          .Find(propertyName, false);


     public static void RemoveSingle<T>(this ICollection<T> collection, Func<T, bool> predicate)
     if (propertyDescriptor == null)
    {
         throw new Exception($"Property '{propertyName}' not found.");
        if (collection == null)
         {
            throw new ArgumentNullException(nameof(collection));
        }


         collection.Remove(collection.Single(predicate));
    return ascendingOrder ?
    }
        source.OrderBy(x => propertyDescriptor.GetValue(x)) :
         source.OrderByDescending(x => propertyDescriptor.GetValue(x));
}
}
</kode>
</filebox>

Dernière version du 24 mars 2024 à 15:15

Disponible à partir de C# 3, elles permettent d'ajouter des méthodes à une classe ou à une structure sans en modifier son code.

  • Les méthodes doivent être déclarées dans une classe static.
  • Les méthodes qui étendent une classe ou une structure ne peuvent accéder qu’aux membres publics.
Cs.svg 
// Déclaration de la méthode d'extension dans une classe static
public static class StringExtensions
{
    /// <summary>
    /// A Contains method with a comparison type.
    /// </summary>
    public static bool Contains(this string source, string value, StringComparison comparisonType)
    {
        return source.IndexOf(value, comparisonType) >= 0;
    }
}

// Utilisation de la méthode d'extension : comparaison de string en ignorant la casse
var monString = "ASTRINGTOTEST";
monString.Contains("string", StringComparison.OrdinalIgnoreCase);

Useful extension methods

CollectionExtension

CollectionExtension.cs 
/// <summary>
/// Adds each item to the list.
/// </summary>
/// <remarks>
/// The <see cref="IList{T}" /> interface does not have AddRange in its contract, contrary to the <see cref="List{T}" /> implementation.
/// The latter uses an optimized routine for adding a range of elements, and naming this extension method AddRange too would give the wrong impression of performance.
/// Additionally, for collections that notify of their changes, AddRange reads as if there would be only one notification of change after all elements have been added, when in fact there would probably by as many notifications as items being added.
/// </remarks>
public static void AddEach<T>(this ICollection<T> collection, IEnumerable<T> elements)
{
    ArgumentNullException.ThrowIfNull(collection);
    ArgumentNullException.ThrowIfNull(elements);

    if (collection is List<T> list)
    {
        list.AddRange(elements);
    }
    else
    {
        foreach (var element in elements)
        {
            collection.Add(element);
        }
    }
}

/// <summary>
/// Removes each item from the list.
/// </summary>
/// <remarks>
/// This method is not named RemoveRange, because it does not have the same purpose as <see cref="List{T}.RemoveRange" />.
/// </remarks>
public static void RemoveEach<T>(this ICollection<T> collection, IEnumerable<T> elements)
{
    ArgumentNullException.ThrowIfNull(collection);
    ArgumentNullException.ThrowIfNull(elements);

    foreach (var element in elements)
    {
        collection.Remove(element);
    }
}

public static void Remove<T>(this ICollection<T> collection, Func<T, bool> predicate)
{
    ArgumentNullException.ThrowIfNull(collection);

    collection.RemoveEach(collection.Where(predicate));
}

public static void RemoveSingle<T>(this ICollection<T> collection, Func<T, bool> predicate)
{
    ArgumentNullException.ThrowIfNull(collection);

    collection.Remove(collection.Single(predicate));
}

IEnumerableExtension

IEnumerableExtension.cs 
/// <summary>
/// Update all the items of the collection.
/// </summary>
public static IEnumerable<T> SetValue<T>(this IEnumerable<T> items, Action<T> updateMethod)
{
    foreach (T item in items)
    {
        updateMethod(item);
    }

    return items;
}

/// <summary>
/// Sorts the elements of a sequence according to an element's property.
/// </summary>
public static IEnumerable<T> OrderBy<T>(
    this IEnumerable<T> source,
    string propertyName,
    bool ascendingOrder)
{
    var propertyDescriptor = TypeDescriptor.GetProperties(typeof(T))
                                           .Find(propertyName, false);

    if (propertyDescriptor == null)
        throw new Exception($"Property '{propertyName}' not found.");

    return ascendingOrder ?
        source.OrderBy(x => propertyDescriptor.GetValue(x)) :
        source.OrderByDescending(x => propertyDescriptor.GetValue(x));
}
Récupérée de « http://wiki.bananeatomic.fr/index.php?title=Les_méthodes_d%27extension&oldid=30332 »