From 27a27594f4a6b1b56e513eff705d4cc1d17eb90d Mon Sep 17 00:00:00 2001 From: Ilkka Seppala Date: Thu, 8 Jan 2015 20:30:10 +0200 Subject: [PATCH] Improved comments for state pattern. --- state/src/main/java/com/iluwatar/AngryState.java | 5 +++++ state/src/main/java/com/iluwatar/App.java | 4 +++- state/src/main/java/com/iluwatar/PeacefulState.java | 5 +++++ 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/state/src/main/java/com/iluwatar/AngryState.java b/state/src/main/java/com/iluwatar/AngryState.java index 43e0e15ca..14cc8848a 100644 --- a/state/src/main/java/com/iluwatar/AngryState.java +++ b/state/src/main/java/com/iluwatar/AngryState.java @@ -1,5 +1,10 @@ package com.iluwatar; +/** + * + * Angry state. + * + */ public class AngryState implements State { private Mammoth mammoth; diff --git a/state/src/main/java/com/iluwatar/App.java b/state/src/main/java/com/iluwatar/App.java index b6795fd60..e7077cecf 100644 --- a/state/src/main/java/com/iluwatar/App.java +++ b/state/src/main/java/com/iluwatar/App.java @@ -2,10 +2,12 @@ package com.iluwatar; /** * - * In State pattern the object (Mammoth) has internal state object (State) that + * In State pattern the container object (Mammoth) has an internal state object (State) that * defines the current behavior. The state object can be changed to alter the * behavior. * + * In this example the mammoth changes its behavior as time passes by. + * */ public class App { diff --git a/state/src/main/java/com/iluwatar/PeacefulState.java b/state/src/main/java/com/iluwatar/PeacefulState.java index fff986562..efea33d2a 100644 --- a/state/src/main/java/com/iluwatar/PeacefulState.java +++ b/state/src/main/java/com/iluwatar/PeacefulState.java @@ -1,5 +1,10 @@ package com.iluwatar; +/** + * + * Peaceful state. + * + */ public class PeacefulState implements State { private Mammoth mammoth;