Enumerable.DefaultIfEmpty 方法

  • 參考

定義

命名空間:
System.Linq
組件:
System.Linq.dll
組件:
System.Core.dll
組件:
netstandard.dll

傳回 IEnumerable<T> 的項目；如果序列是空的，則傳回預設值單一集合。

多載

DefaultIfEmpty<TSource>(IEnumerable<TSource>)

傳回指定之序列的項目；如果序列是空的，則傳回單一集合中型別參數的預設值。
DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource)

傳回指定之序列的項目；如果序列是空的，則傳回單一集合中型別參數的預設值。

DefaultIfEmpty<TSource>(IEnumerable<TSource>)

傳回指定之序列的項目；如果序列是空的，則傳回單一集合中型別參數的預設值。

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static System::Collections::Generic::IEnumerable<TSource> ^ DefaultIfEmpty(System::Collections::Generic::IEnumerable<TSource> ^ source);
public static System.Collections.Generic.IEnumerable<TSource> DefaultIfEmpty<TSource> (this System.Collections.Generic.IEnumerable<TSource> source);
public static System.Collections.Generic.IEnumerable<TSource?> DefaultIfEmpty<TSource> (this System.Collections.Generic.IEnumerable<TSource> source);
static member DefaultIfEmpty : seq<'Source> -> seq<'Source>
<Extension()>
Public Function DefaultIfEmpty(Of TSource) (source As IEnumerable(Of TSource)) As IEnumerable(Of TSource)

類型參數

TSource

source 項目的類型。

參數

source
IEnumerable<TSource>

序列，若此序列空白，便傳回預設值。

傳回

IEnumerable<TSource>

如果 TSource 為空白，則為包含 source 型別之預設值的 IEnumerable<T> 物件，否則為 source。

例外狀況

ArgumentNullException

source 為 null。

範例

下列程式碼範例示範如何使用 DefaultIfEmpty<TSource>(IEnumerable<TSource>) 來提供預設值，以防來源序列是空的。

此範例使用非空白序列。

class Pet
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public static void DefaultIfEmptyEx1()
{
    List<Pet> pets =
        new List<Pet>{ new Pet { Name="Barley", Age=8 },
                       new Pet { Name="Boots", Age=4 },
                       new Pet { Name="Whiskers", Age=1 } };

    foreach (Pet pet in pets.DefaultIfEmpty())
    {
        Console.WriteLine(pet.Name);
    }
}

/*
 This code produces the following output:

 Barley
 Boots
 Whiskers
*/

Structure Pet
    Public Name As String
    Public Age As Integer
End Structure

Sub DefaultIfEmptyEx1()
    ' Create a List of Pet objects.
    Dim pets As New List(Of Pet)(New Pet() _
                         {New Pet With {.Name = "Barley", .Age = 8},
                          New Pet With {.Name = "Boots", .Age = 4},
                          New Pet With {.Name = "Whiskers", .Age = 1}})

    Dim output As New System.Text.StringBuilder
    ' Iterate through the items in the List, calling DefaultIfEmpty().
    For Each pet As Pet In pets.DefaultIfEmpty()
        output.AppendLine(pet.Name)
    Next

    ' Display the output.
    Console.WriteLine(output.ToString())
End Sub

' This code produces the following output:
'
' Barley
' Boots
' Whiskers

此範例使用空序列。

List<int> numbers = new List<int>();

foreach (int number in numbers.DefaultIfEmpty())
{
    Console.WriteLine(number);
}

/*
 This code produces the following output:

 0
*/

' Create an empty List.
Dim numbers As New List(Of Integer)()

Dim output As New System.Text.StringBuilder
' Iterate through the items in the List, calling DefaultIfEmpty().
For Each number As Integer In numbers.DefaultIfEmpty()
    output.AppendLine(number)
Next

' Display the output.
Console.WriteLine(output.ToString())

' This code produces the following output:
'
' 0

備註

此方法是使用延後執行來實作。 立即傳回值是物件，可儲存執行動作所需的所有資訊。 除非直接在 GetEnumerator C# 或 Visual Basic 中使用 foreach 來列舉物件，否則 For Each 不會執行這個方法所表示的查詢。

參考和可為 Null 的型別預設值為 null 。

當此方法與 GroupJoin) 方法結合時，可用來產生左外部聯結。

另請參閱

適用於

DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource)

傳回指定之序列的項目；如果序列是空的，則傳回單一集合中型別參數的預設值。

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static System::Collections::Generic::IEnumerable<TSource> ^ DefaultIfEmpty(System::Collections::Generic::IEnumerable<TSource> ^ source, TSource defaultValue);
public static System.Collections.Generic.IEnumerable<TSource> DefaultIfEmpty<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, TSource defaultValue);
static member DefaultIfEmpty : seq<'Source> * 'Source -> seq<'Source>
<Extension()>
Public Function DefaultIfEmpty(Of TSource) (source As IEnumerable(Of TSource), defaultValue As TSource) As IEnumerable(Of TSource)

類型參數

TSource

source 項目的類型。

參數

source
IEnumerable<TSource>

序列，若此序列空白，便傳回指定的值。

defaultValue
TSource

在序列空白時所要傳回的值。

傳回

IEnumerable<TSource>

如果 defaultValue 是空的，則為包含 source 的 IEnumerable<T>，否則為 source。

範例

下列程式碼範例示範如何使用 DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) 方法並指定預設值。 第一個序列不是空的，而第二個序列是空的。

class Pet
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public static void DefaultIfEmptyEx2()
{
    Pet defaultPet = new Pet { Name = "Default Pet", Age = 0 };

    List<Pet> pets1 =
        new List<Pet>{ new Pet { Name="Barley", Age=8 },
                       new Pet { Name="Boots", Age=4 },
                       new Pet { Name="Whiskers", Age=1 } };

    foreach (Pet pet in pets1.DefaultIfEmpty(defaultPet))
    {
        Console.WriteLine("Name: {0}", pet.Name);
    }

    List<Pet> pets2 = new List<Pet>();

    foreach (Pet pet in pets2.DefaultIfEmpty(defaultPet))
    {
        Console.WriteLine("\nName: {0}", pet.Name);
    }
}

/*
 This code produces the following output:

 Name: Barley
 Name: Boots
 Name: Whiskers

 Name: Default Pet
*/

Structure Pet
    Public Name As String
    Public Age As Integer
End Structure

Sub DefaultIfEmptyEx2()
    ' Create a Pet object to use as the default value.
    Dim defaultPet As New Pet With {.Name = "Default Pet", .Age = 0}

    ' Create a List of Pet objects.
    Dim pets1 As New List(Of Pet)(New Pet() _
                          {New Pet With {.Name = "Barley", .Age = 8},
                           New Pet With {.Name = "Boots", .Age = 4},
                           New Pet With {.Name = "Whiskers", .Age = 1}})

    Dim output1 As New System.Text.StringBuilder
    ' Enumerate the items in the list, calling DefaultIfEmpty()
    ' with a default value.
    For Each pet As Pet In pets1.DefaultIfEmpty(defaultPet)
        output1.AppendLine("Name: " & pet.Name)
    Next

    ' Display the output.
    Console.WriteLine(output1.ToString())

    ' Create an empty List.
    Dim pets2 As New List(Of Pet)

    Dim output2 As New System.Text.StringBuilder
    ' Enumerate the items in the list, calling DefaultIfEmpty()
    ' with a default value.
    For Each pet As Pet In pets2.DefaultIfEmpty(defaultPet)
        output2.AppendLine("Name: " & pet.Name)
    Next

    ' Display the output.
    Console.WriteLine(output2.ToString())
End Sub

' This code produces the following output:
'
' Name: Barley
' Name: Boots
' Name: Whiskers
'
' Name: Default Pet

備註

此方法是使用延後執行來實作。 立即傳回值是物件，可儲存執行動作所需的所有資訊。 除非直接在 GetEnumerator C# 或 Visual Basic 中使用 foreach 來列舉物件，否則 For Each 不會執行這個方法所表示的查詢。

當此方法與 GroupJoin) 方法結合時，可用來產生左外部聯結。

另請參閱

適用於