CODEWITHSUNDEEP
c#extension-methods
Richard Ev
Richard Ev

Reputation: 54167

Instantiating an instance of a class using an extension method

The idea behind this code is that it uses an extension method to instantiate an instance of a class if that class is set to null. The code is simple enough, but does not work (it compiles and runs, but at the end the object reference is still null).

Can anyone suggest why?

The following code uses a simple class SomeClass that has a single string property.

class SomeClass
{
    public string SomeProperty { get; set; }
}


static class ExtensionMethods
{
    public static void InitialiseObjectIfNull<T>(this T obj)
        where T : class, new()
    {
        if (obj == null) obj = new T();
    }
}

class Program
{
    static void Main(string[] args)
    {
        SomeClass someClass = null;

        someClass.InitialiseObjectIfNull();

        // someClass is still null - but why??
    }
}

(The discussion about whether or not this is an appropriate use of an extension method should be considered outside the scope of the question! I am interested in understanding why this approach does not work)

Edit

On closer inspection this question is less about extension methods, and more about what is going on when you pass a reference type with or without the ref keyword.

The following function will cause a passed obj to be initialised for the caller:

static void InitialiseObjectIfNull<T>(ref T obj) where T : class, new()
{
    if (obj == null) obj = new T();
}

InitialiseObjectIfNull<SomeClass>(ref someClass); // someClass will be initialised

The following function will not cause a passed obj to be initlaised for the caller:

static void InitialiseObjectIfNull<T>(T obj) where T : class, new()
{
    if (obj == null) obj = new T();
}

InitialiseObjectIfNull<SomeClass>(someClass); // someClass will not be initialised

But...we're dealing with a reference type here, so what does the CLR do with the newd obj if the ref keyword is not used? Presumably it just gets garbage collected...

Edit2

OK, we're going back to basics here. Consider the code below:

class Program
{
    static void SetProperty(SomeClass someClass)
    {
        someClass.SomeProperty = "Bar";
    }

    static void Main(string[] args)
    {
        SomeClass someClass = new SomeClass { SomeProperty = "Foo" };

        SetProperty(someClass);

        // someClass.SomeProperty now equals "Bar"
    }
}

Note: someClass was not passed using the ref keyword, but the value of its property was still changed for the caller. This is what I would expect to see.

However, change the SetProperty function as follows:

static void SetProperty(SomeClass someClass)
{
    someClass = new SomeClass { SomeProperty = "Bar" };
}

...and the caller will not see any change to someClass.

Upvotes: 4

Views: 2123

Answers (4)

Thomas Levesque
Thomas Levesque

Reputation: 292765

This doesn't work because the obj parameter is not declared passed by reference. Unfortunately, you can't declare a parameter as "this ref T obj", it's not supported... I know, I tried that yesterday ;)

You could do something like that instead :

static class ExtensionMethods
{
    public static T InitialiseObjectIfNull<T>(this T obj)
        where T : class, new()
    {
        return obj ?? new ();
    }
}

class SomeClass
{
    public string SomeProperty { get; set; }
}

class Program
{
    static void Main(string[] args)
    {
        SomeClass someClass = null;

        someClass = someClass.InitialiseObjectIfNull();
    }
}

Upvotes: 2

Anton Gogolev
Anton Gogolev

Reputation: 115907

Extension method is just syntactic sugar to this:

ExtensionMethods.InitialiseObjectIfNull(someClass);

You're passing someClass by value, thus assigning to it inside InitialiseObjectIfNull body will have no effect unless you pass someClass by reference, which you can't do in case of extension methods: you cannot pass this in this T obj by reference.

Upvotes: 4

Michael Haren
Michael Haren

Reputation: 108376

this T obj would need to be a ref argument. Since that's not allowed (MSDN or C# In Depth p258, Skeet), you can't.

I would suggest you not push this idea too far, though. It seems like a confusing application of extension methods, especially when the alternative is still a short one line.

Upvotes: 5

Marc Gravell
Marc Gravell

Reputation: 1064324

You would need to return the value; extension methods aren't ref on the this argument:

static class ExtensionMethods
{
    public static T InitialiseObjectIfNull<T>(this T obj)
        where T : class, new()
    {
        return obj ?? new T();            
    }
}

Then you'd need:

someClass = someClass.InitialiseObjectIfNull();

Personally, I expect it would be simpler to do it directly... with either:

if(someClass == null) someClass = new SomeClass();

or

someClass = someClass ?? new SomeClass();

Upvotes: 6

Related Questions