Skip to main content

Fluent Builder Pattern

Fluent Builder Pattern

Gamma Categorization: Creational Design Patten
Summary: Extension of the Builder Pattern, that allows us to chain the operation calls.

Problem examples

We want to chain the operation calls for convenience purposes.

Solution

The methods now return the class itself.

Sample Code

Plese refer to the Builder Pattern article for the complete code.

The main changes are made in the base abstract class of the ReportBuilder.

public abstract class ReportBuilder
{
    protected Report report;

    public ReportBuilder CreateReport()
    {
        report = new Report();
        return this;
    } 

    public ReportBuilder SetHeader(string header
    {
        report.Header = header;
        return this;
    } 

    public ReportBuilder AppendContentLine(string contentLine)
    {
        report.Content.Add(contentLine);
        return this;
    } 

    public ReportBuilder SetFooter(string footer)
    {
        report.Footer = footer;
        return this;
    } 

    public abstract string  DispatchReport();

    public void Clear() => report = new Report();
}

Usage 

The usage is now simplified as follows.

var textReportBuilder = new TextReportBuilder();

var report = textReportBuilder.CreateReport()
    .SetHeader($"Daily Report - {DateTime.UtcNow.ToString("dd/MM/yyyy")}")
    .AppendContentLine("14 Hot Meals")
    .AppendContentLine("22 Breakfasts")
    .SetFooter("Copyright - Cafe Shop")
    .DispatchReport();

System.Console.WriteLine(report);

Comments

Popular posts from this blog

XML Webservice (ASMX) - SOAP Request and Response Invocation logging

You are an integration developer. Eventualy you came into the state where there is nothing else you can debug, and you have to check which SOAP request it is built on the request, and which SOAP response you are getting from the server. C# XML Webservice (ASMX) - SOAP Request and Response Invocation logging In the legaccy .NET framework System.Web.Services , this means using soapExtensions to help you intersept the interaction with the webservice. This is done like so:  public class TraceExtension : SoapExtension     {         Stream oldStream;         Stream newStream;         string filename;         // Save the Stream representing the SOAP request or SOAP response into          // a local memory buffer.          public override Stream ChainStream(Stream stream)         {           ...

Abstract Factory Pattern

Abstract Factory Pattern  Gamma Categorization: Creational Design Patten Summary: When the object construction is complicated, needing multiple arguments, we should create a separate function (Factory Method) or class (Factory), which is responsible for the creation of the all object. Problem examples Suport of multiple databases Multiple data sources: Serial port, ethernet port, device driver Diferent report types Solution Abstract class Generalized interface A Factory creates instances of the concrete classes Sample Code The abstract factory public   interface   IPhotoFactory {      IAnaloguePhoto   CreateAnaloguePhoto ();      IDigitalPhoto   CreateDigitalPhoto (); } The abstract products public   interface   IAnaloguePhoto {      string   GetName (); } public   interface   IDigitalPhoto {      ...

SOLID (1/5) - Single Resposibility Principle

 SOLID (1/5) - Single Resposibility Principle The single-responsibility principle (SRP) is a computer-programming principle that states that every class in a computer program should have responsibility over a single part of that program's functionality, which it should encapsulate. All of that module, class or function's services should be narrowly aligned with that responsibility. In the following example we have a TodoList class which only handles it's own functionality logic, and then we have a Persistance class which handles the saving logic, hence keeping the concerns separeted. using   System ; using   System . Collections . Generic ; namespace   Journal {      public   class   TodoList     {          private   readonly   List < string >  _entries  =  new   List < string >();          private...