Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Explanation for design patterns #590

Closed
iluwatar opened this issue Jun 11, 2017 · 40 comments · Fixed by #1791
Closed

Explanation for design patterns #590

iluwatar opened this issue Jun 11, 2017 · 40 comments · Fixed by #1791
Assignees
@iluwatar @AJESH-CR @ManviGoel26 @JanFidor @q1xiangchen @annieS987 @QihaMarz @SammanPali @steph88ss @u7281975
Labels
epic: design epic: pattern epic: web site info: good first issue info: help wanted info: needs splitting type: enhancement

Comments

@iluwatar
Copy link
Owner

iluwatar commented Jun 11, 2017 •
edited

We want to present the design patterns better as the current does not reach its goal of explaining how the pattern works in a simplest possible way. I'm hugely inspired by https://github.com/kamranahmedse/design-patterns-for-humans repository.

Let's do this by adding 'Explanation' section to the patterns' README.md file. For an example see http://java-design-patterns.com/patterns/bridge/.

Let's track the issue progress here with the following checklist that indicates the patterns where explanation section is already available.

  • abstract-document
  • abstract-factory
  • active-object
  • acyclic-visitor
  • adapter
  • aggregator-microservices
  • ambassador
  • api-gateway
  • arrange-act-assert
  • async-method-invocation
  • balking
  • bridge
  • builder
  • business-delegate
  • bytecode
  • caching
  • callback
  • chain
  • circuit-breaker
  • cloud-static-content-hosting
  • collection-pipeline
  • combinator
  • command
  • commander
  • composite
  • composite-entity
  • converter
  • cqrs
  • dao
  • data-bus
  • data-locality
  • data-mapper
  • data-transfer-object
  • decorator
  • delegation
  • dependency-injection
  • dirty-flag
  • double-buffer
  • double-checked-locking
  • double-dispatch
  • eip-aggregator
  • eip-message-channel
  • eip-publish-subscribe
  • eip-splitter
  • eip-wire-tap
  • event-aggregator
  • event-based-asynchronous
  • event-driven-architecture
  • event-queue
  • event-sourcing
  • execute-around
  • extension-objects
  • facade
  • factory
  • factory-kit
  • factory-method
  • fan-out-fan-in
  • feature-toggle
  • filterer
  • fluentinterface
  • flux
  • flyweight
  • front-controller
  • game-loop
  • guarded-suspension
  • half-sync-half-async
  • hexagonal
  • intercepting-filter
  • interpreter
  • iterator
  • layers
  • lazy-loading
  • leader-election
  • leader-followers
  • lockable-object
  • marker-interface
  • master-worker
  • mediator
  • memento
  • model-view-controller
  • model-view-presenter
  • model-view-viewmodel
  • module
  • monad
  • monostate
  • multiton
  • mute-idiom
  • naked-objects
  • null-object
  • object-mother
  • object-pool
  • observer
  • page-object
  • parameter-object
  • partial-response
  • pipeline
  • poison-pill
  • presentation-model
  • priority-queue
  • private-class-data
  • producer-consumer
  • promise
  • property
  • prototype
  • proxy
  • queue-based-load-leveling
  • reactor
  • reader-writer-lock
  • registry
  • repository
  • resource-acquisition-is-initialization
  • retry
  • role-object
  • saga
  • semaphore
  • separated-interface
  • servant
  • serverless
  • service-layer
  • service-locator
  • sharding
  • singleton
  • spatial-partition
  • special-case
  • specification
  • state
  • step-builder
  • strangler
  • strategy
  • subclass-sandbox
  • table-module
  • template-method
  • thread-pool
  • throttling
  • thread-local-storage
  • tolerant-reader
  • trampoline
  • transaction-script
  • twin
  • type-object
  • unit-of-work
  • update-method
  • value-object
  • version-number
  • visitor
@iluwatar
Copy link
Owner Author

Changed https://github.com/iluwatar/java-design-patterns/wiki/02.-Pattern-template a bit. There is no diagram anymore. Explanation section was added.

iluwatar added a commit that referenced this issue Aug 12, 2017
@iluwatar
#590 Add new presentation for Singleton
746e452
iluwatar added a commit that referenced this issue Aug 12, 2017
@iluwatar
#590 Skip puml processing for singleton module
2150a2b
iluwatar added a commit that referenced this issue Aug 12, 2017
@iluwatar
#590 Alter Factory Method presentation
2d750dc
iluwatar added a commit that referenced this issue Aug 12, 2017
@iluwatar
#590 Kramdown fixes
fba30e5
iluwatar added a commit that referenced this issue Aug 13, 2017
@iluwatar
#590 Add explanation for Abstract Factory
37b9d45
iluwatar added a commit that referenced this issue Aug 13, 2017
@iluwatar
#590 Add explanation for Builder
f6c8bfb
iluwatar added a commit that referenced this issue Aug 16, 2017
@iluwatar
#590 Add explanation for Prototype
b639f36
iluwatar added a commit that referenced this issue Aug 19, 2017
@iluwatar
#590 Add explanation for Adapter
fbf5ffe
iluwatar added a commit that referenced this issue Aug 19, 2017
@iluwatar
#590 Fix PMD issue
5db6776
iluwatar added a commit that referenced this issue Aug 31, 2017
@iluwatar
#590 Add explanation for Composite pattern
f28ed7b
iluwatar added a commit that referenced this issue Sep 2, 2017
@iluwatar
#590 Add explanation to Decorator pattern
9d2f0c6
guihualiang added a commit to guihualiang/java-design-patterns that referenced this issue Sep 5, 2017
@guihualiang
Revert "iluwatar#590 Kramdown fixes"
2fc4536 
This reverts commit fba30e5.
iluwatar added a commit that referenced this issue Sep 5, 2017
@iluwatar
#590 Add explanation for Facade pattern
bd4247e
iluwatar added a commit that referenced this issue Sep 6, 2017
@iluwatar
#590 Add explanation for Flyweight
c136618
iluwatar added a commit that referenced this issue Sep 13, 2017
@iluwatar
#590 Add explanation for Proxy pattern
2e90f82
iluwatar added a commit that referenced this issue Sep 19, 2017
@iluwatar
#590 Add explanation for Chain of Responsibility
eb36033
@iluwatar
Copy link
Owner Author

iluwatar commented Oct 8, 2022

Excellent, go ahead @murphShaw @SammanPali @murphShaw @annieS987

@u7281975
Copy link
Contributor

u7281975 commented Oct 9, 2022

@iluwatar Hello, can I be assigned the data-bus design pattern?

@iluwatar
Copy link
Owner Author

iluwatar commented Oct 9, 2022

Ok @u7281975

@steph88ss
Copy link
Contributor

@iluwatar Hi, can I be assigned the reader-writer-lock pattern?

@XianWu99
Copy link
Contributor

@iluwatar Hi, can I be assigned to the data-mapper design pattern?

@iluwatar
Copy link
Owner Author

Github doesn't allow me to add any more assignees, but consider yourselves hired @steph88ss and @XianWu99

@SammanPali SammanPali mentioned this issue Oct 17, 2022
Merged
@q1xiangchen q1xiangchen mentioned this issue Oct 17, 2022
Merged
@annieS987 annieS987 mentioned this issue Oct 18, 2022
Closed
@shubhig226
Copy link

I want to help in this issue

@iluwatar
Copy link
Owner Author

@shubhig226 please mention the pattern you'd like to work on

JanFidor added a commit to JanFidor/java-design-patterns that referenced this issue Oct 19, 2022
@JanFidor
iluwatar#590 explanation for a delegation pattern
09db9f1
@steph88ss steph88ss mentioned this issue Oct 20, 2022
Merged
@u7281975 u7281975 mentioned this issue Oct 25, 2022
Merged
@ManviGoel26
Copy link
Contributor

@iluwatar Can I please work on Producer-Consumer?

@iluwatar
Copy link
Owner Author

Sure, go ahead @ManviGoel26

@ManviGoel26 ManviGoel26 mentioned this issue Oct 26, 2022
Merged
iluwatar pushed a commit that referenced this issue Oct 26, 2022
@JanFidor
docs: #590 explanation for a delegation pattern (#2127)
0a04da1
@iluwatar
Copy link
Owner Author

I have split up this issue into multiple independent ones e.g. "Explanation for Bridge". If you are working on some explanation, please comment on the new issue and I'll assign it to you. I'll close this task now.

iluwatar pushed a commit that referenced this issue Oct 30, 2022
@u7281975
docs: Add Explanation for Data-Bus Design Pattern #590 (#2170)
6660330 
* Update README.md

* Update README.md

* Add Explanation

* Update README.md

* Update README.md

* Update README.md

* Update README.md
@murphShaw murphShaw mentioned this issue Nov 2, 2022
Merged
robertvolkmann pushed a commit to robertvolkmann/java-design-patterns that referenced this issue Nov 6, 2022
@JanFidor @robertvolkmann
docs: iluwatar#590 explanation for a delegation pattern (iluwatar#2127)
c62bdf0
robertvolkmann pushed a commit to robertvolkmann/java-design-patterns that referenced this issue Nov 6, 2022
@u7281975 @robertvolkmann
docs: Add Explanation for Data-Bus Design Pattern iluwatar#590 (iluwa…
5e385d9 
…tar#2170)

* Update README.md

* Update README.md

* Add Explanation

* Update README.md

* Update README.md

* Update README.md

* Update README.md
robertvolkmann added a commit to robertvolkmann/java-design-patterns that referenced this issue Nov 6, 2022
@robertvolkmann
Revert "docs: Add Explanation for Data-Bus Design Pattern iluwatar#590 (
326b71b 
iluwatar#2170)"

This reverts commit 5e385d9.
robertvolkmann added a commit to robertvolkmann/java-design-patterns that referenced this issue Nov 6, 2022
@robertvolkmann
Revert "docs: iluwatar#590 explanation for a delegation pattern (iluw…
8ceb926 
…atar#2127)"

This reverts commit c62bdf0.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@iluwatar iluwatar

@AJESH-CR AJESH-CR

@ManviGoel26 ManviGoel26

@JanFidor JanFidor

@q1xiangchen q1xiangchen

@annieS987 annieS987

@QihaMarz QihaMarz

@SammanPali SammanPali

@steph88ss steph88ss

@u7281975 u7281975

Labels
epic: design epic: pattern epic: web site info: good first issue info: help wanted info: needs splitting type: enhancement
Projects
Java Design Patterns project
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Explanations and grammar fixes for all the GoF patterns iluwatar/java-design-patterns