From 742f8376b3114cd613b1ae185ab5a133159aca73 Mon Sep 17 00:00:00 2001
From: Ilkka Seppala <iluwatar@gmail.com>
Date: Wed, 7 Jan 2015 21:19:28 +0200
Subject: [PATCH] Improved comments for mediator example.

---
 mediator/src/main/java/com/iluwatar/Action.java    |  5 +++++
 mediator/src/main/java/com/iluwatar/App.java       |  9 +++++++--
 mediator/src/main/java/com/iluwatar/Hobbit.java    |  5 +++++
 mediator/src/main/java/com/iluwatar/Hunter.java    |  5 +++++
 mediator/src/main/java/com/iluwatar/Party.java     |  2 +-
 mediator/src/main/java/com/iluwatar/PartyImpl.java | 14 +++++---------
 .../main/java/com/iluwatar/PartyMemberBase.java    |  5 +++++
 mediator/src/main/java/com/iluwatar/Rogue.java     |  5 +++++
 mediator/src/main/java/com/iluwatar/Wizard.java    |  5 +++++
 9 files changed, 43 insertions(+), 12 deletions(-)

diff --git a/mediator/src/main/java/com/iluwatar/Action.java b/mediator/src/main/java/com/iluwatar/Action.java
index cbe6f60c9..554466b42 100644
--- a/mediator/src/main/java/com/iluwatar/Action.java
+++ b/mediator/src/main/java/com/iluwatar/Action.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Action enumeration.
+ *
+ */
 public enum Action {
 
 	HUNT, TALE, GOLD, ENEMY;
diff --git a/mediator/src/main/java/com/iluwatar/App.java b/mediator/src/main/java/com/iluwatar/App.java
index e8a4b6d9d..bf8e64f88 100644
--- a/mediator/src/main/java/com/iluwatar/App.java
+++ b/mediator/src/main/java/com/iluwatar/App.java
@@ -2,24 +2,29 @@ package com.iluwatar;
 
 /**
  * 
- * Mediator encapsulates how set of objects (PartyMember) interact. Instead of
- * referring to each other directly they use the mediator (Party) interface.
+ * Mediator encapsulates how a set of objects (PartyMember) interact. Instead of
+ * referring to each other directly they use a mediator (Party) interface.
  * 
  */
 public class App {
 
 	public static void main(String[] args) {
+		
+		// create party and members
 		Party party = new PartyImpl();
 		Hobbit hobbit = new Hobbit();
 		Wizard wizard = new Wizard();
 		Rogue rogue = new Rogue();
 		Hunter hunter = new Hunter();
 
+		// add party members
 		party.addMember(hobbit);
 		party.addMember(wizard);
 		party.addMember(rogue);
 		party.addMember(hunter);
 
+		// perform actions -> the other party members
+		// are notified by the party
 		hobbit.act(Action.ENEMY);
 		wizard.act(Action.TALE);
 		rogue.act(Action.GOLD);
diff --git a/mediator/src/main/java/com/iluwatar/Hobbit.java b/mediator/src/main/java/com/iluwatar/Hobbit.java
index ae8542fad..918c86645 100644
--- a/mediator/src/main/java/com/iluwatar/Hobbit.java
+++ b/mediator/src/main/java/com/iluwatar/Hobbit.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Hobbit party member.
+ *
+ */
 public class Hobbit extends PartyMemberBase {
 
 	@Override
diff --git a/mediator/src/main/java/com/iluwatar/Hunter.java b/mediator/src/main/java/com/iluwatar/Hunter.java
index e27cdf8b9..b6974968c 100644
--- a/mediator/src/main/java/com/iluwatar/Hunter.java
+++ b/mediator/src/main/java/com/iluwatar/Hunter.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Hunter party member.
+ *
+ */
 public class Hunter extends PartyMemberBase {
 
 	@Override
diff --git a/mediator/src/main/java/com/iluwatar/Party.java b/mediator/src/main/java/com/iluwatar/Party.java
index ad3efdafb..24b57e629 100644
--- a/mediator/src/main/java/com/iluwatar/Party.java
+++ b/mediator/src/main/java/com/iluwatar/Party.java
@@ -2,7 +2,7 @@ package com.iluwatar;
 
 /**
  * 
- * Mediator interface.
+ * Party interface.
  * 
  */
 public interface Party {
diff --git a/mediator/src/main/java/com/iluwatar/PartyImpl.java b/mediator/src/main/java/com/iluwatar/PartyImpl.java
index a98364700..70fe24d71 100644
--- a/mediator/src/main/java/com/iluwatar/PartyImpl.java
+++ b/mediator/src/main/java/com/iluwatar/PartyImpl.java
@@ -3,6 +3,11 @@ package com.iluwatar;
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * 
+ * Party implementation.
+ *
+ */
 public class PartyImpl implements Party {
 
 	private List<PartyMember> members;
@@ -25,13 +30,4 @@ public class PartyImpl implements Party {
 		members.add(member);
 		member.joinedParty(this);
 	}
-
-	// somebody hunts for food, call for dinner
-
-	// somebody spots enemy, alert everybody
-
-	// somebody finds gold, deal the gold with everybody
-
-	// somebody tells a tale, call everybody to listen
-
 }
diff --git a/mediator/src/main/java/com/iluwatar/PartyMemberBase.java b/mediator/src/main/java/com/iluwatar/PartyMemberBase.java
index 2dbbb3e49..133792db6 100644
--- a/mediator/src/main/java/com/iluwatar/PartyMemberBase.java
+++ b/mediator/src/main/java/com/iluwatar/PartyMemberBase.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Abstract base class for party members.
+ *
+ */
 public abstract class PartyMemberBase implements PartyMember {
 
 	protected Party party;
diff --git a/mediator/src/main/java/com/iluwatar/Rogue.java b/mediator/src/main/java/com/iluwatar/Rogue.java
index 5990e0523..4d13ec4c1 100644
--- a/mediator/src/main/java/com/iluwatar/Rogue.java
+++ b/mediator/src/main/java/com/iluwatar/Rogue.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Rogue party member.
+ *
+ */
 public class Rogue extends PartyMemberBase {
 
 	@Override
diff --git a/mediator/src/main/java/com/iluwatar/Wizard.java b/mediator/src/main/java/com/iluwatar/Wizard.java
index 689879865..126f31018 100644
--- a/mediator/src/main/java/com/iluwatar/Wizard.java
+++ b/mediator/src/main/java/com/iluwatar/Wizard.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Wizard party member.
+ *
+ */
 public class Wizard extends PartyMemberBase {
 
 	@Override