From fd85a2f848f02ac103efd670ef4c62774533e1a1 Mon Sep 17 00:00:00 2001 From: Ilkka Seppala Date: Mon, 17 Aug 2015 23:06:44 +0300 Subject: [PATCH] #107 JavaDoc improvements for Abstract Factory example --- .../com/iluwatar/abstractfactory/App.java | 66 +++++++++++-------- .../com/iluwatar/abstractfactory/Army.java | 15 +++-- .../com/iluwatar/abstractfactory/Castle.java | 15 +++-- .../com/iluwatar/abstractfactory/ElfArmy.java | 25 ++++--- .../iluwatar/abstractfactory/ElfCastle.java | 25 ++++--- .../com/iluwatar/abstractfactory/ElfKing.java | 25 ++++--- .../abstractfactory/ElfKingdomFactory.java | 44 ++++++------- .../com/iluwatar/abstractfactory/King.java | 15 +++-- .../abstractfactory/KingdomFactory.java | 32 ++++----- .../com/iluwatar/abstractfactory/OrcArmy.java | 25 ++++--- .../iluwatar/abstractfactory/OrcCastle.java | 25 ++++--- .../com/iluwatar/abstractfactory/OrcKing.java | 25 ++++--- .../abstractfactory/OrcKingdomFactory.java | 44 ++++++------- 13 files changed, 217 insertions(+), 164 deletions(-) diff --git a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/App.java b/abstract-factory/src/main/java/com/iluwatar/abstractfactory/App.java index 3f77a521c..d18f1abed 100644 --- a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/App.java +++ b/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}). + *

+ * 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); + } +} diff --git a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/Army.java b/abstract-factory/src/main/java/com/iluwatar/abstractfactory/Army.java index 39e023e3b..225331517 100644 --- a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/Army.java +++ b/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 { + +} diff --git a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/Castle.java b/abstract-factory/src/main/java/com/iluwatar/abstractfactory/Castle.java index 277daea56..272a97bf3 100644 --- a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/Castle.java +++ b/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 { + +} diff --git a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfArmy.java b/abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfArmy.java index 473106222..d77fe8ebd 100644 --- a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfArmy.java +++ b/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!"; + } + +} diff --git a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfCastle.java b/abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfCastle.java index 851baf84f..5c2b2a62a 100644 --- a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfCastle.java +++ b/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!"; + } + +} diff --git a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfKing.java b/abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfKing.java index eafaccf49..df475a354 100644 --- a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfKing.java +++ b/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!"; + } + +} diff --git a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfKingdomFactory.java b/abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfKingdomFactory.java index eb4b99685..0d62fa5f2 100644 --- a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfKingdomFactory.java +++ b/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(); + } + +} diff --git a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/King.java b/abstract-factory/src/main/java/com/iluwatar/abstractfactory/King.java index 12a9c1f13..0b75dbb0a 100644 --- a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/King.java +++ b/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 { + +} diff --git a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/KingdomFactory.java b/abstract-factory/src/main/java/com/iluwatar/abstractfactory/KingdomFactory.java index e5b4b4050..00bcd1755 100644 --- a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/KingdomFactory.java +++ b/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(); + +} diff --git a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcArmy.java b/abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcArmy.java index b0e202d51..d331252dc 100644 --- a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcArmy.java +++ b/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!"; + } + +} diff --git a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcCastle.java b/abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcCastle.java index 785884a59..fd09d9c17 100644 --- a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcCastle.java +++ b/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!"; + } + +} diff --git a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcKing.java b/abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcKing.java index 27ea8afd4..5bae8f31b 100644 --- a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcKing.java +++ b/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!"; + } + +} diff --git a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcKingdomFactory.java b/abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcKingdomFactory.java index 2f2a2a54d..4fdea6656 100644 --- a/abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcKingdomFactory.java +++ b/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(); + } + +}