#107 JavaDoc improvements for Abstract Factory example

abstract-factory/src/main/java/com/iluwatar/abstractfactory/App.java

@@ -1,29 +1,37 @@
-package com.iluwatar.abstractfactory;
-
-/**
- * 
- * The essence of the Abstract Factory pattern is a factory interface
- * (KingdomFactory) and its implementations (ElfKingdomFactory,
- * OrcKingdomFactory).
- * 
- * The example uses both concrete implementations to create a king, a castle and
- * an army.
- * 
- */
-public class App {
-
-	public static void main(String[] args) {
-		createKingdom(new ElfKingdomFactory());
-		createKingdom(new OrcKingdomFactory());
-	}
-
-	public static void createKingdom(KingdomFactory factory) {
-		King king = factory.createKing();
-		Castle castle = factory.createCastle();
-		Army army = factory.createArmy();
-		System.out.println("The kingdom was created.");
-		System.out.println(king);
-		System.out.println(castle);
-		System.out.println(army);
-	}
-}
+package com.iluwatar.abstractfactory;
+
+/**
+ * 
+ * The essence of the Abstract Factory pattern is a factory interface
+ * ({@link KingdomFactory}) and its implementations ({@link ElfKingdomFactory},
+ * {@link OrcKingdomFactory}).
+ * <p>
+ * The example uses both concrete implementations to create a king, a castle and
+ * an army.
+ * 
+ */
+public class App {
+
+	/**
+	 * Program entry point
+	 * @param args command line arguments
+	 */
+	public static void main(String[] args) {
+		createKingdom(new ElfKingdomFactory());
+		createKingdom(new OrcKingdomFactory());
+	}
+
+	/**
+	 * Creates kingdom
+	 * @param factory
+	 */
+	public static void createKingdom(KingdomFactory factory) {
+		King king = factory.createKing();
+		Castle castle = factory.createCastle();
+		Army army = factory.createArmy();
+		System.out.println("The kingdom was created.");
+		System.out.println(king);
+		System.out.println(castle);
+		System.out.println(army);
+	}
+}

abstract-factory/src/main/java/com/iluwatar/abstractfactory/Army.java

@@ -1,5 +1,10 @@
-package com.iluwatar.abstractfactory;
-
-public interface Army {
-
-}
+package com.iluwatar.abstractfactory;
+
+/**
+ * 
+ * Army interface
+ *
+ */
+public interface Army {
+
+}

abstract-factory/src/main/java/com/iluwatar/abstractfactory/Castle.java

@@ -1,5 +1,10 @@
-package com.iluwatar.abstractfactory;
-
-public interface Castle {
-
-}
+package com.iluwatar.abstractfactory;
+
+/**
+ * 
+ * Castle interface
+ *
+ */
+public interface Castle {
+
+}

abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfArmy.java

@@ -1,10 +1,15 @@
-package com.iluwatar.abstractfactory;
-
-public class ElfArmy implements Army {
-
-	@Override
-	public String toString() {
-		return "This is the Elven Army!";
-	}
-
-}
+package com.iluwatar.abstractfactory;
+
+/**
+ * 
+ * ElfArmy
+ *
+ */
+public class ElfArmy implements Army {
+
+	@Override
+	public String toString() {
+		return "This is the Elven Army!";
+	}
+
+}

abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfCastle.java

@@ -1,10 +1,15 @@
-package com.iluwatar.abstractfactory;
-
-public class ElfCastle implements Castle {
-
-	@Override
-	public String toString() {
-		return "This is the Elven castle!";
-	}
-
-}
+package com.iluwatar.abstractfactory;
+
+/**
+ * 
+ * ElfCastle
+ *
+ */
+public class ElfCastle implements Castle {
+
+	@Override
+	public String toString() {
+		return "This is the Elven castle!";
+	}
+
+}

abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfKing.java

@@ -1,10 +1,15 @@
-package com.iluwatar.abstractfactory;
-
-public class ElfKing implements King {
-
-	@Override
-	public String toString() {
-		return "This is the Elven king!";
-	}
-
-}
+package com.iluwatar.abstractfactory;
+
+/**
+ * 
+ * ElfKing
+ *
+ */
+public class ElfKing implements King {
+
+	@Override
+	public String toString() {
+		return "This is the Elven king!";
+	}
+
+}

abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfKingdomFactory.java

@@ -1,22 +1,22 @@
-package com.iluwatar.abstractfactory;
-
-/**
- * 
- * Concrete factory.
- * 
- */
-public class ElfKingdomFactory implements KingdomFactory {
-
-	public Castle createCastle() {
-		return new ElfCastle();
-	}
-
-	public King createKing() {
-		return new ElfKing();
-	}
-
-	public Army createArmy() {
-		return new ElfArmy();
-	}
-
-}
+package com.iluwatar.abstractfactory;
+
+/**
+ * 
+ * ElfKingdomFactory concrete factory.
+ * 
+ */
+public class ElfKingdomFactory implements KingdomFactory {
+
+	public Castle createCastle() {
+		return new ElfCastle();
+	}
+
+	public King createKing() {
+		return new ElfKing();
+	}
+
+	public Army createArmy() {
+		return new ElfArmy();
+	}
+
+}

abstract-factory/src/main/java/com/iluwatar/abstractfactory/King.java

@@ -1,5 +1,10 @@
-package com.iluwatar.abstractfactory;
-
-public interface King {
-
-}
+package com.iluwatar.abstractfactory;
+
+/**
+ * 
+ * King interface
+ *
+ */
+public interface King {
+
+}

abstract-factory/src/main/java/com/iluwatar/abstractfactory/KingdomFactory.java

@@ -1,16 +1,16 @@
-package com.iluwatar.abstractfactory;
-
-/**
- * 
- * The factory interface.
- * 
- */
-public interface KingdomFactory {
-
-	Castle createCastle();
-
-	King createKing();
-
-	Army createArmy();
-
-}
+package com.iluwatar.abstractfactory;
+
+/**
+ * 
+ * KingdomFactory factory interface.
+ * 
+ */
+public interface KingdomFactory {
+
+	Castle createCastle();
+
+	King createKing();
+
+	Army createArmy();
+
+}

abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcArmy.java

@@ -1,10 +1,15 @@
-package com.iluwatar.abstractfactory;
-
-public class OrcArmy implements Army {
-
-	@Override
-	public String toString() {
-		return "This is the Orcish Army!";
-	}
-
-}
+package com.iluwatar.abstractfactory;
+
+/**
+ * 
+ * OrcArmy
+ *
+ */
+public class OrcArmy implements Army {
+
+	@Override
+	public String toString() {
+		return "This is the Orcish Army!";
+	}
+
+}

abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcCastle.java

@@ -1,10 +1,15 @@
-package com.iluwatar.abstractfactory;
-
-public class OrcCastle implements Castle {
-
-	@Override
-	public String toString() {
-		return "This is the Orcish castle!";
-	}
-
-}
+package com.iluwatar.abstractfactory;
+
+/**
+ * 
+ * OrcCastle
+ *
+ */
+public class OrcCastle implements Castle {
+
+	@Override
+	public String toString() {
+		return "This is the Orcish castle!";
+	}
+
+}

abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcKing.java

@@ -1,10 +1,15 @@
-package com.iluwatar.abstractfactory;
-
-public class OrcKing implements King {
-
-	@Override
-	public String toString() {
-		return "This is the Orc king!";
-	}
-
-}
+package com.iluwatar.abstractfactory;
+
+/**
+ * 
+ * OrcKing
+ *
+ */
+public class OrcKing implements King {
+
+	@Override
+	public String toString() {
+		return "This is the Orc king!";
+	}
+
+}

abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcKingdomFactory.java

@@ -1,22 +1,22 @@
-package com.iluwatar.abstractfactory;
-
-/**
- * 
- * Concrete factory.
- * 
- */
-public class OrcKingdomFactory implements KingdomFactory {
-
-	public Castle createCastle() {
-		return new OrcCastle();
-	}
-
-	public King createKing() {
-		return new OrcKing();
-	}
-
-	public Army createArmy() {
-		return new OrcArmy();
-	}
-
-}
+package com.iluwatar.abstractfactory;
+
+/**
+ * 
+ * OrcKingdomFactory concrete factory.
+ * 
+ */
+public class OrcKingdomFactory implements KingdomFactory {
+
+	public Castle createCastle() {
+		return new OrcCastle();
+	}
+
+	public King createKing() {
+		return new OrcKing();
+	}
+
+	public Army createArmy() {
+		return new OrcArmy();
+	}
+
+}