Builder pattern

<h2 id="overview">Overview</h2>
<p>The builder design pattern solves problems like:<a class="footnote-ref" id="fnref:2" href="#fn:2"><sup>2</sup></a>
</p>
<ul><li>How can a class (the same construction process) create different representations of a complex object?</li>
<li>How can a class that includes creating a complex object be simplified?</li></ul>
<p>Creating and assembling the parts of a complex object directly within a class is inflexible.  It commits the class to creating a particular representation of the complex object and makes it impossible to change the representation later independently from (without having to change) the class.
</p><p>The builder design pattern describes how to solve such problems:
</p>
<ul><li>Encapsulate creating and assembling the parts of a complex object in a separate  Builder object.</li>
<li>A class delegates object creation to a Builder object instead of creating the objects directly.</li></ul>
<p>A class (the same construction process) can delegate to different Builder objects to create different representations of a complex object.
</p>
<h2 id="definition">Definition</h2>
<p>The intent of the builder design pattern is to separate the construction of a complex object from its representation. By doing so, the same construction process can create different representations.<a class="footnote-ref" id="fnref:3" href="#fn:3"><sup>3</sup></a>
</p>
<h2 id="advantages">Advantages</h2>
<p>Advantages of the builder pattern include:<a class="footnote-ref" id="fnref:4" href="#fn:4"><sup>4</sup></a>
</p>
<ul><li>Allows you to vary a product's internal representation.</li>
<li>Encapsulates code for construction and representation.</li>
<li>Provides control over the steps of the construction process.</li></ul>
<h2 id="disadvantages">Disadvantages</h2>
<p>Disadvantages of the builder pattern include:<a class="footnote-ref" id="fnref:5" href="#fn:5"><sup>5</sup></a>
</p>
<ul><li>A distinct ConcreteBuilder must be created for each type of product.</li>
<li>Builder classes must be mutable.</li>
<li>May hamper/complicate dependency injection.</li>
<li>In many <a href="/facts/Void_safety/XH0BI8cE">null-safe</a> languages, the builder pattern defers <a href="/facts/Compile_time/yCdI3oqn">compile-time</a> errors for unset fields to <a href="/facts/Execution_(computing)/1fyfGMFm">runtime</a>.</li></ul>
<h2 id="structure">Structure</h2>
<h3>UML class and sequence diagram</h3>

<p>In the above <a href="/facts/Unified_Modeling_Language/3tlNS0tH">UML</a> <a href="/facts/Class_diagram/DNnkq7xh">class diagram</a>,
the Director class doesn't create and assemble the ProductA1 and ProductB1 objects directly.
Instead, the Director refers to the Builder interface for building (creating and assembling) the parts of a complex object,
which makes the Director independent of which concrete classes are instantiated (which representation is created).
The Builder1 class implements the Builder interface by creating and assembling the ProductA1 and ProductB1 objects.

The <a href="/facts/Unified_Modeling_Language/3tlNS0tH">UML</a> <a href="/facts/Sequence_diagram/1goY7KId">sequence diagram</a> shows the run-time interactions:
The Director object calls buildPartA() on the Builder1 object, which creates and assembles the ProductA1 object.
Thereafter,
the Director calls buildPartB() on Builder1, which creates and assembles the ProductB1 object.
</p>
<h3>Class diagram</h3>

Builder
Abstract interface for creating objects (product).
ConcreteBuilder
Provides implementation for Builder. It is an <a href="/facts/Factory_(software_concept)/o3rz6Rgu">object able to construct other objects</a>. Constructs and assembles parts to build the objects.
<h2 id="examples">Examples</h2>
<p>A <a href="/facts/C_Sharp_(programming_language)/UC2gxeyb">C#</a> example:
</p>
/// <summary>
/// Represents a product created by the builder.
/// </summary>
public class Bicycle
{
    public Bicycle(string make, string model, string colour, int height)
    {
        Make = make;
        Model = model;
        Colour = colour;
        Height = height;
    }

public string Make { get; set; }
    public string Model { get; set; }
    public int Height { get; set; }
    public string Colour { get; set; }
}

/// <summary>
/// The builder abstraction.
/// </summary>
public interface IBicycleBuilder
{
    Bicycle GetResult();

string Colour { get; set; }
    int Height { get; set; }
}

/// <summary>
/// Concrete builder implementation.
/// </summary>
public class GTBuilder : IBicycleBuilder
{
    public Bicycle GetResult()
    {
        return Height == 29 ? new Bicycle("GT", "Avalanche", Colour, Height) : null;
    }

public string Colour { get; set; }
    public int Height { get; set; }
}

/// <summary>
/// The director.
/// </summary>
public class MountainBikeBuildDirector
{
    private IBicycleBuilder _builder;

public MountainBikeBuildDirector(IBicycleBuilder builder)
    {
        _builder = builder;
    }

public void Construct()
    {
        _builder.Colour = "Red";
        _builder.Height = 29;
    }

public Bicycle GetResult()
	{
		return this._builder.GetResult();
	}
}

public class Client
{
    public void DoSomethingWithBicycles()
    {
        var director = new MountainBikeBuildDirector(new GTBuilder());
        // Director controls the stepwise creation of product and returns the result.
        director.Construct();
        Bicycle myMountainBike = director.GetResult();
    }
}

<p>The Director assembles a bicycle instance in the example above, delegating the construction to a separate builder object that has been given to the Director by the Client.
</p>
<h2 id="see-also">See also</h2>
<ul><li><a href="/facts/Currying/AmD3PP5B">Currying</a></li></ul>
<h2 id="notes">Notes</h2>

<ul><li><a href="/facts/Erich_Gamma/5RulmUAp">Gamma, Erich</a>; <a href="/facts/Richard_Helm/sYDxSGc9">Helm, Richard</a>; <a href="/facts/Ralph_Johnson_(computer_scientist)/xp2MMydY">Johnson, Ralph</a>; <a href="/facts/John_Vlissides/61wnw84b">Vlissides, John</a> (1994). <a href="/facts/Design_Patterns/sYDxSGc9"><i>Design Patterns: Elements of Reusable Object-Oriented Software</i></a>. Addison-Wesley. <a href="/facts/ISBN_(identifier)/15AdSPa9">ISBN</a> 0-201-63361-2.</li></ul>
<h2 id="external-links">External links</h2>

The Wikibook <i>Computer Science Design Patterns</i> has a page on the topic of: <i>Builder implementations in various languages</i>

<h2 id="references">References</h2>

<ol>
<li id="fn:1"><p>Gamma et al. 1994, p. 97. - Gamma, Erich; Helm, Richard; Johnson, Ralph; Vlissides, John (1994). Design Patterns: Elements of Reusable Object-Oriented Software. Addison-Wesley. ISBN 0-201-63361-2. <a href="#fnref:1" class="footnote-back-ref">↩</a></p></li>
<li id="fn:2"><p>"The Builder design pattern - Problem, Solution, and Applicability". w3sDesign.com. Retrieved 2017-08-13. <a href="http://w3sdesign.com/?gr=c02&ugr=proble" target="_blank">http://w3sdesign.com/?gr=c02&ugr=proble</a> <a href="#fnref:2" class="footnote-back-ref">↩</a></p></li>
<li id="fn:3"><p>Gamma et al. 1994, p. 97. - Gamma, Erich; Helm, Richard; Johnson, Ralph; Vlissides, John (1994). Design Patterns: Elements of Reusable Object-Oriented Software. Addison-Wesley. ISBN 0-201-63361-2. <a href="#fnref:3" class="footnote-back-ref">↩</a></p></li>
<li id="fn:4"><p>"Index of /archive/2010/winter/51023-1/presentations" (PDF). www.classes.cs.uchicago.edu. Retrieved 2016-03-03. <a href="https://www.classes.cs.uchicago.edu/archive/2010/winter/51023-1/presentations/ricetj_builder.pdf" target="_blank">https://www.classes.cs.uchicago.edu/archive/2010/winter/51023-1/presentations/ricetj_builder.pdf</a> <a href="#fnref:4" class="footnote-back-ref">↩</a></p></li>
<li id="fn:5"><p>"Index of /archive/2010/winter/51023-1/presentations" (PDF). www.classes.cs.uchicago.edu. Retrieved 2016-03-03. <a href="https://www.classes.cs.uchicago.edu/archive/2010/winter/51023-1/presentations/ricetj_builder.pdf" target="_blank">https://www.classes.cs.uchicago.edu/archive/2010/winter/51023-1/presentations/ricetj_builder.pdf</a> <a href="#fnref:5" class="footnote-back-ref">↩</a></p></li>
</ol>

Builder pattern open-in-new

Builder pattern