#107 JavaDoc improvements and minor fixes to Bridge example

bridge/etc/bridge.ucls

@@ -1,18 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <class-diagram version="1.1.8" icons="true" automaticImage="PNG" always-add-relationships="false" generalizations="true" 
   realizations="true" associations="true" dependencies="false" nesting-relationships="true">  
-  <class id="1" language="java" name="com.iluwatar.bridge.FlyingMagicWeaponImp" project="bridge" 
+  <class id="1" language="java" name="com.iluwatar.bridge.FlyingMagicWeaponImpl" project="bridge" 
-    file="/bridge/src/main/java/com/iluwatar/bridge/FlyingMagicWeaponImp.java" binary="false" corner="BOTTOM_RIGHT">    
+    file="/bridge/src/main/java/com/iluwatar/bridge/FlyingMagicWeaponImpl.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="105" width="192" x="193" y="297"/>    
+    <position height="-1" width="-1" x="515" y="591"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
       <operations public="true" package="true" protected="true" private="true" static="true"/>    
     </display>  
   </class>  
-  <class id="2" language="java" name="com.iluwatar.bridge.SoulEatingMagicWeaponImp" project="bridge" 
+  <class id="2" language="java" name="com.iluwatar.bridge.SoulEatingMagicWeaponImpl" project="bridge" 
-    file="/bridge/src/main/java/com/iluwatar/bridge/SoulEatingMagicWeaponImp.java" binary="false" corner="BOTTOM_RIGHT">    
+    file="/bridge/src/main/java/com/iluwatar/bridge/SoulEatingMagicWeaponImpl.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="105" width="226" x="425" y="297"/>    
+    <position height="-1" width="-1" x="791" y="605"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -21,25 +21,25 @@
   </class>  
   <class id="3" language="java" name="com.iluwatar.bridge.Stormbringer" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/Stormbringer.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="160" width="125" x="425" y="442"/>    
+    <position height="-1" width="-1" x="791" y="788"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
       <operations public="true" package="true" protected="true" private="true" static="true"/>    
     </display>  
   </class>  
-  <class id="4" language="java" name="com.iluwatar.bridge.MagicWeaponImp" project="bridge" 
+  <class id="4" language="java" name="com.iluwatar.bridge.MagicWeaponImpl" project="bridge" 
-    file="/bridge/src/main/java/com/iluwatar/bridge/MagicWeaponImp.java" binary="false" corner="BOTTOM_RIGHT">    
+    file="/bridge/src/main/java/com/iluwatar/bridge/MagicWeaponImpl.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="141" width="149" x="221" y="79"/>    
+    <position height="-1" width="-1" x="791" y="433"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
       <operations public="true" package="true" protected="true" private="true" static="true"/>    
     </display>  
   </class>  
-  <class id="5" language="java" name="com.iluwatar.bridge.BlindingMagicWeaponImp" project="bridge" 
+  <class id="5" language="java" name="com.iluwatar.bridge.BlindingMagicWeaponImpl" project="bridge" 
-    file="/bridge/src/main/java/com/iluwatar/bridge/BlindingMagicWeaponImp.java" binary="false" corner="BOTTOM_RIGHT">    
+    file="/bridge/src/main/java/com/iluwatar/bridge/BlindingMagicWeaponImpl.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="105" width="208" x="691" y="297"/>    
+    <position height="-1" width="-1" x="1105" y="593"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -48,7 +48,7 @@
   </class>  
   <class id="6" language="java" name="com.iluwatar.bridge.SoulEatingMagicWeapon" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/SoulEatingMagicWeapon.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="178" width="347" x="410" y="79"/>    
+    <position height="-1" width="-1" x="380" y="21"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -57,7 +57,7 @@
   </class>  
   <class id="7" language="java" name="com.iluwatar.bridge.Excalibur" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/Excalibur.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="160" width="124" x="691" y="442"/>    
+    <position height="-1" width="-1" x="1105" y="782"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -66,7 +66,7 @@
   </class>  
   <class id="8" language="java" name="com.iluwatar.bridge.Mjollnir" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/Mjollnir.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="160" width="124" x="193" y="442"/>    
+    <position height="-1" width="-1" x="515" y="788"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -75,7 +75,7 @@
   </class>  
   <class id="9" language="java" name="com.iluwatar.bridge.BlindingMagicWeapon" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/BlindingMagicWeapon.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="178" width="313" x="797" y="79"/>    
+    <position height="-1" width="-1" x="791" y="14"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -84,7 +84,7 @@
   </class>  
   <class id="10" language="java" name="com.iluwatar.bridge.MagicWeapon" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/MagicWeapon.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="159" width="221" x="644" y="-120"/>    
+    <position height="-1" width="-1" x="791" y="237"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -93,7 +93,7 @@
   </class>  
   <class id="11" language="java" name="com.iluwatar.bridge.FlyingMagicWeapon" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/FlyingMagicWeapon.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="178" width="291" x="1150" y="79"/>    
+    <position height="-1" width="-1" x="1144" y="12"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -101,48 +101,52 @@
     </display>  
   </class>  
   <generalization id="12">    
-    <end type="SOURCE" refId="11"/>    
+    <end type="SOURCE" refId="8"/>    
-    <end type="TARGET" refId="10"/>  
+    <end type="TARGET" refId="1"/>  
   </generalization>  
   <generalization id="13">    
     <end type="SOURCE" refId="1"/>    
     <end type="TARGET" refId="4"/>  
   </generalization>  
   <generalization id="14">    
-    <end type="SOURCE" refId="2"/>    
-    <end type="TARGET" refId="4"/>  
-  </generalization>  
-  <generalization id="15">    
-    <end type="SOURCE" refId="7"/>    
-    <end type="TARGET" refId="5"/>  
-  </generalization>  
-  <generalization id="16">    
-    <end type="SOURCE" refId="6"/>    
-    <end type="TARGET" refId="10"/>  
-  </generalization>  
-  <generalization id="17">    
     <end type="SOURCE" refId="9"/>    
     <end type="TARGET" refId="10"/>  
   </generalization>  
-  <generalization id="18">    
+  <generalization id="15">    
-    <end type="SOURCE" refId="3"/>    
+    <end type="SOURCE" refId="2"/>    
-    <end type="TARGET" refId="2"/>  
+    <end type="TARGET" refId="4"/>  
   </generalization>  
-  <association id="19">    
+  <association id="16">    
     <end type="SOURCE" refId="10" navigable="false">      
-      <attribute id="20" name="imp"/>      
+      <attribute id="17" name="imp">        
-      <multiplicity id="21" minimum="0" maximum="1"/>    
+        <position height="0" width="0" x="478" y="284"/>      
+      </attribute>      
+      <multiplicity id="18" minimum="0" maximum="1">        
+        <position height="0" width="0" x="478" y="284"/>      
+      </multiplicity>    
     </end>    
     <end type="TARGET" refId="4" navigable="true"/>    
     <display labels="true" multiplicity="true"/>  
   </association>  
-  <generalization id="22">    
+  <generalization id="19">    
     <end type="SOURCE" refId="5"/>    
     <end type="TARGET" refId="4"/>  
   </generalization>  
+  <generalization id="20">    
+    <end type="SOURCE" refId="6"/>    
+    <end type="TARGET" refId="10"/>  
+  </generalization>  
+  <generalization id="21">    
+    <end type="SOURCE" refId="7"/>    
+    <end type="TARGET" refId="5"/>  
+  </generalization>  
+  <generalization id="22">    
+    <end type="SOURCE" refId="3"/>    
+    <end type="TARGET" refId="2"/>  
+  </generalization>  
   <generalization id="23">    
-    <end type="SOURCE" refId="8"/>    
+    <end type="SOURCE" refId="11"/>    
-    <end type="TARGET" refId="1"/>  
+    <end type="TARGET" refId="10"/>  
   </generalization>  
   <classifier-display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
     sort-features="false" accessors="true" visibility="true">    

bridge/index.md

@@ -11,7 +11,7 @@ tags: pattern_tag
 vary independently.
 
 
-![alt text](./etc/bridge_1.png "Bridge")
+![alt text](./etc/bridge.png "Bridge")
 
 **Applicability:** Use the Bridge pattern when
 

bridge/src/main/java/com/iluwatar/bridge/App.java

@@ -2,13 +2,17 @@ package com.iluwatar.bridge;
 
 /**
  * 
- * In Bridge pattern both abstraction (MagicWeapon) and implementation
+ * In Bridge pattern both abstraction ({@link MagicWeapon}) and implementation
- * (MagicWeaponImp) have their own class hierarchies. The interface of the
+ * ({@link MagicWeaponImpl}) have their own class hierarchies. The interface of the
  * implementations can be changed without affecting the clients.
  * 
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 		BlindingMagicWeapon blindingMagicWeapon = new BlindingMagicWeapon(
 				new Excalibur());

bridge/src/main/java/com/iluwatar/bridge/BlindingMagicWeapon.java

@@ -1,14 +1,19 @@
 package com.iluwatar.bridge;
 
+/**
+ * 
+ * BlindingMagicWeapon
+ *
+ */
 public class BlindingMagicWeapon extends MagicWeapon {
 
-	public BlindingMagicWeapon(BlindingMagicWeaponImp imp) {
+	public BlindingMagicWeapon(BlindingMagicWeaponImpl imp) {
 		super(imp);
 	}
 
 	@Override
-	public BlindingMagicWeaponImp getImp() {
+	public BlindingMagicWeaponImpl getImp() {
-		return (BlindingMagicWeaponImp) imp;
+		return (BlindingMagicWeaponImpl) imp;
 	}
 
 	@Override

bridge/src/main/java/com/iluwatar/bridge/BlindingMagicWeaponImp.java

@@ -1,7 +0,0 @@
-package com.iluwatar.bridge;
-
-public abstract class BlindingMagicWeaponImp extends MagicWeaponImp {
-
-	public abstract void blindImp();
-
-}

bridge/src/main/java/com/iluwatar/bridge/BlindingMagicWeaponImpl.java

@@ -0,0 +1,12 @@
+package com.iluwatar.bridge;
+
+/**
+ * 
+ * BlindingMagicWeaponImpl
+ *
+ */
+public abstract class BlindingMagicWeaponImpl extends MagicWeaponImpl {
+
+	public abstract void blindImp();
+
+}

bridge/src/main/java/com/iluwatar/bridge/Excalibur.java

@@ -1,6 +1,11 @@
 package com.iluwatar.bridge;
 
-public class Excalibur extends BlindingMagicWeaponImp {
+/**
+ * 
+ * Excalibur
+ *
+ */
+public class Excalibur extends BlindingMagicWeaponImpl {
 
 	@Override
 	public void wieldImp() {

bridge/src/main/java/com/iluwatar/bridge/FlyingMagicWeapon.java

@@ -1,13 +1,18 @@
 package com.iluwatar.bridge;
 
+/**
+ * 
+ * FlyingMagicWeapon
+ *
+ */
 public class FlyingMagicWeapon extends MagicWeapon {
 
-	public FlyingMagicWeapon(FlyingMagicWeaponImp imp) {
+	public FlyingMagicWeapon(FlyingMagicWeaponImpl imp) {
 		super(imp);
 	}
 
-	public FlyingMagicWeaponImp getImp() {
+	public FlyingMagicWeaponImpl getImp() {
-		return (FlyingMagicWeaponImp) imp;
+		return (FlyingMagicWeaponImpl) imp;
 	}
 
 	@Override

bridge/src/main/java/com/iluwatar/bridge/FlyingMagicWeaponImp.java

@@ -1,7 +0,0 @@
-package com.iluwatar.bridge;
-
-public abstract class FlyingMagicWeaponImp extends MagicWeaponImp {
-
-	public abstract void flyImp();
-
-}

bridge/src/main/java/com/iluwatar/bridge/FlyingMagicWeaponImpl.java

@@ -0,0 +1,12 @@
+package com.iluwatar.bridge;
+
+/**
+ * 
+ * FlyingMagicWeaponImpl
+ *
+ */
+public abstract class FlyingMagicWeaponImpl extends MagicWeaponImpl {
+
+	public abstract void flyImp();
+
+}

bridge/src/main/java/com/iluwatar/bridge/MagicWeapon.java

@@ -2,14 +2,14 @@ package com.iluwatar.bridge;
 
 /**
  * 
- * Abstraction interface.
+ * MagicWeapon
  * 
  */
 public abstract class MagicWeapon {
 
-	protected MagicWeaponImp imp;
+	protected MagicWeaponImpl imp;
 
-	public MagicWeapon(MagicWeaponImp imp) {
+	public MagicWeapon(MagicWeaponImpl imp) {
 		this.imp = imp;
 	}
 
@@ -19,7 +19,7 @@ public abstract class MagicWeapon {
 
 	public abstract void unwield();
 
-	public MagicWeaponImp getImp() {
+	public MagicWeaponImpl getImp() {
 		return imp;
 	}
 

bridge/src/main/java/com/iluwatar/bridge/MagicWeaponImpl.java

@@ -2,10 +2,10 @@ package com.iluwatar.bridge;
 
 /**
  * 
- * Implementation interface.
+ * MagicWeaponImpl
  * 
  */
-public abstract class MagicWeaponImp {
+public abstract class MagicWeaponImpl {
 
 	public abstract void wieldImp();
 

bridge/src/main/java/com/iluwatar/bridge/Mjollnir.java

@@ -1,6 +1,11 @@
 package com.iluwatar.bridge;
 
-public class Mjollnir extends FlyingMagicWeaponImp {
+/**
+ * 
+ * Mjollnir
+ *
+ */
+public class Mjollnir extends FlyingMagicWeaponImpl {
 
 	@Override
 	public void wieldImp() {

bridge/src/main/java/com/iluwatar/bridge/SoulEatingMagicWeapon.java

@@ -1,14 +1,19 @@
 package com.iluwatar.bridge;
 
+/**
+ * 
+ * SoulEatingMagicWeapon
+ *
+ */
 public class SoulEatingMagicWeapon extends MagicWeapon {
 
-	public SoulEatingMagicWeapon(SoulEatingMagicWeaponImp imp) {
+	public SoulEatingMagicWeapon(SoulEatingMagicWeaponImpl imp) {
 		super(imp);
 	}
 
 	@Override
-	public SoulEatingMagicWeaponImp getImp() {
+	public SoulEatingMagicWeaponImpl getImp() {
-		return (SoulEatingMagicWeaponImp) imp;
+		return (SoulEatingMagicWeaponImpl) imp;
 	}
 
 	@Override

bridge/src/main/java/com/iluwatar/bridge/SoulEatingMagicWeaponImp.java

@@ -1,7 +0,0 @@
-package com.iluwatar.bridge;
-
-public abstract class SoulEatingMagicWeaponImp extends MagicWeaponImp {
-
-	public abstract void eatSoulImp();
-
-}

bridge/src/main/java/com/iluwatar/bridge/SoulEatingMagicWeaponImpl.java

@@ -0,0 +1,12 @@
+package com.iluwatar.bridge;
+
+/**
+ * 
+ * SoulEatingMagicWeaponImpl
+ *
+ */
+public abstract class SoulEatingMagicWeaponImpl extends MagicWeaponImpl {
+
+	public abstract void eatSoulImp();
+
+}

bridge/src/main/java/com/iluwatar/bridge/Stormbringer.java

@@ -1,6 +1,11 @@
 package com.iluwatar.bridge;
 
-public class Stormbringer extends SoulEatingMagicWeaponImp {
+/**
+ * 
+ * Stormbringer
+ *
+ */
+public class Stormbringer extends SoulEatingMagicWeaponImpl {
 
 	@Override
 	public void wieldImp() {