Enumerable.SingleOrDefault メソッド

定義

名前空間:

System.Linq

アセンブリ:

System.Linq.dll

アセンブリ:

System.Core.dll

アセンブリ:

netstandard.dll

シーケンスの 1 つの特定の要素を返します。そのような要素が見つからない場合は既定値を返します。

オーバーロード

SingleOrDefault<TSource>(IEnumerable<TSource>, TSource)	シーケンスの唯一の要素を返します。シーケンスが空の場合は、指定した既定値を返します。シーケンス内に複数の要素がある場合、このメソッドは例外をスローします。
SingleOrDefault<TSource>(IEnumerable<TSource>)	シーケンスの唯一の要素を返します。シーケンスが空の場合、既定値を返します。シーケンス内に要素が複数ある場合、このメソッドは例外をスローします。
SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>)	指定された条件を満たすシーケンスの唯一の要素、またはそのような要素がない場合は既定値を返します。このメソッドは、複数の要素が条件を満たす場合に例外をスローします。
SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>, TSource)	指定した条件を満たすシーケンスの唯一の要素、またはそのような要素が存在しない場合は、指定した既定値を返します。このメソッドは、複数の要素が条件を満たす場合に例外をスローします。

SingleOrDefault<TSource>(IEnumerable<TSource>, TSource)

シーケンスの唯一の要素を返します。シーケンスが空の場合は、指定した既定値を返します。シーケンス内に複数の要素がある場合、このメソッドは例外をスローします。

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource SingleOrDefault(System::Collections::Generic::IEnumerable<TSource> ^ source, TSource defaultValue);

public static TSource SingleOrDefault<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, TSource defaultValue);

static member SingleOrDefault : seq<'Source> * 'Source -> 'Source

<Extension()>
Public Function SingleOrDefault(Of TSource) (source As IEnumerable(Of TSource), defaultValue As TSource) As TSource

型パラメーター

TSource

source の要素の型。

パラメーター

source

IEnumerable<TSource>

1 つの要素を返す IEnumerable<T>。

defaultValue

TSource

シーケンスが空の場合に返す既定値。

戻り値

TSource

入力シーケンスの 1 つの要素、または defaultValue シーケンスに要素が含まれている場合。

例外

ArgumentNullException

source が nullです。

InvalidOperationException

入力シーケンスに複数の要素が含まれています。

SingleOrDefault<TSource>(IEnumerable<TSource>)

シーケンスの唯一の要素を返します。シーケンスが空の場合、既定値を返します。シーケンス内に要素が複数ある場合、このメソッドは例外をスローします。

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource SingleOrDefault(System::Collections::Generic::IEnumerable<TSource> ^ source);

public static TSource SingleOrDefault<TSource> (this System.Collections.Generic.IEnumerable<TSource> source);

public static TSource? SingleOrDefault<TSource> (this System.Collections.Generic.IEnumerable<TSource> source);

static member SingleOrDefault : seq<'Source> -> 'Source

<Extension()>
Public Function SingleOrDefault(Of TSource) (source As IEnumerable(Of TSource)) As TSource

型パラメーター

TSource

source の要素の型。

パラメーター

source

IEnumerable<TSource>

1 つの要素を返す IEnumerable<T>。

戻り値

TSource

入力シーケンスの 1 つの要素。シーケンスに要素が含まれない場合は default (TSource)。

例外

ArgumentNullException

source が nullです。

InvalidOperationException

入力シーケンスに複数の要素が含まれています。

例

次のコード例は、配列の唯一の要素を選択するために使用 SingleOrDefault<TSource>(IEnumerable<TSource>) する方法を示しています。

string[] fruits1 = { "orange" };

string fruit1 = fruits1.SingleOrDefault();

Console.WriteLine(fruit1);

/*
 This code produces the following output:

 orange
*/

' Create an array that contains one item.
Dim fruits1() As String = {"orange"}

' Get the single item in the array or else a default value.
Dim result As String = fruits1.SingleOrDefault()

' Display the result.
Console.WriteLine($"First array: {result}")

次のコード例は、シーケンスが空の場合に既定値を返す方法 SingleOrDefault<TSource>(IEnumerable<TSource>) を示しています。

string[] fruits2 = { };

string fruit2 = fruits2.SingleOrDefault();

Console.WriteLine(
    String.IsNullOrEmpty(fruit2) ? "No such string!" : fruit2);

/*
 This code produces the following output:

 No such string!
*/

' Create an empty array.
Dim fruits2() As String = {}

result = String.Empty

' Get the single item in the array or else a default value.
result = fruits2.SingleOrDefault()

' Display the result.
Dim output As String =
IIf(String.IsNullOrEmpty(result), "No single item found", result)
Console.WriteLine($"Second array: {output}")

' This code produces the following output:
'
' First array: orange
' Second array: No single item found

場合によっては、コレクションに default(TSource) 要素が含まれていない場合に使用する既定値ではない場合があります。 不要な既定値の結果を確認し、必要に応じて変更する代わりに、このメソッドを DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) 使用して、コレクションが空の場合に使用する既定値を指定できます。 次に、要素を取得するために呼び出します Single<TSource>(IEnumerable<TSource>) 。 次のコード例では、両方の手法を使用して、ページ番号のコレクションが空の場合に既定値 1 を取得します。 整数の既定値は 0 で、通常は有効なページ番号ではないため、既定値は 1 として指定する必要があります。 クエリの実行が完了した後、最初の結果変数で不要な既定値がチェックされます。 2 番目の結果変数は、既定値 1 を指定するために使用 DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) して取得されます。

int[] pageNumbers = { };

// Setting the default value to 1 after the query.
int pageNumber1 = pageNumbers.SingleOrDefault();
if (pageNumber1 == 0)
{
    pageNumber1 = 1;
}
Console.WriteLine("The value of the pageNumber1 variable is {0}", pageNumber1);

// Setting the default value to 1 by using DefaultIfEmpty() in the query.
int pageNumber2 = pageNumbers.DefaultIfEmpty(1).Single();
Console.WriteLine("The value of the pageNumber2 variable is {0}", pageNumber2);

/*
 This code produces the following output:

 The value of the pageNumber1 variable is 1
 The value of the pageNumber2 variable is 1
*/

Dim pageNumbers() As Integer = {}

' Setting the default value to 1 after the query.
Dim pageNumber1 As Integer = pageNumbers.SingleOrDefault()
If pageNumber1 = 0 Then
    pageNumber1 = 1
End If
Console.WriteLine($"The value of the pageNumber1 variable is {pageNumber1}")

' Setting the default value to 1 by using DefaultIfEmpty() in the query.
Dim pageNumber2 As Integer = pageNumbers.DefaultIfEmpty(1).Single()
Console.WriteLine($"The value of the pageNumber2 variable is {pageNumber2}")

' This code produces the following output:

' The value of the pageNumber1 variable is 1
' The value of the pageNumber2 variable is 1

注釈

参照型と null 許容型の既定値は .null

このメソッドは SingleOrDefault 、既定値を指定する方法を提供しません。 以外 default(TSource)の既定値を指定する場合は、「例」セクションの DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) 説明に従ってメソッドを使用します。

SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>)

指定された条件を満たすシーケンスの唯一の要素、またはそのような要素がない場合は既定値を返します。このメソッドは、複数の要素が条件を満たす場合に例外をスローします。

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource SingleOrDefault(System::Collections::Generic::IEnumerable<TSource> ^ source, Func<TSource, bool> ^ predicate);

public static TSource SingleOrDefault<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,bool> predicate);

public static TSource? SingleOrDefault<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,bool> predicate);

static member SingleOrDefault : seq<'Source> * Func<'Source, bool> -> 'Source

<Extension()>
Public Function SingleOrDefault(Of TSource) (source As IEnumerable(Of TSource), predicate As Func(Of TSource, Boolean)) As TSource

型パラメーター

TSource

source の要素の型。

パラメーター

source

IEnumerable<TSource>

1 つの要素を返す IEnumerable<T>。

predicate

Func<TSource,Boolean>

要素が条件を満たしているかどうかをテストする関数。

戻り値

TSource

条件を満たす、入力シーケンスの 1 つの要素。そのような要素が見つからない場合は default (TSource)。

例外

ArgumentNullException

source または predicate が null です。

InvalidOperationException

predicate の条件を満たす要素が複数あります。

例

次のコード例は、条件を満たす配列の唯一の要素を選択するために使用 SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) する方法を示しています。

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

string fruit1 = fruits.SingleOrDefault(fruit => fruit.Length > 10);

Console.WriteLine(fruit1);

/*
 This code produces the following output:

 passionfruit
*/

' Create an array of strings.
Dim fruits() As String =
{"apple", "banana", "mango", "orange", "passionfruit", "grape"}

' Get the single item in the array whose length is > 10.
Dim fruit1 As String =
fruits.SingleOrDefault(Function(fruit) fruit.Length > 10)

' Display the result.
Console.WriteLine($"First array: {fruit1}")

次のコード例は、シーケンスに SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) 条件を満たす要素が含まれている場合に既定値を返す方法を示しています。

string fruit2 =
    fruits.SingleOrDefault(fruit => fruit.Length > 15);

Console.WriteLine(
    String.IsNullOrEmpty(fruit2) ? "No such string!" : fruit2);

/*
 This code produces the following output:

 No such string!
*/

' Get the single item in the array whose length is > 15.
Dim fruit2 As String =
fruits.SingleOrDefault(Function(fruit) fruit.Length > 15)

' Display the result.
Dim output As String =
IIf(String.IsNullOrEmpty(fruit2), "No single item found", fruit2)
Console.WriteLine($"Second array: {output}")

' This code produces the following output:
'
' First array: passionfruit
' Second array: No single item found

注釈

参照型と null 許容型の既定値は .null

SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>, TSource)

指定した条件を満たすシーケンスの唯一の要素、またはそのような要素が存在しない場合は、指定した既定値を返します。このメソッドは、複数の要素が条件を満たす場合に例外をスローします。

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource SingleOrDefault(System::Collections::Generic::IEnumerable<TSource> ^ source, Func<TSource, bool> ^ predicate, TSource defaultValue);

public static TSource SingleOrDefault<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,bool> predicate, TSource defaultValue);

static member SingleOrDefault : seq<'Source> * Func<'Source, bool> * 'Source -> 'Source

<Extension()>
Public Function SingleOrDefault(Of TSource) (source As IEnumerable(Of TSource), predicate As Func(Of TSource, Boolean), defaultValue As TSource) As TSource

型パラメーター

TSource

source の要素の型。

パラメーター

source

IEnumerable<TSource>

1 つの要素を返す IEnumerable<T>。

predicate

Func<TSource,Boolean>

要素が条件を満たしているかどうかをテストする関数。

defaultValue

TSource

シーケンスが空の場合に返す既定値。

戻り値

TSource

条件を満たす入力シーケンスの 1 つの要素、または defaultValue そのような要素が見つからない場合。

例外

ArgumentNullException

source または predicate が null です。

InvalidOperationException

predicate の条件を満たす要素が複数あります。