diff --git a/memento/src/main/java/com/iluwatar/App.java b/memento/src/main/java/com/iluwatar/App.java index 7ee027c2d..c98bc320d 100644 --- a/memento/src/main/java/com/iluwatar/App.java +++ b/memento/src/main/java/com/iluwatar/App.java @@ -2,6 +2,15 @@ package com.iluwatar; import java.util.Stack; +/** + * + * Memento pattern is for storing and restoring object + * state. The object (Star) gives out a "memento" + * (StarMemento) that contains the state of the object. + * Later on the memento can be set back to the object + * restoring the state. + * + */ public class App { public static void main( String[] args ) diff --git a/memento/src/main/java/com/iluwatar/Star.java b/memento/src/main/java/com/iluwatar/Star.java index 90c1028fd..03a5ad305 100644 --- a/memento/src/main/java/com/iluwatar/Star.java +++ b/memento/src/main/java/com/iluwatar/Star.java @@ -1,5 +1,10 @@ package com.iluwatar; +/** + * + * Star uses "mementos" to store and restore state. + * + */ public class Star { private StarType type; diff --git a/memento/src/main/java/com/iluwatar/StarMemento.java b/memento/src/main/java/com/iluwatar/StarMemento.java index cc7238d12..9d2806ac2 100644 --- a/memento/src/main/java/com/iluwatar/StarMemento.java +++ b/memento/src/main/java/com/iluwatar/StarMemento.java @@ -1,5 +1,10 @@ package com.iluwatar; +/** + * + * External interface to memento. + * + */ public interface StarMemento { } diff --git a/memento/src/main/java/com/iluwatar/StarMementoInternal.java b/memento/src/main/java/com/iluwatar/StarMementoInternal.java index dd0e2c343..45c8f7c11 100644 --- a/memento/src/main/java/com/iluwatar/StarMementoInternal.java +++ b/memento/src/main/java/com/iluwatar/StarMementoInternal.java @@ -1,5 +1,10 @@ package com.iluwatar; +/** + * + * Internal interface to memento. + * + */ public class StarMementoInternal implements StarMemento { private StarType type;