org.apache.commons.lang3.builder

Interface Builder<T>

Type Parameters:

T - the type of object that the builder will construct or compute.

All Known Implementing Classes:

BasicThreadFactory.Builder, CompareToBuilder, DiffBuilder, EqualsBuilder, HashCodeBuilder, ReflectionToStringBuilder, StrBuilder, ToStringBuilder, TypeUtils.WildcardTypeBuilder

public interface Builder<T>

The Builder interface is designed to designate a class as a builder object in the Builder design pattern. Builders are capable of creating and configuring objects or results that normally take multiple steps to construct or are very complex to derive.

The builder interface defines a single method, build(), that classes must implement. The result of this method should be the final configured object or result after all building operations are performed.

It is a recommended practice that the methods supplied to configure the object or result being built return a reference to this so that method calls can be chained together.

Example Builder:

 class FontBuilder implements Builder<Font> {
     private Font font;
     
     public FontBuilder(String fontName) {
         this.font = new Font(fontName, Font.PLAIN, 12);
     }
 
     public FontBuilder bold() {
         this.font = this.font.deriveFont(Font.BOLD);
         return this; // Reference returned so calls can be chained
     }
     
     public FontBuilder size(float pointSize) {
         this.font = this.font.deriveFont(pointSize);
         return this; // Reference returned so calls can be chained
     }
 
     // Other Font construction methods
 
     public Font build() {
         return this.font;
     }
 }
 

Example Builder Usage:

 Font bold14ptSansSerifFont = new FontBuilder(Font.SANS_SERIF).bold()
                                                              .size(14.0f)
                                                              .build();
 

Since:

3.0

Version:

$Id: Builder.java 1583482 2014-03-31 22:54:57Z niallp $

Method Summary

Methods

Modifier and Type	Method and Description
T	build() Returns a reference to the object being constructed or result being calculated by the builder.

Method Detail

build

T build()

Returns a reference to the object being constructed or result being calculated by the builder.

Returns:

the object constructed or result calculated by the builder.