Spring/spring-statemachine
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document spring javaconfig usage for beans

Browse Source 
- Fixes #162
- Relates to #185
This commit is contained in:
Janne Valkealahti
2016-03-19 16:27:16 +00:00
parent fe6ca757e9
commit 9641afeeb4
3 changed files with 111 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/src/info/changelog.txt
View File

@@ -8,6 +8,7 @@ Changes in version 1.1.0.M2 (2016-03-21)
----------------------------------------
* Better config error handling [#103]
* Support testing intermediate state changes [#154]
* Document spring javaconfig usage for beans [#162]
* Listener error should not cause malfunction [#164]
* Timer interval reset for states [#165]
* Make config data classes as a public api [#172]

28
docs/src/reference/asciidoc/sm.adoc
View File

@@ -346,6 +346,34 @@ include::samples/DocsConfigurationSampleTests.java[tags=snippetYC]
More about config model, refer to section <<devdocs-configmodel>>.
[[statemachine-config-thingstoremember]]
=== Things to Remember
When defining actions, guards or any other references from a
configuration there are things to remember how Spring Framework works
with beans. In below we have defined a normal configuration with
states `S1` and `S2` and 4 transitions between those. All transitions
are either guarded by `guard1` or `guard2`. Pay attention that
`guard1` is created as a real bean because it's annotated with a
_@Bean_, while `guard2` is not.
What this mean is that event `E3` would get `guard2` condition as
`TRUE` and `E4` would get `guard2` condition as `FALSE` as those are
simply coming from a plain method calls to those functions.
However because `guard1` is defined as a _@Bean_, it is proxied by a
Spring Framework, thus additional calls to its method will result
only one instantiation of that instance. Event `E1` would get first
proxied instance with condition `TRUE` while event `E2` would get same
instance with `TRUE` condition while method call was defined with
`FALSE`. This is not a Spring State Machine specific behaviour, it's
just how Spring Framework works with _Beans_.
[source,java,indent=0]
----
include::samples/DocsConfigurationSampleTests7.java[tags=snippetA]
----
[[sm-factories]]
== State Machine Factories
There are use cases when state machine needs to be created dynamically