Null object pattern

In object-oriented computer programming, a null object is an object with no referenced value or with defined neutral (null) behavior. The null object design pattern, which describes the uses of such objects and their behavior (or lack thereof), was first published as "Void Value" and later in the Pattern Languages of Program Design book series as "Null Object".

Motivation
In most object-oriented languages, such as Java or C#, references may be null. These references need to be checked to ensure they are not null before invoking any methods, because methods typically cannot be invoked on null references.

The Objective-C language takes another approach to this problem and does nothing when sending a message to ; if a return value is expected,   (for objects), 0 (for numeric values),   (for   values), or a struct (for struct types) with all its members initialised to  /0/ /zero-initialised struct is returned.

Description
Instead of using a null reference to convey the absence of an object (for instance, a non-existent customer), one uses an object which implements the expected interface, but whose method body is empty. A key purpose of using a null object is to avoid conditionals of different kinds, resulting in code that is more focused, and quicker to read and follow – i.e. improved readability. One advantage of this approach over a working default implementation is that a null object is very predictable and has no side effects: it does nothing.

For example, a function may retrieve a list of files in a folder and perform some action on each. In the case of an empty folder, one response may be to throw an exception or return a null reference rather than a list. Thus, the code expecting a list must verify that it in fact has one before continuing, which can complicate the design.

By returning a null object (i.e., an empty list) instead, there is no need to verify that the return value is in fact a list. The calling function may simply iterate the list as normal, effectively doing nothing. It is, however, still possible to check whether the return value is a null object (an empty list) and react differently if desired.

The null object pattern can also be used to act as a stub for testing, if a certain feature such as a database is not available for testing.

Example
Given a binary tree, with this node structure:

class node { node left node right }

One may implement a tree size procedure recursively:

function tree_size(node) { return 1 + tree_size(node.left) + tree_size(node.right) }

Since the child nodes may not exist, one must modify the procedure by adding non-existence or null checks:

function tree_size(node) { set sum = 1 if node.left exists { sum = sum + tree_size(node.left) }    if node.right exists { sum = sum + tree_size(node.right) }    return sum }

This, however, makes the procedure more complicated by mixing boundary checks with normal logic, and it becomes harder to read. Using the null object pattern, one can create a special version of the procedure but only for null nodes:

function tree_size(node) { return 1 + tree_size(node.left) + tree_size(node.right) }

function tree_size(null_node) { return 0 }

This separates normal logic from special case handling and makes the code easier to understand.

Relation to other patterns
It can be regarded as a special case of the State pattern and the Strategy pattern.

It is not a pattern from Design Patterns, but is mentioned in Martin Fowler's Refactoring and Joshua Kerievsky's Refactoring To Patterns as the Insert Null Object refactoring.

Chapter 17 of Robert Cecil Martin's Agile Software Development: Principles, Patterns and Practices is dedicated to the pattern.

Alternatives
From C# 6.0 it is possible to use the "?." operator (aka null-conditional operator), which will simply evaluate to null if its left operand is null.

Extension methods and Null coalescing
In some Microsoft .NET languages, Extension methods can be used to perform what is called 'null coalescing'. This is because extension methods can be called on null values as if it concerns an 'instance method invocation' while in fact extension methods are static. Extension methods can be made to check for null values, thereby freeing code that uses them from ever having to do so. Note that the example below uses the C# Null coalescing operator to guarantee error free invocation, where it could also have used a more mundane if...then...else. The following example only works when you do not care the existence of null, or you treat null and empty string the same. The assumption may not hold in other applications.

C++
A language with statically typed references to objects illustrates how the null object becomes a more complicated pattern:

Here, the idea is that there are situations where a pointer or reference to an  object is required, but there is no appropriate object available. A null reference is impossible in standard-conforming C++. A null  pointer is possible, and could be useful as a place-holder, but may not be used for direct dispatch:   is undefined behavior if   is a null pointer.

The null object pattern solves this problem by providing a special  class which can be instantiated bound to an   pointer or reference.

The special null class must be created for each class hierarchy that is to have a null object, since a  is of no use when what is needed is a null object with regard to some   base class that is not related to the   hierarchy.

Note that NOT having a null class at all is an important feature, in contrast to languages where "anything is a reference" (e.g., Java and C#). In C++, the design of a function or method may explicitly state whether null is allowed or not.

C#
C# is a language in which the null object pattern can be properly implemented. This example shows animal objects that display sounds and a NullAnimal instance used in place of the C# null keyword. The null object provides consistent behaviour and prevents a runtime null reference exception that would occur if the C# null keyword were used instead.

Smalltalk
Following the Smalltalk principle, everything is an object, the absence of an object is itself modeled by an object, called. In the GNU Smalltalk for example, the class of   is , a direct descendant of.

Any operation that fails to return a sensible object for its purpose may return  instead, thus avoiding the special case of returning "no object" unsupported by Smalltalk designers. This method has the advantage of simplicity (no need for a special case) over the classical "null" or "no object" or "null reference" approach. Especially useful messages to be used with  are ,   or  ,, which make it practical and safe to deal with possible references to   in Smalltalk programs.

Common Lisp
In Lisp, functions can gracefully accept the special object, which reduces the amount of special case testing in application code. For instance, although  is an atom and does not have any fields, the functions   and   accept   and just return it, which is very useful and results in shorter code.

Since  is the empty list in Lisp, the situation described in the introduction above doesn't exist. Code which returns  is returning what is in fact the empty list (and not anything resembling a  null reference to a list type), so the caller does not need to test the value to see whether or not it has a list.

The null object pattern is also supported in multiple value processing. If the program attempts to extract a value from an expression which returns no values, the behavior is that the null object  is substituted. Thus  returns   (a one-element list containing nil). The  expression returns no values at all, but since the function call to   needs to reduce its argument expression to a value, the null object is automatically substituted.

CLOS
In Common Lisp, the object  is the one and only instance of the special class. What this means is that a method can be specialized to the  class, thereby implementing the null design pattern. Which is to say, it is essentially built into the object system: The class  is a subclass of the   class, because   is a symbol. Since  also represents the empty list,   is a subclass of the   class, too. Methods parameters specialized to  or   will thus take a   argument. Of course, a  specialization can still be defined which is a more specific match for.

Scheme
Unlike Common Lisp, and many dialects of Lisp, the Scheme dialect does not have a nil value which works this way; the functions  and   may not be applied to an empty list; Scheme application code therefore has to use the   or   predicate functions to sidestep this situation, even in situations where very similar Lisp would not need to distinguish the empty and non-empty cases thanks to the behavior of.

Ruby
In duck-typed languages like Ruby, language inheritance is not necessary to provide expected behavior. Attempts to directly monkey-patch NilClass instead of providing explicit implementations give more unexpected side effects than benefits.

JavaScript
In duck-typed languages like JavaScript, language inheritance is not necessary to provide expected behavior.

Java
This code illustrates a variation of the C++ example, above, using the Java language. As with C++, a null class can be instantiated in situations where a reference to an  object is required, but there is no appropriate object available. A null  object is possible  and could be useful as a place-holder, but may not be used for calling a method. In this example,  will throw a NullPointerException. Therefore, additional code may be necessary to test for null objects.

The null object pattern solves this problem by providing a special  class which can be instantiated as an object of type. As with C++ and related languages, that special null class must be created for each class hierarchy that needs a null object, since a  is of no use when what is needed is a null object that does not implement the   interface.

Visual Basic .NET
The following null object pattern implementation demonstrates the concrete class providing its corresponding null object in a static field. This approach is frequently used in the .NET Framework (, ,  , etc.).

Criticism
This pattern should be used carefully, as it can make errors/bugs appear as normal program execution.

Care should be taken not to implement this pattern just to avoid null checks and make code more readable, since the harder-to-read code may just move to another place and be less standard—such as when different logic must execute in case the object provided is indeed the null object. The common pattern in most languages with reference types is to compare a reference to a single value referred to as null or nil. Also, there is additional need for testing that no code anywhere ever assigns null instead of the null object, because in most cases and languages with static typing, this is not a compiler error if the null object is of a reference type, although it would certainly lead to errors at run time in parts of the code where the pattern was used to avoid null checks. On top of that, in most languages and assuming there can be many null objects (i.e., the null object is a reference type but doesn't implement the singleton pattern in one or another way), checking for the null object instead of for the null or nil value introduces overhead, as does the singleton pattern likely itself upon obtaining the singleton reference.