1- ## Java Design Patterns
1+ # Java Design Patterns
22
33[ ![ Maven CI] ( https://github.com/gazbert/java-design-patterns/actions/workflows/maven.yml/badge.svg?branch=master )] ( https://github.com/gazbert/java-design-patterns/actions/workflows/maven.yml )
44
@@ -8,14 +8,12 @@ A cookbook of commonly used Java design patterns based on examples from:
88* "Head First Design Patterns" - Freeman et al
99* "Java Design Pattern Essentials" - Tony Brevis
1010
11- I'll be adding new patterns to the project on an ad-hoc basis.
12- 13- Each pattern is contained in its own package - the package-info will provide more details and the Test class
11+ Each pattern is contained in its own package. The Javadoc will provide more details and the Test class
1412will demonstrate how to use it.
1513
1614Any comments/bugs/better ways of doing things, send 'em my way.
1715
18- ### Behavioural Patterns
16+ ## Behavioural Patterns
1917
20181 . State
21191 . Chain of Responsibility
@@ -25,16 +23,27 @@ Any comments/bugs/better ways of doing things, send 'em my way.
25231 . Template Method
26241 . Visitor
2725
28- ### Creational Patterns
26+ ## Creational Patterns
2927
30281 . Builder
31291 . Factory Method
32301 . Static Factory Method / Simple Factory Method
33311 . Abstract Factory
34321 . Singleton
3533
36- ### Structural Patterns
34+ ## Structural Patterns
3735
38361 . Adapter
39371 . Decorator
40381 . Facade
39+ 40+ # Build Guide
41+ You'll need JDK 11+ installed on your dev box.
42+ 43+ You can use the included Maven wrapper to build the project and pull down the dependencies:
44+ 45+ ``` bash
46+ ./mvnw clean install
47+ ```
48+ 49+ The Javadoc can be found in the ` <project-root>/target/apidocs ` folder after you execute the build.
0 commit comments