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

Update docs

Browse Source 
- Add more repository config docs.
- Relates to #270
This commit is contained in:
Janne Valkealahti
2016-11-19 19:05:29 +00:00
parent 38e6c9db0a
commit b441bf558f
6 changed files with 144 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/src/reference/asciidoc/images/sm-repository-simplemachine.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.3 KiB

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

@@ -2149,7 +2149,12 @@ what _Spring Data_ supports. Using a real _Repository_ related
_Entity_ class comes into play when you manually try to write new
states or transitions into a backed repository.
Actual out of a box implementations are documented in below sections.
Actual out of a box implementations are documented in below sections
where images below are uml equivalent statecharts of a repository
configs.
[[image-sm-repository-simplemachine]]
image::images/sm-repository-simplemachine.png[scaledwidth="100%", title="SimpleMachine"]
[[sm-repository-jpa]]
=== JPA
@@ -2159,7 +2164,9 @@ and `JpaGuardRepository` which are backed by
_Entity_ classes `JpaRepositoryState`, `JpaRepositoryTransition`,
`JpaRepositoryAction` and `JpaRepositoryGuard` respectively.
Generic way to update states and transition manually is shown below.
Generic way to update states and transition manually for jpa is shown
below. This is equivalent to machine shown in
<<image-sm-repository-simplemachine>>.
[source,java,indent=0]
----
@@ -2179,6 +2186,15 @@ and `RedisGuardRepository` which are backed by
_Entity_ classes `RedisRepositoryState`, `RedisRepositoryTransition`,
`RedisRepositoryAction` and `RedisRepositoryGuard` respectively.
Generic way to update states and transition manually for redis is shown
below. This is equivalent to machine shown in
<<image-sm-repository-simplemachine>>.
[source,java,indent=0]
----
include::samples/DocsRedisRepositorySampleTests1.java[tags=snippetA]
----
[[sm-repository-mongodb]]
=== MongoDB
Actual _Repository_ implementations for a _MongoDB_ are
@@ -2187,3 +2203,12 @@ and `MongoDbGuardRepository` which are backed by
_Entity_ classes `MongoDbRepositoryState`, `MongoDbRepositoryTransition`,
`MongoDbRepositoryAction` and `MongoDbRepositoryGuard` respectively.
Generic way to update states and transition manually for redis is shown
below. This is equivalent to machine shown in
<<image-sm-repository-simplemachine>>.
[source,java,indent=0]
----
include::samples/DocsMongoDbRepositorySampleTests1.java[tags=snippetA]
----