Skip to content

Commit 71f61cd

Browse files
nikhilbararnikhilbarar
committed
iluwatar#466, iluwatar#509: Added diagrams and Readme files
1 parent d54e290 commit 71f61cd

File tree

6 files changed

+282
-0
lines changed

6 files changed

+282
-0
lines changed

‎component-object/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: pattern
3+
title: Component Object
4+
folder: component-object
5+
permalink: /patterns/component-object/
6+
categories: Testing
7+
tags:
8+
- Java
9+
- Difficulty-Intermediate
10+
---
11+
12+
## Intent
13+
Web development is shifting more and more towards reusable components. Frameworks like React, Polymer, Angular etc. provide various component friendly abstractions to make front-end code-bases more maintainable. So our web applications are now full of “widgets” that have same behavior. We can use component various times on single web page or re-use it on various web pages. Therefore it is logical to create abstraction which covers functionality of single component and reuse it across end-to-end tests.
14+
15+
![alt text](./etc/component-object.png "Component Object Pattern")
16+
17+
## Applicability
18+
Use the Component Object Pattern in the following situations:
19+
20+
* When you have various same components on single web page and you need to test the web page
21+
* When you have multiple web pages using same component abstractions and you need to test the web pages
22+
23+
## Credits
24+
25+
* [Component Object](https://lkrnac.net/blog/2016/10/component-object-pattern-example/)

‎component-object/etc/component-object.png

27.3 KB
Loading

‎component-object/etc/component-object.ucls

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<class-diagram version="1.2.2" icons="true" automaticImage="PNG" always-add-relationships="false" generalizations="true"
3+
realizations="true" associations="true" dependencies="false" nesting-relationships="true" router="FAN">
4+
<class id="1" language="java" name="com.iluwatar.component.AddItemComponent" project="component-object"
5+
file="/component-object/src/test/java/com/iluwatar/component/AddItemComponent.java" binary="false"
6+
corner="BOTTOM_RIGHT">
7+
<position height="-1" width="-1" x="162" y="206"/>
8+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
9+
sort-features="false" accessors="true" visibility="true">
10+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
11+
<operations public="true" package="true" protected="true" private="true" static="true"/>
12+
</display>
13+
</class>
14+
<class id="2" language="java" name="com.iluwatar.component.ItemsListComponent" project="component-object"
15+
file="/component-object/src/test/java/com/iluwatar/component/ItemsListComponent.java" binary="false"
16+
corner="BOTTOM_RIGHT">
17+
<position height="-1" width="-1" x="995" y="195"/>
18+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
19+
sort-features="false" accessors="true" visibility="true">
20+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
21+
<operations public="true" package="true" protected="true" private="true" static="true"/>
22+
</display>
23+
</class>
24+
<class id="3" language="java" name="com.iluwatar.component.TodoPageObject" project="component-object"
25+
file="/component-object/src/test/java/com/iluwatar/component/TodoPageObject.java" binary="false"
26+
corner="BOTTOM_RIGHT">
27+
<position height="-1" width="-1" x="555" y="198"/>
28+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
29+
sort-features="false" accessors="true" visibility="true">
30+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
31+
<operations public="true" package="true" protected="true" private="true" static="true"/>
32+
</display>
33+
</class>
34+
<association id="4">
35+
<end type="SOURCE" refId="3" navigable="false">
36+
<attribute id="5" name="addTodoItemComponent"/>
37+
<multiplicity id="6" minimum="0" maximum="1"/>
38+
</end>
39+
<end type="TARGET" refId="1" navigable="true"/>
40+
<display labels="true" multiplicity="true"/>
41+
</association>
42+
<association id="7">
43+
<end type="SOURCE" refId="3" navigable="false">
44+
<attribute id="8" name="groceryItemsList"/>
45+
<multiplicity id="9" minimum="0" maximum="1"/>
46+
</end>
47+
<end type="TARGET" refId="2" navigable="true"/>
48+
<display labels="true" multiplicity="true"/>
49+
</association>
50+
<association id="10">
51+
<end type="SOURCE" refId="3" navigable="false">
52+
<attribute id="11" name="todoItemsList"/>
53+
<multiplicity id="12" minimum="0" maximum="1"/>
54+
</end>
55+
<end type="TARGET" refId="2" navigable="true"/>
56+
<display labels="true" multiplicity="true"/>
57+
</association>
58+
<association id="13">
59+
<end type="SOURCE" refId="3" navigable="false">
60+
<attribute id="14" name="addGroceryItemComponent"/>
61+
<multiplicity id="15" minimum="0" maximum="1"/>
62+
</end>
63+
<end type="TARGET" refId="1" navigable="true"/>
64+
<display labels="true" multiplicity="true"/>
65+
</association>
66+
<classifier-display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
67+
sort-features="false" accessors="true" visibility="true">
68+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
69+
<operations public="true" package="true" protected="true" private="true" static="true"/>
70+
</classifier-display>
71+
<association-display labels="true" multiplicity="true"/>
72+
</class-diagram>

‎monitor-object/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
layout: pattern
3+
title: Monitor Object
4+
folder: monitor-object
5+
permalink: /patterns/monitor-object/
6+
categories: Concurrency
7+
tags:
8+
- Java
9+
- Difficulty-Intermediate
10+
---
11+
12+
## Intent
13+
In 1974, Tony Hoare proposed the concept of monitors for designing and reasoning about objects that are shared between multiple threads. The key property of these "Hoare-style" monitors is that threads can wait until some specific assertion about the monitor's state is true and be guaranteed that it is still true after the thread has been awakened. The purpose of the Monitor Object is to provide an implementation of Hoare-style monitors for thread communication in a Java-based monitor package that automates assertion checking during execution. This approach reduces redundant coding and automates assertions checking during execution.
14+
15+
![alt text](./etc/monitor-object.png "Monitor Object Pattern")
16+
17+
## Applicability
18+
Use the Monitor Object Pattern for thread signaling (over Java's wait() and notify() approach) in the following situations:
19+
20+
* When you need Defensive programming in multithreaded code - The monitor package provides support for defensive programming through the invariant() method and the assertion objects associated with each condition object. Java's notify() and wait() provide no assertion checking
21+
* When you need objects to wait on multiple wait queues - The monitor package provides condition objects, each providing its own wait queue. Threads waiting for different assertions to become true wait on different queues. Using wait(), there is only one wait queue per object.
22+
* When you need seamless passing of occupancy - In the monitor package, control is passed seamlessly from the signaling thread to an awaiting thread. You can be sure that, after returning from an await(), the assertion the thread has waited for is true. In contrast, the notify() and notifyAll() methods simply move a waiting thread back to the entry queue for the monitor.
23+
24+
## Credits
25+
26+
* [Theodore S. Norvell - Monitor Object](https://www.javaworld.com/article/2077769/core-java/better-monitors-for-java.html)
27+
* [Monitor (syncronization)](https://en.wikipedia.org/wiki/Monitor_(synchronization))

‎monitor-object/etc/monitor-object.png

78.6 KB
Loading

‎monitor-object/etc/monitor-object.ucls

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<class-diagram version="1.2.2" icons="true" automaticImage="PNG" always-add-relationships="false" generalizations="true"
3+
realizations="true" associations="true" dependencies="false" nesting-relationships="true" router="FAN">
4+
<class id="1" language="java" name="com.iluwatar.monitor.AbstractMonitor" project="monitor-object"
5+
file="/monitor-object/src/main/java/com/iluwatar/monitor/AbstractMonitor.java" binary="false" corner="BOTTOM_RIGHT">
6+
<position height="567" width="287" x="20" y="-114"/>
7+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
8+
sort-features="false" accessors="true" visibility="true">
9+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
10+
<operations public="true" package="true" protected="true" private="true" static="true"/>
11+
</display>
12+
</class>
13+
<class id="2" language="java" name="com.iluwatar.monitor.Condition" project="monitor-object"
14+
file="/monitor-object/src/main/java/com/iluwatar/monitor/Condition.java" binary="false" corner="BOTTOM_RIGHT">
15+
<position height="-1" width="-1" x="839" y="263"/>
16+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
17+
sort-features="false" accessors="true" visibility="true">
18+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
19+
<operations public="true" package="true" protected="true" private="true" static="true"/>
20+
</display>
21+
</class>
22+
<class id="3" language="java" name="com.iluwatar.monitor.Assertion" project="monitor-object"
23+
file="/monitor-object/src/main/java/com/iluwatar/monitor/Assertion.java" binary="false" corner="BOTTOM_RIGHT">
24+
<position height="-1" width="-1" x="824" y="669"/>
25+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
26+
sort-features="false" accessors="true" visibility="true">
27+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
28+
<operations public="true" package="true" protected="true" private="true" static="true"/>
29+
</display>
30+
</class>
31+
<class id="4" language="java" name="com.iluwatar.monitor.Monitor" project="monitor-object"
32+
file="/monitor-object/src/main/java/com/iluwatar/monitor/Monitor.java" binary="false" corner="BOTTOM_RIGHT">
33+
<position height="-1" width="-1" x="155" y="668"/>
34+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
35+
sort-features="false" accessors="true" visibility="true">
36+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
37+
<operations public="true" package="true" protected="true" private="true" static="true"/>
38+
</display>
39+
</class>
40+
<interface id="5" language="java" name="com.iluwatar.monitor.MonitorListener" project="monitor-object"
41+
file="/monitor-object/src/main/java/com/iluwatar/monitor/MonitorListener.java" binary="false" corner="BOTTOM_RIGHT">
42+
<position height="-1" width="-1" x="674" y="-108"/>
43+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
44+
sort-features="false" accessors="true" visibility="true">
45+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
46+
<operations public="true" package="true" protected="true" private="true" static="true"/>
47+
</display>
48+
</interface>
49+
<class id="6" language="java" name="com.iluwatar.monitor.Semaphore" project="monitor-object"
50+
file="/monitor-object/src/main/java/com/iluwatar/monitor/Semaphore.java" binary="false" corner="BOTTOM_RIGHT">
51+
<position height="-1" width="-1" x="488" y="350"/>
52+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
53+
sort-features="false" accessors="true" visibility="true">
54+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
55+
<operations public="true" package="true" protected="true" private="true" static="true"/>
56+
</display>
57+
</class>
58+
<class id="7" language="java" name="com.iluwatar.monitor.Semaphore.QueueElement" project="monitor-object"
59+
file="/monitor-object/src/main/java/com/iluwatar/monitor/Semaphore.java" binary="false" corner="BOTTOM_RIGHT">
60+
<position height="-1" width="-1" x="488" y="571"/>
61+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
62+
sort-features="false" accessors="true" visibility="true">
63+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
64+
<operations public="true" package="true" protected="true" private="true" static="true"/>
65+
</display>
66+
</class>
67+
<class id="8" language="java" name="com.iluwatar.monitor.TrueAssertion" project="monitor-object"
68+
file="/monitor-object/src/main/java/com/iluwatar/monitor/TrueAssertion.java" binary="false" corner="BOTTOM_RIGHT">
69+
<position height="-1" width="-1" x="1063" y="670"/>
70+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
71+
sort-features="false" accessors="true" visibility="true">
72+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
73+
<operations public="true" package="true" protected="true" private="true" static="true"/>
74+
</display>
75+
</class>
76+
<association id="9">
77+
<end type="SOURCE" refId="4" navigable="false">
78+
<attribute id="10" name="invariant"/>
79+
<multiplicity id="11" minimum="0" maximum="1"/>
80+
</end>
81+
<end type="TARGET" refId="3" navigable="true"/>
82+
<display labels="true" multiplicity="true"/>
83+
</association>
84+
<association id="12">
85+
<end type="SOURCE" refId="2" navigable="false">
86+
<attribute id="13" name="homeMonitor"/>
87+
<multiplicity id="14" minimum="0" maximum="1"/>
88+
</end>
89+
<end type="TARGET" refId="1" navigable="true"/>
90+
<display labels="true" multiplicity="true"/>
91+
</association>
92+
<association id="15">
93+
<end type="SOURCE" refId="8" navigable="false">
94+
<attribute id="16" name="SINGLETON"/>
95+
<multiplicity id="17" minimum="0" maximum="1"/>
96+
</end>
97+
<end type="TARGET" refId="8" navigable="true"/>
98+
<display labels="true" multiplicity="true"/>
99+
</association>
100+
<association id="18">
101+
<end type="SOURCE" refId="1" navigable="false">
102+
<attribute id="19" name="entrance"/>
103+
<multiplicity id="20" minimum="0" maximum="1"/>
104+
</end>
105+
<end type="TARGET" refId="6" navigable="true"/>
106+
<display labels="true" multiplicity="true"/>
107+
</association>
108+
<generalization id="21">
109+
<end type="SOURCE" refId="4"/>
110+
<end type="TARGET" refId="1"/>
111+
</generalization>
112+
<nesting id="22">
113+
<end type="SOURCE" refId="6"/>
114+
<end type="TARGET" refId="7"/>
115+
</nesting>
116+
<association id="23">
117+
<end type="SOURCE" refId="6" navigable="false">
118+
<attribute id="24" name="queue"/>
119+
<multiplicity id="25" minimum="0" maximum="2147483647"/>
120+
</end>
121+
<end type="TARGET" refId="7" navigable="true"/>
122+
<display labels="true" multiplicity="true"/>
123+
</association>
124+
<association id="26">
125+
<end type="SOURCE" refId="2" navigable="false">
126+
<attribute id="27" name="queue"/>
127+
<multiplicity id="28" minimum="0" maximum="1"/>
128+
</end>
129+
<end type="TARGET" refId="6" navigable="true"/>
130+
<display labels="true" multiplicity="true"/>
131+
</association>
132+
<generalization id="29">
133+
<end type="SOURCE" refId="8"/>
134+
<end type="TARGET" refId="3"/>
135+
</generalization>
136+
<association id="30">
137+
<end type="SOURCE" refId="2" navigable="false">
138+
<attribute id="31" name="assertion"/>
139+
<multiplicity id="32" minimum="0" maximum="1"/>
140+
</end>
141+
<end type="TARGET" refId="3" navigable="true"/>
142+
<display labels="true" multiplicity="true"/>
143+
</association>
144+
<association id="33">
145+
<end type="SOURCE" refId="1" navigable="false">
146+
<attribute id="34" name="listOfListeners"/>
147+
<multiplicity id="35" minimum="0" maximum="2147483647"/>
148+
</end>
149+
<end type="TARGET" refId="5" navigable="true"/>
150+
<display labels="true" multiplicity="true"/>
151+
</association>
152+
<classifier-display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
153+
sort-features="false" accessors="true" visibility="true">
154+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
155+
<operations public="true" package="true" protected="true" private="true" static="true"/>
156+
</classifier-display>
157+
<association-display labels="true" multiplicity="true"/>
158+
</class-diagram>

0 commit comments

Comments
 (0)