LINQ | Element Operator | SingleOrDefault
The element operators are used to return a single, or a specific element from the sequence or collection. For example, in a school when we ask, who is the principal? Then there will be only one person that will be the principal of the school. So the number of students is a collection and the principal is the only result that comes from the collection.
The LINQ Standard Query Operator supports 8 types of element operators:
- ElementAt
- ElementAtOrDefault
- First
- FirstOrDefault
- Last
- LastOrDefault
- Single
- SingleOrDefault
SingleOrDefault Operator
The SingleOrDefault operator is used to return the single element of the collection or sequence. Basically, it returns the single element which specifies the given condition. Or return the default value if the given collection or sequence does not contain any value. This method can be overloaded in two different ways:
- SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource, Boolean>): This method returns the only element of the collection or sequence which specifies the given condition and will throw an exception if more than one element exists that specifies the given condition.
- SingleOrDefault<TSource>(IEnumerable<TSource>): This method returns the only element of a the given sequence or collection, and throws an exception if there is more than one element present in the sequence or collection.
Important Points:
- It does not support query syntax in C# and VB.Net languages.
- It support method syntax in both C# and VB.Net languages.
- It present in both the Queryable and Enumerable class.
- It throws an InvalidOperationException if it contains more than one element that specifies the given condition or more than one element present in the given sequence or collection.
- The default value of the reference types and the nullable types is null.
Example 1:
// C# program to illustrate the use // of SingleOrDefault operator using System; using System.Linq; using System.Collections.Generic; class GFG { // Main Method static public void Main() { // Data source int [] sequence1 = {112, 44, 55, 66, 77, 777, 56}; int [] sequence2 = {2 }; int [] sequence3 = {}; // Get the element which specifies // the given condition Using the // SingleOrDefault(Condition) var result1 = sequence1.SingleOrDefault(seq => seq == 777); Console.WriteLine( "Element: {0}" , result1); // Get the only element of the sequence // Using SingleOrDefault() var result2 = sequence2.SingleOrDefault(); Console.WriteLine( "Element: {0}" , result2); // Get the default value // Using SingleOrDefault() var result3 = sequence3.SingleOrDefault(); Console.WriteLine( "Element: {0}" , result3); } } |
Element: 777 Element: 2 Element: 0
Example 2:
// C# program to find the name the employee // whose salary is equal to 50000 using System; using System.Linq; using System.Collections.Generic; // Employee details public class Employee { public int emp_id { get ; set ; } public string emp_name { get ; set ; } public string emp_gender { get ; set ; } public string emp_hire_date { get ; set ; } public int emp_salary { get ; set ; } } class GFG { // Main method static public void Main() { List<Employee> emp = new List<Employee>() { new Employee() {emp_id = 209, emp_name = "Anjita" , emp_gender = "Female" , emp_hire_date = "12/3/2017" , emp_salary = 20000}, new Employee() {emp_id = 210, emp_name = "Soniya" , emp_gender = "Female" , emp_hire_date = "22/4/2018" , emp_salary = 30000}, new Employee() {emp_id = 211, emp_name = "Rohit" , emp_gender = "Male" , emp_hire_date = "3/5/2016" , emp_salary = 40000}, new Employee() {emp_id = 212, emp_name = "Supriya" , emp_gender = "Female" , emp_hire_date = "4/8/2017" , emp_salary = 40000}, new Employee() {emp_id = 213, emp_name = "Anil" , emp_gender = "Male" , emp_hire_date = "12/1/2016" , emp_salary = 40000}, new Employee() {emp_id = 214, emp_name = "Anupriya" , emp_gender = "Female" , emp_hire_date = "17/6/2015" , emp_salary = 50000}, }; // Query to find the name the employee // whose salary is equal to 50000 // Using SingleOrDefault method var res = emp.SingleOrDefault(e => e.emp_salary == 50000); string val = res.emp_name; Console.WriteLine( "Employee name: {0}" , val); } } |
Employee name: Anupriya