Is it better to return null or empty collection?

by

Empty collection. Always.

This sucks:

if(myInstance.CollectionProperty != null)
{
  foreach(var item in myInstance.CollectionProperty)
    /* arrgh */
}

It is considered a best practice to NEVER return null when returning a collection or enumerable. ALWAYS return an empty enumerable/collection. It prevents the aforementioned nonsense, and prevents your car getting egged by co-workers and users of your classes.

When talking about properties, always set your property once and forget it

public List<Foo> Foos {public get; private set;}

public Bar() { Foos = new List<Foo>(); }

In .NET 4.6.1, you can condense this quite a lot:

public List<Foo> Foos { get; } = new List<Foo>();

When talking about methods that return enumerables, you can easily return an empty enumerable instead of null…

public IEnumerable<Foo> GetMyFoos()
{
  return InnerGetFoos() ?? Enumerable.Empty<Foo>();
}

Using Enumerable.Empty<T>() can be seen as more efficient than returning, for example, a new empty collection or array.

More Related Contents:

  1. Find items in a string collection which contain another string [closed]
  2. Creating a blocking Queue in .NET?
  3. How to create List of open generic type of class?
  4. Select N random elements from a List in C#
  5. How do I overload the square-bracket operator in C#?
  6. ObservableCollection that also monitors changes on the elements in collection
  7. Filtering collections in C#
  8. .NET HashTable Vs Dictionary – Can the Dictionary be as fast?
  9. C# Set collection?
  10. Collection versus List what should you use on your interfaces?
  11. Dictionary returning a default value if the key does not exist [duplicate]
  12. ReadOnlyCollection or IEnumerable for exposing member collections?
  13. Is there anything like asynchronous BlockingCollection?
  14. What .NET collection provides the fastest search
  15. Does List guarantee insertion order?
  16. How do I override List’s Add method in C#?
  17. Why does WCF return myObject[] instead of List like I was expecting?
  18. .NET – Convert Generic Collection to DataTable
  19. Why doesn’t Dictionary support null key? [duplicate]
  20. Accessing a property of derived class from the base class in C#
  21. Why do C# collection initializers work this way?
  22. Using BindingOperations.EnableCollectionSynchronization
  23. Does the Enumerator of a Dictionary return key value pairs in the order they were added?
  24. How to Quickly Remove Items From a List
  25. C# List – Removing items while looping / iterating [duplicate]
  26. Is it possible to create some IGrouping object
  27. What’s Wrong with an ArrayList?
  28. What benefits does dictionary initializers add over collection initializers?
  29. How to get random values from array in C# [duplicate]
  30. System.Text.Json: How to apply a JsonConverter for a collection with a custom converter for the collection’s items?

Leave a Comment