You are here

Fundamental Object-Oriented Design Methodology (FOODM)

26 July, 2019 - 09:51
Available under Creative Commons-ShareAlike 4.0 International License. Download for free at
  1. Identify and separate the variant and the invariant behaviors.
  2. Encapsulate the invariant behaviors into a system of classes.
  3. Add "hooks" to this class to define communication protocols with other classes.
  4. Encapsulate the variant behaviors into a union of classes that comply with the above protocols.

The result is a flexible system of co-operating objects that is not only reusable and extensible, but also easy to understand and maintain.

Let us illustrate the above process by applying it to the design of the immutable list structure and its algorithms.

  1. Here, the invariant is the intrinsic and primitive behavior of the list structure, IList, and the variants are the multitude of extrinsic and non-primitive algorithms that manipulate it, IListAlgo. The recursive list structure is implemented using the composite design pattern and encapsulated with a minimal and complete set of primitive structural operations: getFirst() and getRest(). The hook method Object execute (IListAlgo ago, Object inp) defines the protocols for operat¬ing on the list structure. The hook works as if a IList announces to the outside world the following protocol: If you want me to execute your algorithm, encapsulate it into an object of type IListAlgo, hand it to me together with its inp object as parameters for my execute(). I will send your algorithm object the appropriate message for it to perform its task, and return you the result.
    1. emptyCase(...) should be the part of the algorithm that deals with the case where I am empty.
    2. nonEmptyCase(...) should be the part of the algorithm that deals with the case where I am not empty."
  2. IListAlgo and all of its concrete implementations forms a union of algorithms classes that can be sent to the list structure for execution.

Below is the UML class diagram of the resulting list design.
Click here to see the full documentation.
Click here to see the code .

Figure 3.4 UML class diagram of the resulting list design

The above design is nothing but a special case of the Visitor Pattern. The interface IList is called the host and its method execute() is called a "hook" to the IListAlgovisitors. Via polymorphism, IList knows exactly what method to call on the specific IListAlgo visitor. This design turns the list structure into a (miniature) framework where control is inverted: one hands an algorithm to the structure to be executed instead of handing a structure to an algorithm to perform a computation. Since an IListAlgo only interacts with the list on which it operates via the list's public interface, the list structure is capable of carrying out any conforming algorithm, past, present, or future. This is how reusability and extensibility is achieved.