Compare commits

...

16 Commits

Author SHA1 Message Date
Vyacheslav Boyko 43b98e80c0 Merge branch 'release/2.2.1' 2022-07-14 17:34:47 +03:00
Vyacheslav Boyko d13761c6a8 Update versions for release 2022-07-14 17:34:43 +03:00
Vyacheslav Boyko ac4537e3e1 new syntax of transitions 2022-07-14 17:34:26 +03:00
Vyacheslav Boyko 1b2e812ca6 Update for next development version 2022-07-14 15:36:45 +03:00
Vyacheslav Boyko efa3f8616b Merge branch 'release/2.1.9' 2022-07-14 15:36:43 +03:00
Vyacheslav Boyko b2d39772fc Merge tag '2.1.9' into develop
Tag release
2022-07-14 15:36:43 +03:00
Vyacheslav Boyko fe5d5a2502 Update versions for release 2022-07-14 15:36:39 +03:00
Vyacheslav Boyko 9db96a2b37 before handler must be called right before switching to the next state 2022-07-14 15:36:25 +03:00
Vyacheslav Boyko 4712c1b423 Update for next development version 2022-07-14 13:58:51 +03:00
Vyacheslav Boyko 92a75db1b4 Merge branch 'release/2.1.8' 2022-07-14 13:58:48 +03:00
Vyacheslav Boyko 1297474ef5 Merge tag '2.1.8' into develop
Tag release
2022-07-14 13:58:48 +03:00
Vyacheslav Boyko dd88e919d1 Update versions for release 2022-07-14 13:58:44 +03:00
Vyacheslav Boyko 99babc5b5a if startingAt beforeHandler must not be called 2022-07-14 13:58:27 +03:00
Vyacheslav Boyko 8ab3306142 test to ensure that all state handlers are called only once 2022-07-14 13:55:19 +03:00
Vyacheslav Boyko 151ed07472 Update for next development version 2022-07-12 23:27:46 +03:00
Vyacheslav Boyko 2f84ae09d8 Merge tag '2.1.7' into develop
Tag release
2022-07-12 23:27:44 +03:00
6 changed files with 228 additions and 4 deletions

View File

@ -7,7 +7,7 @@
<groupId>me.bvn13.fsm</groupId>
<artifactId>fsm</artifactId>
<version>2.1.7</version>
<version>2.2.1</version>
<packaging>jar</packaging>

View File

@ -50,6 +50,31 @@ Simple way to use it - to construct an inherited class specified with the type o
.create();
```
or since 2.2.1
```java
SimpleFsm<String> simpleFsm = Fsm
.<SimpleFsm<String>, String>from(SimpleFsm::new)
.withStates()
.from("init")
.withBeforeHandler(fsm -> initBefore.set(true))
.withAfterHandler(fsm -> initAfter.set(true))
.withProcessor((fsm, event) -> initProcess.set(true))
.withTransition()
.to("finish")
.checking((fsm, event) -> true)
.endTransition()
.end()
.finish("finish")
.withBeforeHandler(fsm -> finishBefore.set(true))
.withAfterHandler(fsm -> finishAfter.set(true))
.withProcessor((fsm, event) -> finishProcess.set(true))
.end()
.create();
}
```
## Releasing
Creating a new release involves the following steps:

View File

@ -3,12 +3,20 @@ package me.bvn13.fsm;
public class ConditionBuilder<T extends Fsm, E> {
private final FsmBuilder<T,E> fsmBuilder;
private final StateBuilder<T, E> stateBuilder;
private String from;
private String to;
private Condition<T,E> condition;
ConditionBuilder(FsmBuilder<T,E> fsmBuilder) {
this.fsmBuilder = fsmBuilder;
this.stateBuilder = null;
}
ConditionBuilder(FsmBuilder<T,E> fsmBuilder, StateBuilder<T, E> stateBuilder, String from) {
this.fsmBuilder = fsmBuilder;
this.stateBuilder = stateBuilder;
this.from = from;
}
public ConditionBuilder<T,E> from(String from) {
@ -31,4 +39,12 @@ public class ConditionBuilder<T extends Fsm, E> {
return fsmBuilder;
}
public StateBuilder<T, E> endTransition() {
if (stateBuilder == null) {
throw new IllegalStateException("Use '.end()' instead");
}
end();
return stateBuilder;
}
}

View File

@ -52,6 +52,8 @@ import static java.lang.String.format;
* Simple way to use it - to construct an inherited class specified with the type of events to be processed
* during transitions.
*
* since 2.1.5
*
* <pre>
* {@code
* SimpleFsm<String> simpleFsm = Fsm
@ -76,6 +78,31 @@ import static java.lang.String.format;
* }
* </pre>
*
* or since 2.2.1
*
* <pre>
* {@code
* SimpleFsm<String> simpleFsm = Fsm
* .<SimpleFsm<String>, String>from(SimpleFsm::new)
* .withStates()
* .from("init")
* .withBeforeHandler(fsm -> initBefore.set(true))
* .withAfterHandler(fsm -> initAfter.set(true))
* .withProcessor((fsm, event) -> initProcess.set(true))
* .withTransition()
* .to("finish")
* .checking((fsm, event) -> true)
* .endTransition()
* .end()
* .finish("finish")
* .withBeforeHandler(fsm -> finishBefore.set(true))
* .withAfterHandler(fsm -> finishAfter.set(true))
* .withProcessor((fsm, event) -> finishProcess.set(true))
* .end()
* .create();
* }
* </pre>
*
* <p>
* Otherwise you are able to use Old syntax:
*
@ -149,9 +176,9 @@ public class Fsm<T extends Fsm, E> {
return;
}
currentState.process(event);
currentState.afterEvent();
if (currentState.isFinish()) {
done = true;
currentState.afterEvent();
return;
}
switchToNextState(event);
@ -252,7 +279,6 @@ public class Fsm<T extends Fsm, E> {
throw new NotInitializedException(format("Unable to find state '%s'", name), e);
}
this.done = currentState.isFinish();
this.currentState.beforeEvent();
}
private void switchToNextState(E event) {
@ -279,6 +305,7 @@ public class Fsm<T extends Fsm, E> {
}
private void nextState(State<E> state, E event) {
currentState.afterEvent();
previousState = currentState;
currentState = state;
currentState.beforeEvent();

View File

@ -56,4 +56,8 @@ public class StateBuilder<T extends Fsm, E> {
return this;
}
public ConditionBuilder<T,E> withTransition() {
return new ConditionBuilder<>(fsmBuilder, this, name);
}
}

View File

@ -7,6 +7,7 @@ import org.junit.Assert;
import org.junit.Test;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
/**
* Created by bvn13 on 28.12.2017.
@ -179,7 +180,7 @@ public class FsmTest {
Assert.assertFalse(initBefore.get());
Assert.assertFalse(initProcess.get());
Assert.assertFalse(initAfter.get());
Assert.assertTrue(intermediateBefore.get());
Assert.assertFalse(intermediateBefore.get());
Assert.assertTrue(intermediateAfter.get());
Assert.assertTrue(intermediateProcess.get());
Assert.assertTrue(finishBefore.get());
@ -188,4 +189,155 @@ public class FsmTest {
}
@Test
public void newSyntaxCountingEveryStep() {
Counter initCounter = new Counter();
Counter firstIntermediateCounter = new Counter();
Counter secondIntermediateCounter = new Counter();
Counter finishCounter = new Counter();
// @formatter:off
SimpleFsm<String> simpleFsm = Fsm
.<SimpleFsm<String>, String>from(SimpleFsm::new)
.withStates()
.from("init")
.withBeforeHandler(fsm -> initCounter.before.incrementAndGet())
.withAfterHandler(fsm -> initCounter.after.incrementAndGet())
.withProcessor((fsm, event) -> initCounter.process.incrementAndGet())
.end()
.state("intermediate-1")
.withBeforeHandler(fsm -> firstIntermediateCounter.before.incrementAndGet())
.withAfterHandler(fsm -> firstIntermediateCounter.after.incrementAndGet())
.withProcessor((fsm, event) -> firstIntermediateCounter.process.incrementAndGet())
.end()
.state("intermediate-2")
.withBeforeHandler(fsm -> secondIntermediateCounter.before.incrementAndGet())
.withAfterHandler(fsm -> secondIntermediateCounter.after.incrementAndGet())
.withProcessor((fsm, event) -> secondIntermediateCounter.process.incrementAndGet())
.end()
.finish("finish")
.withBeforeHandler(fsm -> finishCounter.before.incrementAndGet())
.withAfterHandler(fsm -> finishCounter.after.incrementAndGet())
.withProcessor((fsm, event) -> finishCounter.process.incrementAndGet())
.end()
.withTransition()
.from("init")
.to("intermediate-1")
.checking((fsm, event) -> true)
.end()
.withTransition()
.from("intermediate-1")
.to("intermediate-2")
.checking((fsm, event) -> true)
.end()
.withTransition()
.from("intermediate-2")
.to("finish")
.checking((fsm, event) -> true)
.end()
.create()
;
// @formatter:on
simpleFsm.process("");
simpleFsm.process("");
simpleFsm.process("");
Assert.assertEquals("finish", simpleFsm.getCurrentState().getName());
Assert.assertEquals(1, initCounter.before.get());
Assert.assertEquals(1, initCounter.after.get());
Assert.assertEquals(1, initCounter.process.get());
Assert.assertEquals(1, firstIntermediateCounter.before.get());
Assert.assertEquals(1, firstIntermediateCounter.after.get());
Assert.assertEquals(1, firstIntermediateCounter.process.get());
Assert.assertEquals(1, secondIntermediateCounter.before.get());
Assert.assertEquals(1, secondIntermediateCounter.after.get());
Assert.assertEquals(1, secondIntermediateCounter.process.get());
Assert.assertEquals(1, finishCounter.before.get());
Assert.assertEquals(0, finishCounter.after.get());
Assert.assertEquals(0, finishCounter.process.get());
}
@Test
public void newSyntaxOfTransitions() {
Counter initCounter = new Counter();
Counter firstIntermediateCounter = new Counter();
Counter secondIntermediateCounter = new Counter();
Counter finishCounter = new Counter();
// @formatter:off
SimpleFsm<String> simpleFsm = Fsm
.<SimpleFsm<String>, String>from(SimpleFsm::new)
.withStates()
.from("init")
.withBeforeHandler(fsm -> initCounter.before.incrementAndGet())
.withProcessor((fsm, event) -> initCounter.process.incrementAndGet())
.withAfterHandler(fsm -> initCounter.after.incrementAndGet())
.withTransition()
.to("intermediate-1")
.checking((fsm, event) -> true)
.endTransition()
.end()
.state("intermediate-1")
.withBeforeHandler(fsm -> firstIntermediateCounter.before.incrementAndGet())
.withProcessor((fsm, event) -> firstIntermediateCounter.process.incrementAndGet())
.withAfterHandler(fsm -> firstIntermediateCounter.after.incrementAndGet())
.withTransition()
.from("intermediate-1")
.to("intermediate-2")
.checking((fsm, event) -> true)
.endTransition()
.end()
.state("intermediate-2")
.withBeforeHandler(fsm -> secondIntermediateCounter.before.incrementAndGet())
.withProcessor((fsm, event) -> secondIntermediateCounter.process.incrementAndGet())
.withAfterHandler(fsm -> secondIntermediateCounter.after.incrementAndGet())
.end()
.finish("finish")
.withBeforeHandler(fsm -> finishCounter.before.incrementAndGet())
.withProcessor((fsm, event) -> finishCounter.process.incrementAndGet())
.withAfterHandler(fsm -> finishCounter.after.incrementAndGet())
.withTransition()
.from("intermediate-2")
.to("finish")
.checking((fsm, event) -> true)
.endTransition()
.end()
.create()
;
// @formatter:on
simpleFsm.process("");
simpleFsm.process("");
simpleFsm.process("");
Assert.assertEquals("finish", simpleFsm.getCurrentState().getName());
Assert.assertEquals(1, initCounter.before.get());
Assert.assertEquals(1, initCounter.after.get());
Assert.assertEquals(1, initCounter.process.get());
Assert.assertEquals(1, firstIntermediateCounter.before.get());
Assert.assertEquals(1, firstIntermediateCounter.after.get());
Assert.assertEquals(1, firstIntermediateCounter.process.get());
Assert.assertEquals(1, secondIntermediateCounter.before.get());
Assert.assertEquals(1, secondIntermediateCounter.after.get());
Assert.assertEquals(1, secondIntermediateCounter.process.get());
Assert.assertEquals(1, finishCounter.before.get());
Assert.assertEquals(0, finishCounter.after.get());
Assert.assertEquals(0, finishCounter.process.get());
}
static class Counter {
final AtomicInteger before = new AtomicInteger(0);
final AtomicInteger after = new AtomicInteger(0);
final AtomicInteger process = new AtomicInteger(0);
}
}