Question

I’ve got a class with some functions which realistically are just ‘helper’ methods that client code could do itself with other public accessor properties/methods, and I’m undecided as to whether I should define these as properties with a getter, instance methods, or static methods that take the instance as a parameter. In addition, I’ve also got an interface extracted from the class that is used pretty much everywhere except on construction, to allow my code to use any class implemented against the interface.

The question is, which is best from a design point of view? For example, as a means of getting the initial from this class:

class Person : IPerson {
  private string name;

  public string Name { get { return this.name; } }

  // Property with getter
  public string Initial { get { return this.name.Substring(0,1); } }

  // Instance method
  public string GetInitial { return this.name.Substring(0,1); }

  // Static method
  public static string GetInitial(IPerson person) {
    return person.Name.Substring(0,1);
  }
}

The property lends itself to shorter, more readable client code, but would require anyone implementing against IPerson to write their own implementation, as would the instance method.

The static method would mean implementing classes wouldn’t need to write their own, and my code can guarantee how the initial is determined based on the name, but it means it can’t be on the interface, and client code’s a little more verbose.

Does it just come down to whether not it’s a good idea to allow implementing classes to specify how helper methods are calculated?

EDIT: Minor aside, why won’t SO let me add the best-practices tag?

Answer 1

How about an extension method?

namespace IPersonExtensions
{
    public static class IPersonExtensionClass
    {
        public static string Initial(this IPerson @this)
        {
            return @this.name.Substring(0, 1);
        }
    }
}

Use it like this:

string initial = person.Initial();

This way, you can share implementation without having to inherit or rewrite code. Using the separate namespace makes it possible for users to choose whether they want to use this code or not.