Commented flyweight example.

iluwatar · iluwatar · commit 05cb40897b89 · 2014-08-31T10:16:48.000+03:00
diff --git a/flyweight/src/main/java/com/iluwatar/AlchemistShop.java b/flyweight/src/main/java/com/iluwatar/AlchemistShop.java
@@ -3,6 +3,11 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * 
+ * The class that needs many objects.
+ *
+ */
 public class AlchemistShop {
 
 	List<Potion> topShelf;
diff --git a/flyweight/src/main/java/com/iluwatar/App.java b/flyweight/src/main/java/com/iluwatar/App.java
@@ -1,5 +1,12 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Flyweight (PotionFactory) is useful when there is plethora of
+ * objects (Potion). It provides means to decrease resource usage
+ * by sharing object instances.
+ *
+ */
 public class App 
 {
     public static void main( String[] args )
diff --git a/flyweight/src/main/java/com/iluwatar/Potion.java b/flyweight/src/main/java/com/iluwatar/Potion.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Interface for objects.
+ *
+ */
 public interface Potion {
 
 	public void drink();
diff --git a/flyweight/src/main/java/com/iluwatar/PotionFactory.java b/flyweight/src/main/java/com/iluwatar/PotionFactory.java
@@ -2,6 +2,11 @@
 
 import java.util.EnumMap;
 
+/**
+ * 
+ * Flyweight.
+ *
+ */
 public class PotionFactory {
 
 	private EnumMap<PotionType, Potion> potions;
