From 5b5f9b7f69b88c2da12d77be0e1a633f298ff8f2 Mon Sep 17 00:00:00 2001
From: Janne Valkealahti <janne.valkealahti@gmail.com>
Date: Sat, 12 Mar 2016 16:43:26 +0000
Subject: [PATCH] Update docs

- Add new `timerOnce` related docs.
- Relates to #185
---
 docs/src/reference/asciidoc/sm.adoc           | 37 ++++++++++++++++---
 .../docs/DocsConfigurationSampleTests2.java   | 19 +++++++---
 2 files changed, 45 insertions(+), 11 deletions(-)

diff --git a/docs/src/reference/asciidoc/sm.adoc b/docs/src/reference/asciidoc/sm.adoc
index 4b63950b..2681d80c 100644
--- a/docs/src/reference/asciidoc/sm.adoc
+++ b/docs/src/reference/asciidoc/sm.adoc
@@ -703,21 +703,48 @@ _TimerTrigger_ is useful when something needs to be triggered
 automatically without any user interaction. `Trigger` is added to a
 transition by associating a timer with it during a configuration.
 
+Currently there are two types of timers supported, one which fires
+continously and one which fires once a source state is entered.
+
 [source,java,indent=0]
 ----
 include::samples/DocsConfigurationSampleTests2.java[tags=snippetA]
 ----
 
-In above we have two states, `S1` and `S2`. We have a normal external
-transition from `S1` to `S2` with event `E1` but interesting part is
-when we define internal transition with source state `S2` and
-associate it with `Action` bean `timerAction` and `timer` value of
-`1000ms`. Once a state machine receive event `E1` it does a transition
+In above we have three states, `S1`, `S2` and `S3`. We have a normal
+external transition from `S1` to `S2` and from `S1` to `S3` with
+events `E1` and `E2` respectively. Interesting parts are when we define
+internal transitions for source states `S2` and `S3`.
+
+For both transitions we associate `Action` bean `timerAction` where
+source state `S2` will use `timer` and `S3` will use `timerOnce`.
+Values given are with milliseconds which in these cases mean `1000ms`.
+
+Once a state machine receive event `E1` it does a transition
 from `S1` to `S2` and timer kicks in. As long as state is kept in `S2`
 `TimerTrigger` executes and causes a transition associated with that
 state which in this case is the internal transition which has the
 `timerAction` defined.
 
+Once a state machine receive event `E2` it does a transition
+from `S1` to `S3` and timer kicks in. This timer is executed only once
+after state is entered after a delay defined in a timer.
+
+[NOTE]
+====
+Behind a scenes timers are a simple triggers which may cause an
+transition to happen. Defining a transition with a `timer()` will keep
+firing triggers and only causes transition if source state is active.
+Transtition with `timerOnce()` is a little different as it will only
+trigger after a delay when source state is actually entered.
+====
+
+[TIP]
+====
+Use `timerOnce()` if you want something to happen after a delay
+exactly once when state is entered.
+====
+
 [[sm-listeners]]
 == Listening State Machine Events
 There are use cases where you just want to know what is happening with
diff --git a/spring-statemachine-core/src/test/java/org/springframework/statemachine/docs/DocsConfigurationSampleTests2.java b/spring-statemachine-core/src/test/java/org/springframework/statemachine/docs/DocsConfigurationSampleTests2.java
index 37dfbdf4..c812729d 100644
--- a/spring-statemachine-core/src/test/java/org/springframework/statemachine/docs/DocsConfigurationSampleTests2.java
+++ b/spring-statemachine-core/src/test/java/org/springframework/statemachine/docs/DocsConfigurationSampleTests2.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015 the original author or authors.
+ * Copyright 2015-2016 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -72,7 +72,8 @@ public class DocsConfigurationSampleTests2 extends AbstractStateMachineTests {
 			states
 				.withStates()
 					.initial("S1")
-					.state("S2");
+					.state("S2")
+					.state("S3");
 		}
 
 		@Override
@@ -80,14 +81,20 @@ public class DocsConfigurationSampleTests2 extends AbstractStateMachineTests {
 				throws Exception {
 			transitions
 				.withExternal()
-					.source("S1")
-					.target("S2")
-					.event("E1")
+					.source("S1").target("S2").event("E1")
+					.and()
+				.withExternal()
+					.source("S1").target("S3").event("E2")
 					.and()
 				.withInternal()
 					.source("S2")
 					.action(timerAction())
-					.timer(1000);
+					.timer(1000)
+					.and()
+				.withInternal()
+					.source("S3")
+					.action(timerAction())
+					.timerOnce(1000);
 		}
 
 		@Bean