Decorator pattern

From Wikipedia, the free encyclopedia

For decorators in Python, see Python syntax and semantics#Decorators.

In object-oriented programming, the decorator pattern is a design pattern that allows new/additional behaviour to be added to an existing class dynamically.

UML Class diagram of the decorator pattern
UML Class diagram of the decorator pattern
LePUS3 chart of the decorator pattern
LePUS3 chart of the decorator pattern

Contents

[edit] Introduction

The decorator pattern can be used to make it possible to extend (decorate) the functionality of a class at runtime. This works by adding a new decorator class that wraps the original class. This wrapping is typically achieved by passing the original object as a parameter to the constructor of the decorator when it is created. The decorator implements the new functionality, but for functionality that is not new, the original (wrapped) class is used. The decorating class must have the same interface as the original class.

The decorator pattern is an alternative to subclassing. Subclassing adds behaviour at compile time whereas decorating can provide new behaviour at runtime.

This difference becomes most important when there are several independent ways of extending functionality. In some object-oriented programming languages, classes cannot be created at runtime, and it is typically not possible to predict what combinations of extensions will be needed at design time. This would mean that a new class would have to be made for every possible combination. By contrast, decorators are objects, created at runtime, and can be combined on a per-use basis. An example of the decorator pattern is the Java I/O Streams implementation.

[edit] Motivation

As an example, consider a window in a windowing system. To allow scrolling of the window's contents, we may wish to add horizontal or vertical scrollbars to it, as appropriate. Assume windows are represented by instances of the Window class, and assume this class has no functionality for adding scrollbars. We could create a subclass ScrollingWindow that provides them, or we could create a ScrollingWindowDecorator that merely adds this functionality to existing Window objects. At this point, either solution would be fine.

Now let's assume we also wish the option to add borders to our windows. Again, our original Window class has no support. The ScrollingWindow subclass now poses a problem, because it has effectively created a new kind of window. If we wish to add border support to all windows, we must create subclasses WindowWithBorder and ScrollingWindowWithBorder. Obviously, this problem gets worse with every new feature to be added. For the decorator solution, we need merely create a new BorderedWindowDecorator—at runtime, we can decorate existing windows with the ScrollingWindowDecorator or the BorderedWindowDecorator or both, as we see fit.

Another good example of where a decorator can be desired is when there is a need to restrict access to an object's properties or methods according to some set of rules or perhaps several parallel sets of rules (different user credentials, etc). In this case instead of implementing the access control in the original object it is left unchanged and unaware of any restrictions on its use, and it is wrapped in an access control decorator object, which can then serve only the permitted subset of the original object's interface.

[edit] Applicability

Consider viewing a webpage with a web browser. The webpage itself displays the information needed, but the web browser knows nothing about the content. It is likely that the webpage doesn't fit in the entire browser area and a scrollbar is required to show the information. The web browser doesn't need to assume that all webpages will require a scrollbar and it certainly should never assume a scrollbar is never needed. Browsers will typically display the scrollbar only if it is necessary and hide it if it is unnecessary. In this case, the scrollbar is the "decoration" to the webpage. It takes care of whether it should be displayed dynamically as opposed to statically forcing the webpage display to be a subclass of the scrollbar display. Thus, it is up to the scrollbar to decide whether it should display itself (instead of trying to force that responsibility on the webpage or on the external parts of the web browser).

[edit] Example

UML Diagram for the Window Example
UML Diagram for the Window Example

This Java example uses the window/scrolling scenario.

// the Window interface
interface Window {
    public void draw(); // draws the Window
    public String getDescription(); // returns a description of the Window
}
 
 
// implementation of a simple Window without any scrollbars
class SimpleWindow implements Window {
    public void draw() {
        // draw window
    }
 
    public String getDescription() {
        return "simple window";
    }
}

The following classes contain the decorators for all Window classes, including the decorator classes themselves..

// abstract decorator class - note that it implements Window
abstract class WindowDecorator implements Window {
    protected Window decoratedWindow; // the Window being decorated
 
    public WindowDecorator (Window decoratedWindow) {
        this.decoratedWindow = decoratedWindow;
    }
}
 
 
// the first concrete decorator which adds vertical scrollbar functionality
class VerticalScrollBarDecorator extends WindowDecorator {
    public VerticalScrollBarDecorator (Window decoratedWindow) {
        super(decoratedWindow);
    }
 
    public void draw() {
        drawVerticalScrollBar();
        decoratedWindow.draw();
    }
 
    private void drawVerticalScrollBar() {
        // draw the vertical scrollbar
    }
 
    public String getDescription() {
        return decoratedWindow.getDescription() + ", including vertical scrollbars";
    }
}
 
 
// the second concrete decorator which adds horizontal scrollbar functionality
class HorizontalScrollBarDecorator extends WindowDecorator {
    public HorizontalScrollBarDecorator (Window decoratedWindow) {
        super(decoratedWindow);
    }
 
    public void draw() {
        drawHorizontalScrollBar();
        decoratedWindow.draw();
    }
 
    private void drawHorizontalScrollBar() {
        // draw the horizontal scrollbar
    }
 
    public String getDescription() {
        return decoratedWindow.getDescription() + ", including horizontal scrollbars";
    }
}

Here's a test program that creates a Window instance which is fully decorated (i.e., with vertical and horizontal scrollbars), and prints its description:

public class DecoratedWindowTest {
    public static void main(String[] args) {
        // create a decorated Window with horizontal and vertical scrollbars
        Window decoratedWindow = new HorizontalScrollBarDecorator (
                new VerticalScrollBarDecorator(new SimpleWindow()));
 
        // print the Window's description
        System.out.println(decoratedWindow.getDescription());
    }
}

The output of this program is "simple window, including vertical scrollbars, including horizontal scrollbars". Notice how the getDescription method of the two decorators first retrieve the decorated Window's description and decorates it with a suffix.

In C++ we have:

#include <iostream>
 
using namespace std;
 
/* Component (interface) */
class Widget {
 
public: 
  virtual void draw() = 0; 
  virtual ~Widget() {}
};  
 
/* ConcreteComponent */
class TextField : public Widget {
 
private:                  
   int width, height;
 
public:
   TextField( int w, int h ){ 
      width  = w;
      height = h; 
   }
 
   void draw() { 
      cout << "TextField: " << width << ", " << height << '\n'; 
   }
};
 
/* Decorator (interface) */                                           
class Decorator : public Widget {
 
private:
   Widget* wid;       // reference to Widget
 
public:
   Decorator( Widget* w )  { 
     wid = w; 
   }
 
   void draw() { 
     wid->draw(); 
   }
 
   ~Decorator() {
     delete wid;
   }
};
 
/* ConcreteDecoratorA */
class BorderDecorator : public Decorator { 
 
public:
   BorderDecorator( Widget* w ) : Decorator( w ) { }
   void draw() {
      Decorator::draw();    
      cout << "   BorderDecorator" << '\n'; 
   }  
};
 
/* ConcreteDecoratorB */
class ScrollDecorator : public Decorator { 
public:
   ScrollDecorator( Widget* w ) : Decorator( w ) { }
   void draw() {
      Decorator::draw(); 
      cout << "   ScrollDecorator" << '\n';
   }  
};
 
int main( void ) {
 
   Widget* aWidget = new BorderDecorator(
                     new ScrollDecorator(
                     new TextField( 80, 24 )));
   aWidget->draw();
   delete aWidget;
}

In C#:

namespace GSL_Decorator_pattern
{
        interface IWindowObject
        {
                void draw(); // draws the object
                String getDescription(); // returns a description of the object
        }
 
 
        class ControlComponent : IWindowObject
        {
                public ControlComponent()
                {
                }
 
                public void draw() // draws the object
                {
                        Console.WriteLine( "ControlComponent::draw()" ); 
                }
 
                public String getDescription() // returns a description of the object
                {
                        return "ControlComponent::getDescription()";
                }
        }
 
        abstract class Decorator : IWindowObject
        {
                protected IWindowObject _decoratedWindow = null; // the object being decorated
 
                public Decorator( IWindowObject decoratedWindow )
                {
                        _decoratedWindow = decoratedWindow;
                }
 
                public virtual void draw()
                {
                        _decoratedWindow.draw();
                        Console.WriteLine("\tDecorator::draw() ");
                }
 
                public virtual String getDescription() // returns a description of the object
                {
                        return _decoratedWindow.getDescription() + "\n\t" + "Decorator::getDescription() ";
                }
        }
 
        // the first decorator 
        class DecorationA : Decorator
        {
                public DecorationA(IWindowObject decoratedWindow) : base(decoratedWindow)
                {
                }
 
                public override void draw()
                {
                        base.draw();
                        DecorationAStuff();
                }
 
                private void DecorationAStuff()
                {
                        Console.WriteLine("\t\tdoing DecorationA things");
                }
 
                public override String getDescription()
                {
                        return base.getDescription() + "\n\t\tincluding " + this.ToString();
                }
 
        }// end  class ConcreteDecoratorA : Decorator
 
        class DecorationB : Decorator
        {
                public DecorationB(IWindowObject decoratedWindow) : base(decoratedWindow)
                {
                }
 
                public override void draw()
                {
                        base.draw();
                        DecorationBStuff();
                }
 
                private void DecorationBStuff()
                {
                        Console.WriteLine("\t\tdoing DecorationB things");
                }
 
                public override String getDescription()
                {
                        return base.getDescription() + "\n\t\tincluding " + this.ToString();
                }
 
        }// end  class DecorationB : Decorator
 
        class DecorationC : Decorator
        {
                public DecorationC(IWindowObject decoratedWindow) : base(decoratedWindow)
                {
                }
 
                public override void draw()
                {
                        base.draw();
                        DecorationCStuff();
                }
 
                private void DecorationCStuff()
                {
                        Console.WriteLine("\t\tdoing DecorationC things");
                }
 
                public override String getDescription()
                {
                        return base.getDescription() + "\n\t\tincluding " + this.ToString();
                }
 
        }// end  class DecorationC : Decorator
 
}// end of namespace GSL_Decorator_pattern

The decorator pattern can also be implemented in dynamic languages with no interfaces or traditional OOP inheritance.

JavaScript coffee shop:

//Class to be decorated
function Coffee(){
    this.cost = function(){
        return 1;
    };
}
 
//Decorator A
function Milk(decorator){
    this.cost = function(){
        return decorator.cost() + 0.5;
    };    
}
 
//Decorator B
function Whip(decorator){
    this.cost = function(){
        return decorator.cost() + 0.7;
    };
}
 
//Decorator C
function Sprinkles(decorator){
    this.cost = function(){
        return decorator.cost() + 0.2;
    };
}
 
//Here's one way of using it
var coffee = new Milk(new Whip(new Sprinkles(new Coffee())));
alert( coffee.cost() );
 
//Here's another
var coffee = new Coffee();
coffee = new Sprinkles(coffee);
coffee = new Whip(coffee);
coffee = new Milk(coffee);
alert(coffee.cost());

[edit] See also

[edit] External links


v • d • e
Design patterns in the book Design Patterns
Creational
Structural
Adapter · Bridge · Composite · Decorator · Façade · Flyweight · Proxy
Behavioral