Enumerable.FirstOrDefault Метод

Определение

Пространство имен:

System.Linq

Сборка:

System.Linq.dll

Возвращает первый элемент последовательности или значение по умолчанию, если ни одного элемента не найдено.

Перегрузки

FirstOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>, TSource)	Возвращает первый элемент последовательности, удовлетворяющий условию, или указанное значение по умолчанию, если такой элемент не найден.
FirstOrDefault<TSource>(IEnumerable<TSource>, TSource)	Возвращает первый элемент последовательности или указанное значение по умолчанию, если последовательность не содержит элементов.
FirstOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>)	Возвращает первый элемент последовательности, удовлетворяющий указанному условию, или значение по умолчанию, если ни одного такого элемента не найдено.
FirstOrDefault<TSource>(IEnumerable<TSource>)	Возвращает первый элемент последовательности или значение по умолчанию, если последовательность не содержит элементов.

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

Исходный код:

First.cs

Возвращает первый элемент последовательности, удовлетворяющий условию, или указанное значение по умолчанию, если такой элемент не найден.

C#

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

Параметры типа

TSource

Тип элементов source.

Параметры

source

IEnumerable<TSource>

Объект IEnumerable<T>, из которого требуется возвратить элемент.

predicate

Func<TSource,Boolean>

Функция для проверки каждого элемента на соответствие условию.

defaultValue

TSource

Значение по умолчанию, возвращаемое, если последовательность пуста.

Возвращаемое значение

TSource

defaultValue Значение , если source является пустым или ни один элемент не проходит тест, заданный параметром predicate; в противном случае — первый элемент в source , который проходит тест, заданный параметром predicate.

Исключения

ArgumentNullException

Параметр source или predicate имеет значение null.

FirstOrDefault<TSource>(IEnumerable<TSource>, TSource)

Исходный код:

First.cs

Возвращает первый элемент последовательности или указанное значение по умолчанию, если последовательность не содержит элементов.

C#

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

Параметры типа

TSource

Тип элементов source.

Параметры

source

IEnumerable<TSource>

Объект IEnumerable<T>, первый элемент которого требуется возвратить.

defaultValue

TSource

Значение по умолчанию, возвращаемое, если последовательность пуста.

Возвращаемое значение

TSource

defaultValue Значение , если source параметр пуст; в противном случае — первый элемент в source.

Исключения

ArgumentNullException

source имеет значение null.

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

Исходный код:

First.cs

Возвращает первый элемент последовательности, удовлетворяющий указанному условию, или значение по умолчанию, если ни одного такого элемента не найдено.

C#

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

Параметры типа

TSource

Тип элементов source.

Параметры

source

IEnumerable<TSource>

Объект IEnumerable<T>, из которого требуется возвратить элемент.

predicate

Func<TSource,Boolean>

Функция для проверки каждого элемента на соответствие условию.

Возвращаемое значение

TSource

default(TSource), если последовательность source пуста или если ни один ее элемент не прошел проверку, определенную предикатом predicate; в противном случае — первый элемент последовательности source, прошедший проверку, определенную предикатом predicate.

Исключения

ArgumentNullException

Параметр source или predicate имеет значение null.

Примеры

В следующем примере кода показано, как использовать FirstOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) путем передачи предиката. Во втором вызове метода в массиве нет элемента, удовлетворяющего условию.

C#

string[] names = { "Hartono, Tommy", "Adams, Terry",
                     "Andersen, Henriette Thaulow",
                     "Hedlund, Magnus", "Ito, Shu" };

string firstLongName = names.FirstOrDefault(name => name.Length > 20);

Console.WriteLine("The first long name is '{0}'.", firstLongName);

string firstVeryLongName = names.FirstOrDefault(name => name.Length > 30);

Console.WriteLine(
    "There is {0} name longer than 30 characters.",
    string.IsNullOrEmpty(firstVeryLongName) ? "not a" : "a");

/*
 This code produces the following output:

 The first long name is 'Andersen, Henriette Thaulow'.
 There is not a name longer than 30 characters.
*/

Комментарии

Значением по умолчанию для ссылочных типов и типов, допускающих значение NULL, является null.

FirstOrDefault<TSource>(IEnumerable<TSource>)

Исходный код:

First.cs

Возвращает первый элемент последовательности или значение по умолчанию, если последовательность не содержит элементов.

C#

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

Параметры типа

TSource

Тип элементов source.

Параметры

source

IEnumerable<TSource>

Объект IEnumerable<T>, первый элемент которого требуется возвратить.

Возвращаемое значение

TSource

default(TSource), если последовательность source пуста, в противном случае — первый элемент последовательности source.

Исключения

ArgumentNullException

source имеет значение null.

Примеры

В следующем примере кода показано, как использовать FirstOrDefault<TSource>(IEnumerable<TSource>) пустой массив.

C#

int[] numbers = { };
int first = numbers.FirstOrDefault();
Console.WriteLine(first);

/*
 This code produces the following output:

 0
*/

Иногда значение default(TSource) не является значением по умолчанию, которое требуется использовать, если коллекция не содержит элементов. Вместо проверки результата на наличие нежелательного значения по умолчанию и последующего изменения его при необходимости можно использовать DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) метод , чтобы указать значение по умолчанию, которое будет использоваться, если коллекция пуста. Затем вызовите First<TSource>(IEnumerable<TSource>) , чтобы получить первый элемент. В следующем примере кода используются оба метода для получения значения по умолчанию 1, если коллекция числовых месяцев пуста. Так как значение по умолчанию для целого числа равно 0, которое не соответствует ни одному месяцу, вместо этого значение по умолчанию должно быть указано как 1. Первая переменная результата проверяется на наличие нежелательного значения по умолчанию после завершения выполнения запроса. Вторая результовая переменная получается с помощью DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) для указания значения по умолчанию 1.

C#

List<int> months = new List<int> { };

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

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

/*
 This code produces the following output:

 The value of the firstMonth1 variable is 1
 The value of the firstMonth2 variable is 1
*/

Комментарии

Значением по умолчанию для ссылочных типов и типов, допускающих значение NULL, является null.

Метод FirstOrDefault не позволяет указать значение по умолчанию. Если вы хотите указать значение по умолчанию, отличное от default(TSource), используйте DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) метод , как описано в разделе Пример.