Examples of GoF Design Patterns in Java's core libraries

Question

I am learning GoF Java Design Patterns and I want to see some real life examples of them. What are some good examples of these Design Patterns in Java's core libraries?

Puentes

Answer 1

You can find an overview of a lot of design patterns in Wikipedia. It also mentions which patterns are mentioned by GoF. I'll sum them up here and try to assign as many pattern implementations as possible, found in both the Java SE and Java EE APIs.

---

Creational patterns

Abstract factory ^{_{(recognizeable by creational methods returning the factory itself which in turn can be used to create another abstract/interface type)}}

• javax.xml.parsers.DocumentBuilderFactory#newInstance()
• javax.xml.transform.TransformerFactory#newInstance()
• javax.xml.xpath.XPathFactory#newInstance()

Builder ^{_{(recognizeable by creational methods returning the instance itself)}}

• java.lang.StringBuilder#append() (unsynchronized)
• java.lang.StringBuffer#append() (synchronized)
• java.nio.ByteBuffer#put() (also on CharBuffer, ShortBuffer, IntBuffer, LongBuffer, FloatBuffer and DoubleBuffer)
• javax.swing.GroupLayout.Group#addComponent()
• All implementations of java.lang.Appendable
• java.util.stream.Stream.Builder

Factory method ^{_{(recognizeable by creational methods returning an implementation of an abstract/interface type)}}

• java.util.Calendar#getInstance()
• java.util.ResourceBundle#getBundle()
• java.text.NumberFormat#getInstance()
• java.nio.charset.Charset#forName()
• java.net.URLStreamHandlerFactory#createURLStreamHandler(String) (Returns singleton object per protocol)
• java.util.EnumSet#of()
• javax.xml.bind.JAXBContext#createMarshaller() and other similar methods

Prototype ^{_{(recognizeable by creational methods returning a different instance of itself with the same properties)}}

• java.lang.Object#clone() (the class has to implement java.lang.Cloneable)

Singleton ^{_{(recognizeable by creational methods returning the same instance (usually of itself) everytime)}}

• java.lang.Runtime#getRuntime()
• java.awt.Desktop#getDesktop()
• java.lang.System#getSecurityManager()

---

Structural patterns

Adapter ^{_{(recognizeable by creational methods taking an instance of different abstract/interface type and returning an implementation of own/another abstract/interface type which decorates/overrides the given instance)}}

• java.util.Arrays#asList()
• java.util.Collections#list()
• java.util.Collections#enumeration()
• java.io.InputStreamReader(InputStream) (returns a Reader)
• java.io.OutputStreamWriter(OutputStream) (returns a Writer)
• javax.xml.bind.annotation.adapters.XmlAdapter#marshal() and #unmarshal()

Bridge ^{_{(recognizeable by creational methods taking an instance of different abstract/interface type and returning an implementation of own abstract/interface type which delegates/uses the given instance)}}

• None comes to mind yet. A fictive example would be new LinkedHashMap(LinkedHashSet<K>, List<V>) which returns an unmodifiable linked map which doesn't clone the items, but uses them. The java.util.Collections#newSetFromMap() and singletonXXX() methods however comes close.

Composite ^{_{(recognizeable by behavioral methods taking an instance of same abstract/interface type into a tree structure)}}

• java.awt.Container#add(Component) (practically all over Swing thus)
• javax.faces.component.UIComponent#getChildren() (practically all over JSF UI thus)

Decorator ^{_{(recognizeable by creational methods taking an instance of same abstract/interface type which adds additional behaviour)}}

• All subclasses of java.io.InputStream, OutputStream, Reader and Writer have a constructor taking an instance of same type.
• java.util.Collections, the checkedXXX(), synchronizedXXX() and unmodifiableXXX() methods.
• javax.servlet.http.HttpServletRequestWrapper and HttpServletResponseWrapper
• javax.swing.JScrollPane

Facade ^{_{(recognizeable by behavioral methods which internally uses instances of different independent abstract/interface types)}}

• javax.faces.context.FacesContext, it internally uses among others the abstract/interface types LifeCycle, ViewHandler, NavigationHandler and many more without that the enduser has to worry about it (which are however overrideable by injection).
• javax.faces.context.ExternalContext, which internally uses ServletContext, HttpSession, HttpServletRequest, HttpServletResponse, etc.

Flyweight ^{_{(recognizeable by creational methods returning a cached instance, a bit the "multiton" idea)}}

• java.lang.Integer#valueOf(int) (also on Boolean, Byte, Character, Short, Long and BigDecimal)

Proxy ^{_{(recognizeable by creational methods which returns an implementation of given abstract/interface type which in turn delegates/uses a different implementation of given abstract/interface type)}}

• java.lang.reflect.Proxy
• java.rmi.*
• javax.ejb.EJB (explanation here)
• javax.inject.Inject (explanation here)
• javax.persistence.PersistenceContext

---

Behavioral patterns

Chain of responsibility ^{_{(recognizeable by behavioral methods which (indirectly) invokes the same method in another implementation of same abstract/interface type in a queue)}}

• java.util.logging.Logger#log()
• javax.servlet.Filter#doFilter()

Command ^{_{(recognizeable by behavioral methods in an abstract/interface type which invokes a method in an implementation of a different abstract/interface type which has been encapsulated by the command implementation during its creation)}}

• All implementations of java.lang.Runnable
• All implementations of javax.swing.Action

Interpreter ^{_{(recognizeable by behavioral methods returning a structurally different instance/type of the given instance/type; note that parsing/formatting is not part of the pattern, determining the pattern and how to apply it is)}}

• java.util.Pattern
• java.text.Normalizer
• All subclasses of java.text.Format
• All subclasses of javax.el.ELResolver

Iterator ^{_{(recognizeable by behavioral methods sequentially returning instances of a different type from a queue)}}

• All implementations of java.util.Iterator (thus among others also java.util.Scanner!).
• All implementations of java.util.Enumeration

Mediator ^{_{(recognizeable by behavioral methods taking an instance of different abstract/interface type (usually using the command pattern) which delegates/uses the given instance)}}

• java.util.Timer (all scheduleXXX() methods)
• java.util.concurrent.Executor#execute()
• java.util.concurrent.ExecutorService (the invokeXXX() and submit() methods)
• java.util.concurrent.ScheduledExecutorService (all scheduleXXX() methods)
• java.lang.reflect.Method#invoke()

Memento ^{_{(recognizeable by behavioral methods which internally changes the state of the whole instance)}}

• java.util.Date (the setter methods do that, Date is internally represented by a long value)
• All implementations of java.io.Serializable
• All implementations of javax.faces.component.StateHolder

Observer (or Publish/Subscribe) ^{_{(recognizeable by behavioral methods which invokes a method on an instance of another abstract/interface type, depending on own state)}}

• java.util.Observer/java.util.Observable (rarely used in real world though)
• All implementations of java.util.EventListener (practically all over Swing thus)
• javax.servlet.http.HttpSessionBindingListener
• javax.servlet.http.HttpSessionAttributeListener
• javax.faces.event.PhaseListener

State ^{_{(recognizeable by behavioral methods which changes its behaviour depending on the instance's state which can be controlled externally)}}

• javax.faces.lifecycle.LifeCycle#execute() (controlled by FacesServlet, the behaviour is dependent on current phase (state) of JSF lifecycle)

Strategy ^{_{(recognizeable by behavioral methods in an abstract/interface type which invokes a method in an implementation of a different abstract/interface type which has been passed-in as method argument into the strategy implementation)}}

• java.util.Comparator#compare(), executed by among others Collections#sort().
• javax.servlet.http.HttpServlet, the service() and all doXXX() methods take HttpServletRequest and HttpServletResponse and the implementor has to process them (and not to get hold of them as instance variables!).
• javax.servlet.Filter#doFilter()

Template method ^{_{(recognizeable by behavioral methods which already have a "default" behaviour defined by an abstract type)}}

• All non-abstract methods of java.io.InputStream, java.io.OutputStream, java.io.Reader and java.io.Writer.
• All non-abstract methods of java.util.AbstractList, java.util.AbstractSet and java.util.AbstractMap.
• javax.servlet.http.HttpServlet, all the doXXX() methods by default sends a HTTP 405 "Method Not Allowed" error to the response. You're free to implement none or any of them.

Visitor ^{_{(recognizeable by two different abstract/interface types which has methods defined which takes each the other abstract/interface type; the one actually calls the method of the other and the other executes the desired strategy on it)}}

• javax.lang.model.element.AnnotationValue and AnnotationValueVisitor
• javax.lang.model.element.Element and ElementVisitor
• javax.lang.model.type.TypeMirror and TypeVisitor
• java.nio.file.FileVisitor and SimpleFileVisitor
• javax.faces.component.visit.VisitContext and VisitCallback

Igenia

impressive.. :) +1. javax.lang.model.element defines visitors ;) I'm not quite sure whether doXXX and doFilter are "strategies". – Marasco

@Bozho: Thank you for the visitor example! (that whole API is actually new to me btw). In the doXXX() and doFilter() you basically write the strategy algorithm alone. The server loads and executes it. – Igenia

hm, yes.. my impression is that the strategies have to be objects conforming to a strategy interface, and thus interchangeable at runtime – Marasco

This related blog post just appeared briandupreez.net/2010/11/design-patterns-in-jdk.html – Marasco

The mentioned builders e.g. StrinbgBuilder are all not an example for the Builder-Pattern. It is a very common mistake however to consider them as builders (so you are not really to blame ^_^) – Covarrubias

@BalusC: are you sure that 'All non-abstract methods of java.io.InputStream, java.io.OutputStream, java.io.Reader and java.io.Writer.' are template methods? For example, InputStream#available(). – Symphony

The Adapter examples are too shallow. I was hoping to see clearly how one adapter interface supports different adaptee interfaces, but it's not obvious from the examples. – Freytag

@BalusC, I have a question to ask you. Did you read the WHOLE source code of Java and JSF? – Baez

@Tapas: I did not read everything, only parts which I needed to, or were just curious as to how "they" did it. – Igenia

@Igenia In the Singleton design pattern, getInstance() is the name of the method that returns the singleton, in all books I have read so far (incl the Wikipedia page I am referring). I find it very confusing that the the JDK actually doesn't return a singleton on methods named getInstance() – Funderburk

Most of the examples under "Factory Method"are examples of "static factory" which is not a GoF pattern. Not correct. – Shamble

docs.oracle.com/javase/tutorial/jaxp/sax/parsing.html Standard SAX parsing APIs would be an example of the Visitor pattern – Institute

And what would be java.awt.GridBagConstraints? State? Also I wonder if MultiValueMap is proper candidate for bridge (however it is not Java core). Thanks. – Homoio

Adapter example: java.util.Collections # enumeration(Collection<T> c) : It allows you to enumerate over ArrayList – Protractile

Introduced in 1.8, Calendar.Builder is also a good example of the builder pattern. – Beachhead

@Igenia InputStreamReader is documented to be a bridge from byte streams to char streams in official javadoc of Oracle. Is there a reason it is under Adapter? – Peace

@Igenia How can serialization be called Memento? By itself serialization is dumb and does not do anything special. Yes serialization can be used as one of the techniques to implement memento. Any insights would be great. Thanks. – Peace

Memento vs Serialization stackoverflow.com/questions/14076772/… – Peace

Template example: Template lays down the steps of an algorithm or process and usually involves multiple abstract methods whose implementation must be filled in by concrete classes. But I doubt whether InputStream and OutputStream non abstract methods qualify as template methods – Peace

Isn't javax.xml.parsers.DocumentBuilderFactory part of a Builder pattern rather than Abstract Factory? – Bethelbethena

@Malvon: a class can implement multiple design patterns. – Igenia

@Igenia Understood. How about JCA framework and/or Java encryption? Do we have any Creational pattern? – Bethelbethena

Read the most voted answer, and found that the Abstract Factory and Factory Method mentioned here is not the design patterns defined in GOF book. That is to say, this answer in WRONG when talking about the Abstract Factory and Factory Method. – Reinaldoreinaldos

java.util.Arrays#asList() is not an adapter as of state of JDK8, it takes Objects and creates ArrayList from them, so it transforms not adapts. – Homerhomere

the StringBuilder is an example of the "java builder" design pattern and not the GOF Builder pattern. They're different patterns and often confused – Allred

@Igenia "note that parsing/formatting is not part of the pattern, determining the pattern and how to apply it is". Can you please elaborate this with respect to java.util.Pattern and java.text.Format? Format class must do i)pattern matching and ii)formatting for you to say that statement? If so, what is the clear distinction/boundary between these 2 steps? In other words, what is the RESULT of just "pattern matching"(interpreting) step which is used by the "formatting" step? – Arbitrary

You can find the visual model of the GoF Design Patterns at visual-paradigm.org/category/gof-design – Polytonality

Am I right saying that org.xml.sax.ContentHandler is also a visitor that visits XML elements? And javax.xml.stream.XMLEventReader is iterator... – Homoio

I count three: Behavioral, Creational, Structural. Why is it called Gang of Four? edit: Named after the authors: Gamma, Erich; Helm, Richard; Johnson, Ralph; Vlissides, John (1995). Design Patterns: Elements of Reusable Object-Oriented Software. – Dorrisdorry

Are there API examples of the Adapter Pattern with respect to JDBC? The Oracle coined "DAO" or "Data Access Object Pattern" is a subordinate type of adapter pattern: "Essentially, the DAO acts as an adapter between the component and the data source." - OTN. I want to know if there are any specific DAO examples that qualify as implementations GoF adapter pattern. – Adenectomy

Awesome :). Just adding the missing, which is very common. Java Exceptions are using the Chain-of-Responsibility pattern – Trimorphism

Answer 2

1. Observer pattern throughout whole swing (Observable, Observer)
2. MVC also in swing
3. Adapter pattern: InputStreamReader and OutputStreamWriter NOTE: ContainerAdapter, ComponentAdapter, FocusAdapter, KeyAdapter, MouseAdapter are not adapters; they are actually Null Objects. Poor naming choice by Sun.
4. Decorator pattern (BufferedInputStream can decorate other streams such as FilterInputStream)
5. AbstractFactory Pattern for the AWT Toolkit and the Swing pluggable look-and-feel classes
6. java.lang.Runtime#getRuntime() is Singleton
7. ButtonGroup for Mediator pattern
8. Action, AbstractAction may be used for different visual representations to execute same code -> Command pattern
9. Interned Strings or CellRender in JTable for Flyweight Pattern (Also think about various pools - Thread pools, connection pools, EJB object pools - Flyweight is really about management of shared resources)
10. The Java 1.0 event model is an example of Chain of Responsibility, as are Servlet Filters.
11. Iterator pattern in Collections Framework
12. Nested containers in AWT/Swing use the Composite pattern
13. Layout Managers in AWT/Swing are an example of Strategy

and many more I guess

Except

Thanks for the tip on MouseAdapter. I found this exaplanation: stackoverflow.com/questions/9244185/… – Enamor

Note that Swing is only loosely based on MVC. It has collapsed View and Controller into one class. – Future

Answer 3

1. Flyweight is used with some values of Byte, Short, Integer, Long and String.
2. Facade is used in many place but the most obvious is Scripting interfaces.
3. Singleton - java.lang.Runtime comes to mind.
4. Abstract Factory - Also Scripting and JDBC API.
5. Command - TextComponent's Undo/Redo.
6. Interpreter - RegEx (java.util.regex.) and SQL (java.sql.) API.
7. Prototype - Not 100% sure if this count, but I thinkg clone() method can be used for this purpose.

Lydie

Concerning Flyweight pattern: it could be different Layout Managers from java.awt and java.swing packages. Indeed, they share almost identical intrinsic attributes and extrinsic attributes are different UI components that they lay out in UI form. – Diseuse

@Lydie You said 5. Comand TextComponent's Undo/Redo. I think it is memento not command. Or most probably both. – Fao

Answer 4

RMI is based on Proxy.

Should be possible to cite one for most of the 23 patterns in GoF:

1. Abstract Factory: java.sql interfaces all get their concrete implementations from JDBC JAR when driver is registered.
2. Builder: java.lang.StringBuilder.
3. Factory Method: XML factories, among others.
4. Prototype: Maybe clone(), but I'm not sure I'm buying that.
5. Singleton: java.lang.System
6. Adapter: Adapter classes in java.awt.event, e.g., WindowAdapter.
7. Bridge: Collection classes in java.util. List implemented by ArrayList.
8. Composite: java.awt. java.awt.Component + java.awt.Container
9. Decorator: All over the java.io package.
10. Facade: ExternalContext behaves as a facade for performing cookie, session scope and similar operations.
11. Flyweight: Integer, Character, etc.
12. Proxy: java.rmi package
13. Chain of Responsibility: Servlet filters
14. Command: Swing menu items
15. Interpreter: No directly in JDK, but JavaCC certainly uses this.
16. Iterator: java.util.Iterator interface; can't be clearer than that.
17. Mediator: JMS?
18. Memento:
19. Observer: java.util.Observer/Observable (badly done, though)
20. State:
21. Strategy:
22. Template:
23. Visitor:

I can't think of examples in Java for 10 out of the 23, but I'll see if I can do better tomorrow. That's what edit is for.

Armorer

Answer 5

The Abstract Factory pattern is used in various places. E.g., DatagramSocketImplFactory, PreferencesFactory. There are many more---search the Javadoc for interfaces which have the word "Factory" in their name.

Also there are quite a few instances of the Factory pattern, too.

Bewhiskered

Answer 6

• Factory method

java.util.Collection#Iterator is a good example of a Factory Method. Depending on the concrete subclass of Collection you use, it will create an Iterator implementation. Because both the Factory superclass (Collection) and the Iterator created are interfaces, it is sometimes confused with AbstractFactory. Most of the examples for AbstractFactory in the the accepted answer (BalusC) are examples of Factory, a simplified version of Factory Method, which is not part of the original GoF patterns. In Facory the Factory class hierarchy is collapsed and the factory uses other means to choose the product to be returned.

• Abstract Factory

An abstract factory has multiple factory methods, each creating a different product. The products produced by one factory are intended to be used together (your printer and cartridges better be from the same (abstract) factory). As mentioned in answers above the families of AWT GUI components, differing from platform to platform, are an example of this (although its implementation differs from the structure described in Gof).

Bestialize

Answer 7

Even though I'm sort of a broken clock with this one, Java XML API uses Factory a lot. I mean just look at this:

Document doc = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(source);
String title = XPathFactory.newInstance().newXPath().evaluate("//title", doc);

...and so on and so forth.

Additionally various Buffers (StringBuffer, ByteBuffer, StringBuilder) use Builder.

Office