Search code examples
c#listpropertiesfind

How can I find a specific element in a List<T>?


My application uses a list like this:

List<MyClass> list = new List<MyClass>();

Using the Add method, another instance of MyClass is added to the list.

MyClass provides, among others, the following methods:

public void SetId(String Id);
public String GetId();

How can I find a specific instance of MyClass by means of using the GetId method? I know there is the Find method, but I don't know if this would work here?!


Solution

  • Use a lambda expression

    MyClass result = list.Find(x => x.GetId() == "xy");
    

    Note: C# has a built-in syntax for properties. Instead of writing getter and setter as ordinary methods (as you might be used to from Java), write

    private string _id;
    public string Id
    {
        get
        {
            return _id;
        }
        set
        {
            _id = value;
        }
    }
    

    value is an implicit parameter to the set accessor (but this may be about to change according to this LDM). It contains the value assigned to the property.

    Since this pattern is often used, C# provides auto-implemented properties. They are a short version of the code above; however, the backing variable is hidden and not accessible (it is accessible from within the class in VB, however).

    public string Id { get; set; }
    

    You can simply use properties as if you were accessing a field:

    var obj = new MyClass();
    obj.Id = "xy";       // Calls the setter with "xy" assigned to the value parameter.
    string id = obj.Id;  // Calls the getter.
    

    Using properties, you would search for items in the list like this

    MyClass result = list.Find(x => x.Id == "xy"); 
    

    You can also use auto-implemented properties if you need a read-only property:

    public string Id { get; private set; }
    

    This enables you to set the Id within the class but not from outside. If you need to set it in derived classes as well you can also protect the setter

    public string Id { get; protected set; }
    

    And finally, you can declare properties as virtual and override them in deriving classes, allowing you to provide different implementations for getters and setters; just as for ordinary virtual methods. In the deriving class you can override only the getter or only the setter. The other accessor is inherited without changes.


    Since C# 6.0 (Visual Studio 2015, Roslyn) you can write getter-only auto-properties with an inline initializer

    public string Id { get; } = "A07"; // Evaluated once when object is initialized.
    

    You can also initialize getter-only properties within the constructor instead. Getter-only auto-properties are true read-only properties, unlike auto-implemented properties with a private setter.

    This works also with read-write auto-properties:

    public string Id { get; set; } = "A07";
    

    Beginning with C# 6.0 you can also write properties as expression-bodied members

    public DateTime Yesterday => DateTime.Date.AddDays(-1); // Evaluated at each call.
    // Instead of
    public DateTime Yesterday { get { return DateTime.Date.AddDays(-1); } }
    

    See: .NET Compiler Platform ("Roslyn")
             The history of C# (version history)

    Starting with C# 7.0, both, getter and setter, can be written with expression bodies:

    public string Name
    {
        get => _name;                                // getter
        set => _name = value;                        // setter
    }
    

    Note that in this case the setter must be an expression. It cannot be a statement. The example above works, because in C# an assignment can be used as an expression or as a statement. The value of an assignment expression is the assigned value where the assignment itself is a side effect. This allows you to assign a value to more than one variable at once: x = y = z = 0 is equivalent to x = (y = (z = 0)) and has the same effect as the statements z = 0; y = 0; x = 0;.

    Since C# 9.0 you can use read-only (or better initialize-once) properties that you can initialize in an object initializer. This is currently not possible with getter-only properties.

    public string Name { get; init; }
    
    var c = new C { Name = "c-sharp" };
    

    Beginning with C# 11, you can have a required property to force client code to initialize it.

    The field keyword is planned for a future version of C# (it did not make it into C# 11 and C# 12) and allows the access to the automatically created backing field in a semi-auto-implemented property.

    // Removes time part in setter
    public DateTime HiredDate { get; init => field = value.Date(); }
    
    public Data LazyData => field ??= new Data();