Compare commits

..

27 Commits

Author SHA1 Message Date
6c7715ace6 docs: update .all-contributorsrc [skip ci] 2020-08-18 16:42:03 +00:00
ef43af3b23 docs: update README.md [skip ci] 2020-08-18 16:42:02 +00:00
95e513b6ec Edit readme 2020-08-17 19:49:00 +03:00
194040543e Merge pull request #1493 from ohbus/master
updated workflows
2020-08-17 19:18:39 +03:00
846a174ade Merge pull request #1496 from iluwatar/all-contributors/add-ohbus
docs: add ohbus as a contributor
2020-08-17 19:14:47 +03:00
7f60f7be25 docs: update .all-contributorsrc [skip ci] 2020-08-17 16:14:04 +00:00
cfb58191ea docs: update README.md [skip ci] 2020-08-17 16:14:03 +00:00
82bf9fdd61 Merge pull request #1494 from nahteb/fix-typo
Fix typo in README for Observer pattern
2020-08-17 19:13:25 +03:00
be552d0ece Merge pull request #1495 from iluwatar/all-contributors/add-xdvrx1
docs: add xdvrx1 as a contributor
2020-08-17 19:11:05 +03:00
d584404df6 docs: update .all-contributorsrc [skip ci] 2020-08-17 16:10:21 +00:00
353a2d9fcf docs: update README.md [skip ci] 2020-08-17 16:10:20 +00:00
8c5740563d reverted the copyright year back to 2019 2020-08-17 19:12:54 +05:30
89bda692f8 Fix typo in README
The log message in the Orcs class should say orcs instead of hobbits.

This is correct in the code example but wrong in the README.
2020-08-17 07:47:30 +01:00
241f93f3cc updated cache to v2 and removed SQ analysis 2020-08-17 11:28:33 +05:30
79a6af703e updated copyright year to 2020 2020-08-16 12:49:21 +05:30
00d06871f4 updated workflows 2020-08-16 12:42:08 +05:30
7afb065a10 Upgrade urm plugin to latest version 2020-08-15 20:59:11 +03:00
af9f8fe4e1 Merge pull request #1491 from iluwatar/all-contributors/add-xdvrx1
docs: add xdvrx1 as a contributor
2020-08-15 20:54:25 +03:00
a1c96ede13 docs: update .all-contributorsrc [skip ci] 2020-08-15 17:53:38 +00:00
0d2c4abe5a docs: update README.md [skip ci] 2020-08-15 17:53:37 +00:00
e7e3ace01f Merge pull request #1489 from iluwatar/all-contributors/add-RayYH
docs: add RayYH as a contributor
2020-08-11 17:30:33 +03:00
41dacc2e2e docs: update .all-contributorsrc [skip ci] 2020-08-11 14:29:45 +00:00
dc7bf6190d docs: update README.md [skip ci] 2020-08-11 14:29:44 +00:00
98d2dc0104 Merge pull request #1487 from RayYH/master
fix word typo
2020-08-11 17:29:06 +03:00
870d44b127 Fix layout 2020-08-11 17:26:05 +03:00
834f20911b Merge pull request #1488 from iluwatar/all-contributors/add-ashishtrivedi16
docs: add ashishtrivedi16 as a contributor
2020-08-11 17:23:22 +03:00
b91bbc773d fix word typo 2020-08-11 14:19:39 +08:00
9 changed files with 144 additions and 30 deletions

View File

@ -1102,6 +1102,43 @@
"contributions": [
"code"
]
},
{
"login": "RayYH",
"name": "洪月阳",
"avatar_url": "https://avatars1.githubusercontent.com/u/41055099?v=4",
"profile": "https://rayyounghong.com",
"contributions": [
"code"
]
},
{
"login": "xdvrx1",
"name": "xdvrx1",
"avatar_url": "https://avatars0.githubusercontent.com/u/47092464?v=4",
"profile": "https://xdvrx1.github.io/",
"contributions": [
"review",
"ideas"
]
},
{
"login": "ohbus",
"name": "Subhrodip Mohanta",
"avatar_url": "https://avatars0.githubusercontent.com/u/13291222?v=4",
"profile": "http://subho.xyz",
"contributions": [
"code"
]
},
{
"login": "nahteb",
"name": "Bethan Palmer",
"avatar_url": "https://avatars3.githubusercontent.com/u/13121570?v=4",
"profile": "https://github.com/nahteb",
"contributions": [
"code"
]
}
],
"contributorsPerLine": 4,

View File

@ -24,13 +24,11 @@
# This workflow will build a Java project with Maven
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
name: Java CI with Maven
name: Java CI
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
jobs:
build:
@ -43,6 +41,12 @@ jobs:
uses: actions/setup-java@v1
with:
java-version: 11
- uses: actions/cache@v2
with:
path: ~/.m2/repository
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
restore-keys: |
${{ runner.os }}-maven-
# Some tests need screen access
- name: Install xvfb
run: sudo apt-get install xvfb

57
.github/workflows/maven-pr-builder.yml vendored Normal file
View File

@ -0,0 +1,57 @@
#
# The MIT License
# Copyright © 2014-2019 Ilkka Seppälä
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# This workflow will build a Java project with Maven
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
name: Java PR Builder
on:
pull_request:
branches: [ master ]
jobs:
build:
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@v2
- name: Set up JDK 11
uses: actions/setup-java@v1
with:
java-version: 11
- uses: actions/cache@v2
with:
path: ~/.m2/repository
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
restore-keys: |
${{ runner.os }}-maven-
# Some tests need screen access
- name: Install xvfb
run: sudo apt-get install xvfb
# SonarQube scan does not work for forked repositories
# See https://jira.sonarsource.com/browse/MMF-1371
- name: Build with Maven
if: github.ref != 'refs/heads/master'
run: xvfb-run mvn clean verify

View File

@ -9,7 +9,7 @@
[![Join the chat at https://gitter.im/iluwatar/java-design-patterns](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/iluwatar/java-design-patterns?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Sonarcloud Status](https://sonarcloud.io/api/project_badges/measure?project=iluwatar_java-design-patterns&metric=alert_status)](https://sonarcloud.io/dashboard?id=iluwatar_java-design-patterns)
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-121-orange.svg?style=flat-square)](#contributors-)
[![All Contributors](https://img.shields.io/badge/all_contributors-125-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
# Introduction
@ -250,6 +250,12 @@ This project is licensed under the terms of the MIT license.
</tr>
<tr>
<td align="center"><a href="https://www.linkedin.com/in/ashish-trivedi-218379135/"><img src="https://avatars3.githubusercontent.com/u/23194128?v=4" width="100px;" alt=""/><br /><sub><b>Ashish Trivedi</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=ashishtrivedi16" title="Code">💻</a></td>
<td align="center"><a href="https://rayyounghong.com"><img src="https://avatars1.githubusercontent.com/u/41055099?v=4" width="100px;" alt=""/><br /><sub><b>洪月阳</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=RayYH" title="Code">💻</a></td>
<td align="center"><a href="https://xdvrx1.github.io/"><img src="https://avatars0.githubusercontent.com/u/47092464?v=4" width="100px;" alt=""/><br /><sub><b>xdvrx1</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/pulls?q=is%3Apr+reviewed-by%3Axdvrx1" title="Reviewed Pull Requests">👀</a> <a href="#ideas-xdvrx1" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="http://subho.xyz"><img src="https://avatars0.githubusercontent.com/u/13291222?v=4" width="100px;" alt=""/><br /><sub><b>Subhrodip Mohanta</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=ohbus" title="Code">💻</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/nahteb"><img src="https://avatars3.githubusercontent.com/u/13121570?v=4" width="100px;" alt=""/><br /><sub><b>Bethan Palmer</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=nahteb" title="Code">💻</a></td>
</tr>
</table>

View File

@ -46,7 +46,7 @@ public class Orcs implements WeatherObserver {
@Override
public void update(WeatherType currentWeather) {
LOGGER.info("The hobbits are facing " + currentWeather.getDescription() + " weather now");
LOGGER.info("The orcs are facing " + currentWeather.getDescription() + " weather now");
}
}

View File

@ -53,7 +53,7 @@
<jaxb-impl.version>2.3.2</jaxb-impl.version>
<annotation-api.version>1.3.2</annotation-api.version>
<system-rules.version>1.19.0</system-rules.version>
<urm.version>1.4.8</urm.version>
<urm.version>2.0.0</urm.version>
<!-- SonarCloud -->
<sonar.host.url>https://sonarcloud.io</sonar.host.url>
<sonar.organization>iluwatar</sonar.organization>

View File

@ -45,7 +45,7 @@ public final class InitializingOnDemandHolderIdiom {
}
/**
* Sigleton instance.
* Singleton instance.
*
* @return Singleton instance
*/

View File

@ -16,10 +16,12 @@ request from the presentation.
## Explanation
Real world example
> You need to create a hotel room booking system. Since the requirements are quite simple we intend
> to use the Transaction Script pattern here.
In plain words
> Transaction Script organizes business logic into transactions that the system needs to carry out.
Programmatic example
@ -80,15 +82,9 @@ The `Hotel` class has two methods, one for booking and cancelling a room respect
them handles a single transaction in the system, making `Hotel` implement the Transaction Script
pattern.
```
public void bookRoom(int roomNumber);
```
The `bookRoom` method consolidates all the needed steps like checking if the room is already booked
or not, if not booked then books the room and updates the database by using the DAO.
```
public void cancelRoomBooking(int roomNumber)
```
The `cancelRoom` method consolidates steps like checking if the room is booked or not,
if booked then calculates the refund amount and updates the database using the DAO.

View File

@ -9,13 +9,17 @@ tags:
---
## Intent
Represent an operation to be performed on the elements of an object structure. Visitor lets you define a new operation without changing the classes of the elements on which it operates.
Represent an operation to be performed on the elements of an object structure. Visitor lets you
define a new operation without changing the classes of the elements on which it operates.
## Explanation
Real world example
> Consider a tree structure with army units. Commander has two sergeants under it and each sergeant has three soldiers under them. Given that the hierarchy implements the visitor pattern, we can easily create new objects that interact with the commander, sergeants, soldiers or all of them.
> Consider a tree structure with army units. Commander has two sergeants under it and each sergeant
> has three soldiers under them. Given that the hierarchy implements the visitor pattern, we can
> easily create new objects that interact with the commander, sergeants, soldiers or all of them.
In plain words
@ -23,7 +27,10 @@ In plain words
Wikipedia says
> In object-oriented programming and software engineering, the visitor design pattern is a way of separating an algorithm from an object structure on which it operates. A practical result of this separation is the ability to add new operations to existing object structures without modifying the structures.
> In object-oriented programming and software engineering, the visitor design pattern is a way of
> separating an algorithm from an object structure on which it operates. A practical result of this
> separation is the ability to add new operations to existing object structures without modifying
> the structures.
**Programmatic Example**
@ -111,7 +118,7 @@ public class Soldier extends Unit {
}
```
And then some concrete visitors.
Here are then some concrete visitors.
```java
public class CommanderVisitor implements UnitVisitor {
@ -175,32 +182,39 @@ public class SoldierVisitor implements UnitVisitor {
}
```
Finally we can show the power of visitors in action.
Finally, we can show the power of visitors in action.
```java
commander.accept(new SoldierVisitor());
// Greetings soldier
// Greetings soldier
// Greetings soldier
// Greetings soldier
// Greetings soldier
// Greetings soldier
commander.accept(new SergeantVisitor());
// Hello sergeant
// Hello sergeant
commander.accept(new CommanderVisitor());
// Good to see you commander
```
Program output:
```
Greetings soldier
Greetings soldier
Greetings soldier
Greetings soldier
Greetings soldier
Greetings soldier
Hello sergeant
Hello sergeant
Good to see you commander
```
## Class diagram
![alt text](./etc/visitor_1.png "Visitor")
## Applicability
Use the Visitor pattern when
* An object structure contains many classes of objects with differing interfaces, and you want to perform operations on these objects that depend on their concrete classes
* Many distinct and unrelated operations need to be performed on objects in an object structure, and you want to avoid "polluting" their classes with these operations. Visitor lets you keep related operations together by defining them in one class. When the object structure is shared by many applications, use Visitor to put operations in just those applications that need them
* The classes defining the object structure rarely change, but you often want to define new operations over the structure. Changing the object structure classes requires redefining the interface to all visitors, which is potentially costly. If the object structure classes change often, then it's probably better to define the operations in those classes
* An object structure contains many classes of objects with differing interfaces, and you want to perform operations on these objects that depend on their concrete classes.
* Many distinct and unrelated operations need to be performed on objects in an object structure, and you want to avoid "polluting" their classes with these operations. Visitor lets you keep related operations together by defining them in one class. When the object structure is shared by many applications, use Visitor to put operations in just those applications that need them.
* The classes defining the object structure rarely change, but you often want to define new operations over the structure. Changing the object structure classes requires redefining the interface to all visitors, which is potentially costly. If the object structure classes change often, then it's probably better to define the operations in those classes.
## Real world examples