From 5aead88e5e211ebaf19865227843c45c4feedf4c Mon Sep 17 00:00:00 2001 From: Ilkka Seppala Date: Sun, 31 Aug 2014 00:15:47 +0300 Subject: [PATCH] Added comments for Abstract Factory example. --- abstract-factory/src/main/java/com/iluwatar/App.java | 9 +++++++++ .../src/main/java/com/iluwatar/ElfKingdomFactory.java | 5 +++++ .../src/main/java/com/iluwatar/KingdomFactory.java | 5 +++++ .../src/main/java/com/iluwatar/OrcKingdomFactory.java | 5 +++++ 4 files changed, 24 insertions(+) diff --git a/abstract-factory/src/main/java/com/iluwatar/App.java b/abstract-factory/src/main/java/com/iluwatar/App.java index de3f1a145..bb6b083ad 100644 --- a/abstract-factory/src/main/java/com/iluwatar/App.java +++ b/abstract-factory/src/main/java/com/iluwatar/App.java @@ -1,5 +1,14 @@ package com.iluwatar; +/** + * + * 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 ) diff --git a/abstract-factory/src/main/java/com/iluwatar/ElfKingdomFactory.java b/abstract-factory/src/main/java/com/iluwatar/ElfKingdomFactory.java index 1bcd0a2d5..715e8123c 100644 --- a/abstract-factory/src/main/java/com/iluwatar/ElfKingdomFactory.java +++ b/abstract-factory/src/main/java/com/iluwatar/ElfKingdomFactory.java @@ -1,5 +1,10 @@ package com.iluwatar; +/** + * + * Concrete factory. + * + */ public class ElfKingdomFactory implements KingdomFactory { public Castle createCastle() { diff --git a/abstract-factory/src/main/java/com/iluwatar/KingdomFactory.java b/abstract-factory/src/main/java/com/iluwatar/KingdomFactory.java index db3f9f869..d1818b62e 100644 --- a/abstract-factory/src/main/java/com/iluwatar/KingdomFactory.java +++ b/abstract-factory/src/main/java/com/iluwatar/KingdomFactory.java @@ -1,5 +1,10 @@ package com.iluwatar; +/** + * + * The factory interface. + * + */ public interface KingdomFactory { Castle createCastle(); diff --git a/abstract-factory/src/main/java/com/iluwatar/OrcKingdomFactory.java b/abstract-factory/src/main/java/com/iluwatar/OrcKingdomFactory.java index 161f001a2..1a0d6d713 100644 --- a/abstract-factory/src/main/java/com/iluwatar/OrcKingdomFactory.java +++ b/abstract-factory/src/main/java/com/iluwatar/OrcKingdomFactory.java @@ -1,5 +1,10 @@ package com.iluwatar; +/** + * + * Concrete factory. + * + */ public class OrcKingdomFactory implements KingdomFactory { public Castle createCastle() {