Pattern: Factory Method

Author: harlem88

README.md

@@ -5,3 +5,4 @@
 * Creational Patterns
 	* Abstract Factory
 	* Builder
+	* Factory Method

src/linuxMain/kotlin/org/dronix/kotlin/designpatterns/Main.kt

@@ -2,15 +2,19 @@ package org.dronix.kotlin.designpatterns
 
 import org.dronix.kotlin.designpatterns.base.Maze
 import org.dronix.kotlin.designpatterns.creational.abstractFactory.BombedMazeFactory
+import org.dronix.kotlin.designpatterns.creational.abstractFactory.EnchantedMazeFactory
 import org.dronix.kotlin.designpatterns.creational.builder.CountingMazeBuilder
 import org.dronix.kotlin.designpatterns.creational.builder.StandardMazeBuilder
+import org.dronix.kotlin.designpatterns.creational.factoryMethod.BombedMazeGame
+import org.dronix.kotlin.designpatterns.creational.factoryMethod.EnchantedMazeGame
 
 fun hello(): String = "Hello, Kotlin/Native Design Patterns!"
 
 fun main(args: Array<String>) {
 
     val mazeBombed   = createBombedMaze()
     val mazeStandard = createStandardMaze()
+    val enchantedMaze= createEnchantedMaze()
     val countingMaze = createCountingMaze()
 
     println(hello())
@@ -19,23 +23,28 @@ fun main(args: Array<String>) {
 fun createBombedMaze(): Maze{
 
     val bombedMazeFactory = BombedMazeFactory()
-    val mazeGame = MazeGame()
+    val mazeGame = MazeGameCreator()
 
-    return mazeGame.createMaze(bombedMazeFactory)
+    return mazeGame.createMazeWithAbstractFactory(bombedMazeFactory)
 }
 
 fun createStandardMaze(): Maze{
     val standardMazeBuilder = StandardMazeBuilder()
-    val mazeGame = MazeGame()
+    val mazeGame = MazeGameCreator()
 
-    return mazeGame.createMaze(standardMazeBuilder)
+    return mazeGame.createMazeWithBuilder(standardMazeBuilder)
+}
+
+fun createEnchantedMaze(): Maze{
+    val enchantedMaze = EnchantedMazeGame()
+    return enchantedMaze.createMaze()
 }
 
 fun createCountingMaze(): Maze{
     val countingMazeBuilder = CountingMazeBuilder()
-    val mazeGame = MazeGame()
+    val mazeGame = MazeGameCreator()
 
-    val maze = mazeGame.createMaze(countingMazeBuilder)
+    val maze = mazeGame.createMazeWithBuilder(countingMazeBuilder)
     val (rooms, doors)= countingMazeBuilder.getCounts()
     println("Maze rooms: $rooms doors: $doors")
     return maze

src/linuxMain/kotlin/org/dronix/kotlin/designpatterns/MazeGame.kt renamed to src/linuxMain/kotlin/org/dronix/kotlin/designpatterns/MazeGameCreator.kt

@@ -7,7 +7,7 @@ import org.dronix.kotlin.designpatterns.base.wall.Wall
 import org.dronix.kotlin.designpatterns.creational.abstractFactory.MazeFactory
 import org.dronix.kotlin.designpatterns.creational.builder.MazeBuilder
 
-class MazeGame {
+class MazeGameCreator {
     fun createMaze(): Maze {
         val aMaze = Maze()
         val room1 = Room(1)
@@ -26,11 +26,11 @@ class MazeGame {
         room2.setSide(Direction.East, Wall())
         room2.setSide(Direction.South, Wall())
         room2.setSide(Direction.West, theDoor)
-        return aMaze
 
+        return aMaze
     }
 
-    fun createMaze(mazeFactory: MazeFactory): Maze{
+    fun createMazeWithAbstractFactory(mazeFactory: MazeFactory): Maze{
 
         val aMaze = mazeFactory.makeMaze()
         val room1 = mazeFactory.makeRoom(1)
@@ -49,10 +49,11 @@ class MazeGame {
         room2.setSide(Direction.East, mazeFactory.makeWall())
         room2.setSide(Direction.South, mazeFactory.makeWall())
         room2.setSide(Direction.West, theDoor)
+
         return aMaze
     }
 
-    fun createMaze(mazeBuilder: MazeBuilder): Maze {
+    fun createMazeWithBuilder(mazeBuilder: MazeBuilder): Maze {
         return mazeBuilder
             .buildMaze()
             .buildRoom(1)

src/linuxMain/kotlin/org/dronix/kotlin/designpatterns/creational/factoryMethod/BombedMazeGame.kt

@@ -0,0 +1,17 @@
+package org.dronix.kotlin.designpatterns.creational.factoryMethod
+
+import org.dronix.kotlin.designpatterns.base.room.BombRoom
+import org.dronix.kotlin.designpatterns.base.room.Room
+import org.dronix.kotlin.designpatterns.base.wall.BombedWall
+import org.dronix.kotlin.designpatterns.base.wall.Wall
+
+class BombedMazeGame : MazeGame() {
+
+    override fun makeWall(): Wall {
+        return BombedWall()
+    }
+
+    override fun makeRoom(roomNumber: Int): Room {
+        return BombRoom(roomNumber)
+    }
+}

src/linuxMain/kotlin/org/dronix/kotlin/designpatterns/creational/factoryMethod/EnchantedMazeGame.kt

@@ -0,0 +1,18 @@
+package org.dronix.kotlin.designpatterns.creational.factoryMethod
+
+import org.dronix.kotlin.designpatterns.base.CastSpell
+import org.dronix.kotlin.designpatterns.base.door.Door
+import org.dronix.kotlin.designpatterns.base.door.DoorNeedingSpell
+import org.dronix.kotlin.designpatterns.base.room.EnchantedRoom
+import org.dronix.kotlin.designpatterns.base.room.Room
+
+class EnchantedMazeGame : MazeGame() {
+
+    override fun makeRoom(roomNumber: Int): Room {
+        return EnchantedRoom(roomNumber, CastSpell())
+    }
+
+    override fun makeDoor(room1: Room, room2: Room): Door {
+        return DoorNeedingSpell(room1, room2)
+    }
+}

src/linuxMain/kotlin/org/dronix/kotlin/designpatterns/creational/factoryMethod/MazeGame.kt

@@ -0,0 +1,49 @@
+package org.dronix.kotlin.designpatterns.creational.factoryMethod
+
+import org.dronix.kotlin.designpatterns.base.Direction
+import org.dronix.kotlin.designpatterns.base.Maze
+import org.dronix.kotlin.designpatterns.base.door.Door
+import org.dronix.kotlin.designpatterns.base.room.Room
+import org.dronix.kotlin.designpatterns.base.wall.Wall
+
+open class MazeGame {
+
+    open fun makeMaze(): Maze {
+        return Maze()
+    }
+
+    open fun makeWall(): Wall {
+        return Wall()
+    }
+
+    open fun makeRoom(roomNumber: Int): Room {
+        return Room(roomNumber)
+    }
+
+    open fun makeDoor(room1: Room, room2: Room): Door {
+        return Door(room1, room2)
+    }
+
+    fun createMaze(): Maze {
+
+        val aMaze = makeMaze()
+        val room1 = makeRoom(1)
+        val room2 = makeRoom(2)
+        val theDoor = makeDoor(room1, room2)
+
+        aMaze.addRoom(room1)
+        aMaze.addRoom(room2)
+
+        room1.setSide(Direction.North, makeWall())
+        room1.setSide(Direction.East, theDoor)
+        room1.setSide(Direction.South, makeWall())
+        room1.setSide(Direction.West, makeWall())
+
+        room2.setSide(Direction.North, makeWall())
+        room2.setSide(Direction.East, makeWall())
+        room2.setSide(Direction.South, makeWall())
+        room2.setSide(Direction.West, theDoor)
+
+        return aMaze
+    }
+}