[CLI-333] Define Builder as an implementation of Supplier

• Type: New Feature
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Affects Version/s: 1.7.0
• Component/s: CLI-1.x, Help formatter, Parser
• Assignee: Claude Warren
• Reporter: Claude Warren
• Created: 15/May/24 07:12
• Updated: 15/May/24 15:43

Description

The Builder pattern as described by the gang of four and general implementations across multiple blogs and source packages creates a complex pattern when a method is called.  That method specified in the pattern description is "getResult", however the review of several blogs and implementations indicate that "build", "getX" "toX" are all popular names for the production method.

In Java the Supplier interface defines a producer of X and stipulates that every time the production method is called an instance of X must be returned.  It does allow for the same instance to be returned for every call.

Thus a Builder is a customization of the Supplier.  As commons strives to utilize the JRE patterns over custom patterns, it makes sense that all Builders should implement Supplier.

Therefore this change is to have all Builders

1. implement Supplier and add a get() method (if not already present)
2. have the current producer method delegate to the get() method
3. mark the current producer method as deprecated with a note to use get.