Skip to content

Commit 04bf566

Browse files
iluwatariluwatar
authored
task: Explanations and grammar fixes for all the GoF patterns (iluwatar#1791)
* Grammatical fixes to command pattern * Update bridge pattern readme * Fixes to builder pattern grammar * Update chain of responsibility * Improvements to the composite example * Fixes to headings * Minor updates to decorator pattern * Update facade * Update factory example * Update factory method * Update flyweight * Interpreter explanation * Update iterator readme * Add explanation for mediator pattern * Grammatical fixes to memento * Grammar fixes for observer * Update explanation for the prototype pattern * Proxy pattern grammar fixes * Update singleton * Grammar fixes to state pattern * Grammar fixes for strategy * Grammar fixes, template method * Grammar fixes for visitor * Fix typo
1 parent bbdff14 commit 04bf566

File tree

66 files changed

+870
-355
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+870
-355
lines changed

‎abstract-factory/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,13 +196,13 @@ Example use cases
196196
* Unit test case writing becomes much easier
197197
* UI tools for different OS
198198

199-
## Consequences:
199+
## Consequences
200200

201201
* Dependency injection in java hides the service class dependencies that can lead to runtime errors that would have been caught at compile time.
202202
* While the pattern is great when creating predefined objects, adding the new ones might be challenging.
203203
* The code becomes more complicated than it should be since a lot of new interfaces and classes are introduced along with the pattern.
204204

205-
## Tutorial
205+
## Tutorials
206206

207207
* [Abstract Factory Pattern Tutorial](https://www.journaldev.com/1418/abstract-factory-design-pattern-in-java)
208208

‎adapter/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Use the Adapter pattern when
105105
* you need to use several existing subclasses, but it's impractical to adapt their interface by subclassing every one. An object adapter can adapt the interface of its parent class.
106106
* most of the applications using third party libraries use adapters as a middle layer between the application and the 3rd party library to decouple the application from the library. If another library has to be used only an adapter for the new library is required without having to change the application code.
107107

108-
## Consequences:
108+
## Consequences
109109
Class and object adapters have different trade-offs. A class adapter
110110

111111
* adapts Adaptee to Target by committing to a concrete Adaptee class. As a consequence, a class adapter won’t work when we want to adapt a class and all its subclasses.
@@ -118,7 +118,7 @@ An object adapter
118118
* makes it harder to override Adaptee behavior. It will require subclassing Adaptee and making Adapter refer to the subclass rather than the Adaptee itself.
119119

120120

121-
## Real world examples
121+
## Known uses
122122

123123
* [java.util.Arrays#asList()](http://docs.oracle.com/javase/8/docs/api/java/util/Arrays.html#asList%28T...%29)
124124
* [java.util.Collections#list()](https://docs.oracle.com/javase/8/docs/api/java/util/Collections.html#list-java.util.Enumeration-)

‎bridge/README.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Decouple an abstraction from its implementation so that the two can vary indepen
1919

2020
## Explanation
2121

22-
Real world example
22+
Real-world example
2323

2424
> Consider you have a weapon with different enchantments, and you are supposed to allow mixing
2525
> different weapons with different enchantments. What would you do? Create multiple copies of each
@@ -161,27 +161,36 @@ public class SoulEatingEnchantment implements Enchantment {
161161
Here are both hierarchies in action:
162162

163163
```java
164+
LOGGER.info("The knight receives an enchanted sword.");
164165
var enchantedSword = new Sword(new SoulEatingEnchantment());
165166
enchantedSword.wield();
166167
enchantedSword.swing();
167168
enchantedSword.unwield();
168-
// The sword is wielded.
169-
// The item spreads bloodlust.
170-
// The sword is swinged.
171-
// The item eats the soul of enemies.
172-
// The sword is unwielded.
173-
// Bloodlust slowly disappears.
174169

170+
LOGGER.info("The valkyrie receives an enchanted hammer.");
175171
var hammer = new Hammer(new FlyingEnchantment());
176172
hammer.wield();
177173
hammer.swing();
178174
hammer.unwield();
179-
// The hammer is wielded.
180-
// The item begins to glow faintly.
181-
// The hammer is swinged.
182-
// The item flies and strikes the enemies finally returning to owner's hand.
183-
// The hammer is unwielded.
184-
// The item's glow fades.
175+
```
176+
177+
Here's the console output.
178+
179+
```
180+
The knight receives an enchanted sword.
181+
The sword is wielded.
182+
The item spreads bloodlust.
183+
The sword is swung.
184+
The item eats the soul of enemies.
185+
The sword is unwielded.
186+
Bloodlust slowly disappears.
187+
The valkyrie receives an enchanted hammer.
188+
The hammer is wielded.
189+
The item begins to glow faintly.
190+
The hammer is swung.
191+
The item flies and strikes the enemies finally returning to owner's hand.
192+
The hammer is unwielded.
193+
The item's glow fades.
185194
```
186195

187196
## Class diagram

‎builder/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ process can create different representations.
1616

1717
## Explanation
1818

19-
Real world example
19+
Real-world example
2020

2121
> Imagine a character generator for a role-playing game. The easiest option is to let the computer
2222
> create the character for you. If you want to manually select the character details like
23-
> profession, gender, hair color etc. the character generation becomes a step-by-step process that
23+
> profession, gender, hair color, etc. the character generation becomes a step-by-step process that
2424
> completes when all the selections are ready.
2525
2626
In plain words
@@ -49,7 +49,7 @@ anti-pattern.
4949

5050
**Programmatic Example**
5151

52-
The sane alternative is to use the Builder pattern. First of all we have our hero that we want to
52+
The sane alternative is to use the Builder pattern. First of all, we have our hero that we want to
5353
create:
5454

5555
```java
@@ -134,7 +134,7 @@ Use the Builder pattern when
134134
* The algorithm for creating a complex object should be independent of the parts that make up the object and how they're assembled
135135
* The construction process must allow different representations for the object that's constructed
136136

137-
## Real world examples
137+
## Known uses
138138

139139
* [java.lang.StringBuilder](http://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html)
140140
* [java.nio.ByteBuffer](http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html#put-byte-) as well as similar buffers such as FloatBuffer, IntBuffer and so on.

‎chain/README.md renamed to ‎chain-of-responsibility/README.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
11
---
22
layout: pattern
33
title: Chain of responsibility
4-
folder: chain
5-
permalink: /patterns/chain/
4+
folder: chain-of-responsibility
5+
permalink: /patterns/chain-of-responsibility/
66
categories: Behavioral
77
language: en
88
tags:
99
- Gang of Four
1010
---
1111

1212
## Intent
13+
1314
Avoid coupling the sender of a request to its receiver by giving more than one object a chance to
1415
handle the request. Chain the receiving objects and pass the request along the chain until an object
1516
handles it.
1617

1718
## Explanation
1819

19-
Real world example
20+
Real-world example
2021

2122
> The Orc King gives loud orders to his army. The closest one to react is the commander, then
22-
> officer and then soldier. The commander, officer and soldier here form a chain of responsibility.
23+
> an officer, and then a soldier. The commander, officer, and soldier form a chain of responsibility.
2324
2425
In plain words
2526

@@ -35,7 +36,7 @@ Wikipedia says
3536
3637
**Programmatic Example**
3738

38-
Translating our example with the orcs from above. First we have the `Request` class:
39+
Translating our example with the orcs from above. First, we have the `Request` class:
3940

4041
```java
4142
public class Request {
@@ -66,7 +67,7 @@ public enum RequestType {
6667
}
6768
```
6869

69-
Then the request handler hierarchy
70+
Next, we show the request handler hierarchy.
7071

7172
```java
7273
@Slf4j
@@ -116,7 +117,7 @@ public class OrcCommander extends RequestHandler {
116117

117118
```
118119

119-
Then we have the Orc King who gives the orders and forms the chain
120+
The Orc King gives the orders and forms the chain.
120121

121122
```java
122123
public class OrcKing {
@@ -136,18 +137,26 @@ public class OrcKing {
136137
}
137138
```
138139

139-
Then it is used as follows
140+
The chain of responsibility in action.
140141

141142
```java
142143
var king = new OrcKing();
143-
king.makeRequest(new Request(RequestType.DEFEND_CASTLE, "defend castle")); // Orc commander handling request "defend castle"
144-
king.makeRequest(new Request(RequestType.TORTURE_PRISONER, "torture prisoner")); // Orc officer handling request "torture prisoner"
145-
king.makeRequest(new Request(RequestType.COLLECT_TAX, "collect tax")); // Orc soldier handling request "collect tax"
144+
king.makeRequest(new Request(RequestType.DEFEND_CASTLE, "defend castle"));
145+
king.makeRequest(new Request(RequestType.TORTURE_PRISONER, "torture prisoner"));
146+
king.makeRequest(new Request(RequestType.COLLECT_TAX, "collect tax"));
147+
```
148+
149+
The console output.
150+
151+
```
152+
Orc commander handling request "defend castle"
153+
Orc officer handling request "torture prisoner"
154+
Orc soldier handling request "collect tax"
146155
```
147156

148157
## Class diagram
149158

150-
![alt text](./etc/chain.urm.png "Chain of Responsibility class diagram")
159+
![alt text](./etc/chain-of-responsibility.urm.png "Chain of Responsibility class diagram")
151160

152161
## Applicability
153162

@@ -157,7 +166,7 @@ Use Chain of Responsibility when
157166
* You want to issue a request to one of several objects without specifying the receiver explicitly.
158167
* The set of objects that can handle a request should be specified dynamically.
159168

160-
## Real world examples
169+
## Known uses
161170

162171
* [java.util.logging.Logger#log()](http://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html#log%28java.util.logging.Level,%20java.lang.String%29)
163172
* [Apache Commons Chain](https://commons.apache.org/proper/commons-chain/index.html)

‎chain/etc/chain.urm.png renamed to ‎chain-of-responsibility/etc/chain-of-responsibility.urm.png

File renamed without changes.

‎chain/etc/chain.urm.puml renamed to ‎chain-of-responsibility/etc/chain-of-responsibility.urm.puml

File renamed without changes.

‎chain/pom.xml renamed to ‎chain-of-responsibility/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<artifactId>java-design-patterns</artifactId>
3232
<version>1.25.0-SNAPSHOT</version>
3333
</parent>
34-
<artifactId>chain</artifactId>
34+
<artifactId>chain-of-responsibility</artifactId>
3535
<dependencies>
3636
<dependency>
3737
<groupId>org.junit.jupiter</groupId>

‎chain/src/main/java/com/iluwatar/chain/App.java renamed to ‎chain-of-responsibility/src/main/java/com/iluwatar/chain/App.java

File renamed without changes.

‎chain/src/main/java/com/iluwatar/chain/OrcCommander.java renamed to ‎chain-of-responsibility/src/main/java/com/iluwatar/chain/OrcCommander.java

File renamed without changes.

0 commit comments

Comments
 (0)