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

Update docs

Browse Source 
- Remove most of a static class modifiers from docs
  to make things easier if doing copy/paste. Not
  all can be removed because some spring inner
  config classes has to be static.
- Fixes #123
This commit is contained in:
Janne Valkealahti
2015-11-26 09:36:47 +00:00
parent b5d3c4e3e4
commit c981c5a6ee
13 changed files with 73 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/reference/asciidoc/getting-started.adoc
View File

@@ -230,11 +230,11 @@ public class Application implements CommandLineRunner {
Add states and events:
[source,java,indent=0]
----
public static enum States {
public enum States {
SI, S1, S2
}
public static enum Events {
public enum Events {
E1, E2
}
----
@@ -244,7 +244,7 @@ Add state machine configuration:
----
@Configuration
@EnableStateMachine
static class StateMachineConfig
public class StateMachineConfig
extends EnumStateMachineConfigurerAdapter<States, Events> {
@Override

84
spring-statemachine-core/src/test/java/org/springframework/statemachine/docs/DocsConfigurationSampleTests.java
View File

@@ -80,7 +80,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetAA[]
@Configuration
@EnableStateMachine
public static class Config1Enums
public class Config1Enums
extends EnumStateMachineConfigurerAdapter<States, Events> {
@Override
@@ -99,7 +99,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetAB[]
@Configuration
@EnableStateMachine
public static class Config1Strings
public class Config1Strings
extends StateMachineConfigurerAdapter<String, String> {
@Override
@@ -118,7 +118,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetB[]
@Configuration
@EnableStateMachine
public static class Config2
public class Config2
extends EnumStateMachineConfigurerAdapter<States, Events> {
@Override
@@ -141,7 +141,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetC[]
@Configuration
@EnableStateMachine
public static class Config3
public class Config3
extends EnumStateMachineConfigurerAdapter<States, Events> {
@Override
@@ -176,7 +176,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetD[]
@Configuration
@EnableStateMachine
public static class Config4
public class Config4
extends EnumStateMachineConfigurerAdapter<States, Events> {
@Override
@@ -212,7 +212,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetEA[]
@Configuration
@EnableStateMachine
public static class Config51
public class Config51
extends EnumStateMachineConfigurerAdapter<States, Events> {
@Override
@@ -243,7 +243,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetEB[]
@Configuration
@EnableStateMachine
public static class Config52
public class Config52
extends EnumStateMachineConfigurerAdapter<States, Events> {
@Override
@@ -274,7 +274,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetFA[]
@Configuration
@EnableStateMachineFactory
public static class Config6
public class Config6
extends EnumStateMachineConfigurerAdapter<States, Events> {
@Override
@@ -317,7 +317,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// end::snippetFC[]
// tag::snippetG[]
static class StateMachineApplicationEventListener
public class StateMachineApplicationEventListener
implements ApplicationListener<StateMachineEvent> {
@Override
@@ -326,7 +326,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
}
@Configuration
static class ListenerConfig {
public class ListenerConfig {
@Bean
public StateMachineApplicationEventListener contextListener() {
@@ -338,7 +338,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetGG[]
@Configuration
@EnableStateMachine
public static class ManualBuilderConfig {
public class ManualBuilderConfig {
@Bean
public StateMachine<String, String> stateMachine() throws Exception {
@@ -359,7 +359,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// end::snippetGG[]
// tag::snippetH[]
static class StateMachineEventListener
public class StateMachineEventListener
extends StateMachineListenerAdapter<States, Events> {
@Override
@@ -410,7 +410,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetI[]
@WithStateMachine
static class Bean1 {
public class Bean1 {
@OnTransition(source = "S1", target = "S2")
public void fromS1ToS2() {
@@ -420,7 +420,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetII[]
@WithStateMachine
static class Bean4 {
public class Bean4 {
@StatesOnTransition(source = States.S1, target = States.S2)
public void fromS1ToS2(@EventHeaders Map<String, Object> headers, ExtendedState extendedState) {
@@ -432,7 +432,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@OnTransition
static @interface StatesOnTransition {
public @interface StatesOnTransition {
States[] source() default {};
@@ -442,7 +442,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetK[]
@WithStateMachine
static class Bean2 {
public class Bean2 {
@StatesOnTransition(source = States.S1, target = States.S2)
public void fromS1ToS2() {
@@ -451,7 +451,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// end::snippetK[]
// tag::snippetL[]
static class Bean3 {
public class Bean3 {
@Autowired
StateMachineFactory<States, Events> factory;
@@ -464,7 +464,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// end::snippetL[]
// tag::snippetM[]
static class Config7 {
public class Config7 {
@Autowired
StateMachine<States, Events> stateMachine;
@@ -482,18 +482,18 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetN[]
@Configuration
@EnableStateMachine(contextEvents = false)
public static class Config8
public class Config8
extends EnumStateMachineConfigurerAdapter<States, Events> {
}
@Configuration
@EnableStateMachineFactory(contextEvents = false)
public static class Config9
public class Config9
extends EnumStateMachineConfigurerAdapter<States, Events> {
}
// end::snippetN[]
static class DummyShowSendEvent {
public class DummyShowSendEvent {
// tag::snippetO[]
@Autowired
@@ -515,7 +515,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetP[]
@Configuration
@EnableStateMachine
public static class Config10
public class Config10
extends EnumStateMachineConfigurerAdapter<States2, Events> {
@Override
@@ -545,7 +545,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetQ[]
@Configuration
@EnableStateMachine
public static class Config11
public class Config11
extends EnumStateMachineConfigurerAdapter<States, Events> {
@Override
@@ -575,7 +575,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetR[]
@Configuration
@EnableStateMachine
public static class Config12
public class Config12
extends EnumStateMachineConfigurerAdapter<States3, Events> {
@Override
@@ -600,7 +600,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetS[]
@Configuration
@EnableStateMachine
public static class Config13
public class Config13
extends EnumStateMachineConfigurerAdapter<States, Events> {
@Override
@@ -653,7 +653,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetT[]
@Configuration
@EnableStateMachine
public static class Config14
public class Config14
extends EnumStateMachineConfigurerAdapter<States2, Events> {
@Override
@@ -696,7 +696,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetU[]
@Configuration
@EnableStateMachine
public static class Config15
public class Config15
extends EnumStateMachineConfigurerAdapter<States2, Events> {
@Override
@@ -738,7 +738,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
@Configuration
@EnableStateMachine
public static class Config16
public class Config16
extends EnumStateMachineConfigurerAdapter<States, Events> {
// tag::snippetVA[]
@@ -793,7 +793,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
return new BaseGuard();
}
static class BaseGuard implements Guard<States, Events> {
public class BaseGuard implements Guard<States, Events> {
@Override
public boolean evaluate(StateContext<States, Events> context) {
@@ -826,14 +826,14 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
"stateMachine.sendEvent(T(org.springframework.statemachine.docs.Events).E1)"));
}
static class BaseAction implements Action<States, Events> {
public class BaseAction implements Action<States, Events> {
@Override
public void execute(StateContext<States, Events> context) {
}
}
static class SpelAction extends SpelExpressionAction<States, Events> {
public class SpelAction extends SpelExpressionAction<States, Events> {
public SpelAction(Expression expression) {
super(expression);
@@ -847,7 +847,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetYA[]
@Configuration
@EnableStateMachine
public static class Config17
public class Config17
extends EnumStateMachineConfigurerAdapter<States, Events> {
@Override
@@ -868,7 +868,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// tag::snippetYB[]
@Configuration
@EnableStateMachine
public static class Config18
public class Config18
extends EnumStateMachineConfigurerAdapter<States, Events> {
@Override
@@ -889,7 +889,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
}
// end::snippetYB[]
public static class AccessorSamples {
public class AccessorSamples {
StateMachine<String, String> stateMachine = null;
@@ -943,7 +943,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
}
public static class InterceptorSamples {
public class InterceptorSamples {
StateMachine<String, String> stateMachine = null;
@@ -984,7 +984,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
}
@SuppressWarnings("unused")
private static class InterceptorAddExample {
private class InterceptorAddExample {
// tag::snippet1[]
StateMachine<String, String> stateMachine;
@@ -1012,7 +1012,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
}
// tag::snippet2[]
public static class ErrorStateMachineListener
public class ErrorStateMachineListener
extends StateMachineListenerAdapter<String, String> {
@Override
@@ -1023,7 +1023,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// end::snippet2[]
// tag::snippet3[]
public static class GenericApplicationEventListener
public class GenericApplicationEventListener
implements ApplicationListener<StateMachineEvent> {
@Override
@@ -1036,7 +1036,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// end::snippet3[]
// tag::snippet4[]
public static class ErrorApplicationEventListener
public class ErrorApplicationEventListener
implements ApplicationListener<OnStateMachineError> {
@Override
@@ -1047,7 +1047,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// end::snippet4[]
// tag::snippet5[]
public static class ExtendedStateVariableListener
public class ExtendedStateVariableListener
extends StateMachineListenerAdapter<String, String> {
@Override
@@ -1058,7 +1058,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
// end::snippet5[]
// tag::snippet6[]
public static class ExtendedStateVariableEventListener
public class ExtendedStateVariableEventListener
implements ApplicationListener<OnExtendedStateChanged> {
@Override
@@ -1068,7 +1068,7 @@ public class DocsConfigurationSampleTests extends AbstractStateMachineTests {
}
// end::snippet6[]
public static class ExtendedStateVariableActionSample {
public class ExtendedStateVariableActionSample {
// tag::snippet7[]
public Action<String, String> myVariableAction() {

4
spring-statemachine-core/src/test/java/org/springframework/statemachine/docs/DocsConfigurationSampleTests2.java
View File

@@ -30,7 +30,7 @@ public class DocsConfigurationSampleTests2 extends AbstractStateMachineTests {
// tag::snippetA[]
@Configuration
@EnableStateMachine
static class Config2 extends StateMachineConfigurerAdapter<String, String> {
public class Config2 extends StateMachineConfigurerAdapter<String, String> {
@Override
public void configure(StateMachineStateConfigurer<String, String> states)
@@ -62,7 +62,7 @@ public class DocsConfigurationSampleTests2 extends AbstractStateMachineTests {
}
}
static class TimerAction implements Action<String, String> {
public class TimerAction implements Action<String, String> {
@Override
public void execute(StateContext<String, String> context) {

10
spring-statemachine-core/src/test/java/org/springframework/statemachine/docs/IntroSample.java
View File

@@ -30,11 +30,11 @@ import org.springframework.statemachine.config.builders.StateMachineTransitionCo
public class IntroSample {
// tag::snippetA[]
static enum States {
public enum States {
STATE1, STATE2
}
static enum Events {
public enum Events {
EVENT1, EVENT2
}
// end::snippetA[]
@@ -42,7 +42,7 @@ public class IntroSample {
// tag::snippetB[]
@Configuration
@EnableStateMachine
static class Config1 extends EnumStateMachineConfigurerAdapter<States, Events> {
public class Config1 extends EnumStateMachineConfigurerAdapter<States, Events> {
@Override
public void configure(StateMachineStateConfigurer<States, Events> states)
@@ -70,7 +70,7 @@ public class IntroSample {
// tag::snippetC[]
@WithStateMachine
static class MyBean {
public class MyBean {
@OnTransition(target = "STATE1")
void toState1() {
@@ -83,7 +83,7 @@ public class IntroSample {
// end::snippetC[]
// tag::snippetD[]
static class MyApp {
public class MyApp {
@Autowired
StateMachine<States, Events> stateMachine;

4
spring-statemachine-recipes/src/test/java/org/springframework/statemachine/recipes/docs/DocsTasksSampleTests.java
View File

@@ -85,7 +85,7 @@ public class DocsTasksSampleTests {
}
// tag::snippetAA[]
private static Runnable sleepRunnable() {
private Runnable sleepRunnable() {
return new Runnable() {
@Override
@@ -100,7 +100,7 @@ public class DocsTasksSampleTests {
// end::snippetAA[]
// tag::snippetAB[]
private static class MyTasksListener extends TasksListenerAdapter {
private class MyTasksListener extends TasksListenerAdapter {
@Override
public void onTasksStarted() {

10
spring-statemachine-samples/cdplayer/src/main/java/demo/cdplayer/Application.java
View File

@@ -152,7 +152,7 @@ public class Application {
//tag::snippetB[]
public static enum States {
public enum States {
// super state of PLAYING and PAUSED
BUSY,
PLAYING,
@@ -165,7 +165,7 @@ public class Application {
//end::snippetB[]
//tag::snippetC[]
public static enum Events {
public enum Events {
PLAY, STOP, PAUSE, EJECT, LOAD, FORWARD, BACK
}
//end::snippetC[]
@@ -183,11 +183,11 @@ public class Application {
//end::snippetD[]
//tag::snippetE[]
public static enum Variables {
public enum Variables {
CD, TRACK, ELAPSEDTIME
}
public static enum Headers {
public enum Headers {
TRACKSHIFT
}
//end::snippetE[]
@@ -196,7 +196,7 @@ public class Application {
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@OnTransition
public static @interface StatesOnTransition {
public @interface StatesOnTransition {
States[] source() default {};

4
spring-statemachine-samples/showcase/src/main/java/demo/showcase/Application.java
View File

@@ -164,13 +164,13 @@ public class Application {
}
//tag::snippetB[]
public static enum States {
public enum States {
S0, S1, S11, S12, S2, S21, S211, S212
}
//end::snippetB[]
//tag::snippetC[]
public static enum Events {
public enum Events {
A, B, C, D, E, F, G, H, I
}
//end::snippetC[]

6
spring-statemachine-samples/tasks/src/main/java/demo/tasks/Application.java
View File

@@ -196,7 +196,7 @@ public class Application {
}
//tag::snippetB[]
public static enum States {
public enum States {
READY,
FORK, JOIN, CHOICE,
TASKS, T1, T1E, T2, T2E, T3, T3E,
@@ -205,7 +205,7 @@ public class Application {
//end::snippetB[]
//tag::snippetC[]
public static enum Events {
public enum Events {
RUN, FALLBACK, CONTINUE, FIX;
}
//end::snippetC[]
@@ -213,7 +213,7 @@ public class Application {
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@OnTransition
public static @interface StatesOnTransition {
public @interface StatesOnTransition {
States[] source() default {};

4
spring-statemachine-samples/turnstile/src/main/java/demo/turnstile/Application.java
View File

@@ -61,13 +61,13 @@ public class Application {
//end::snippetA[]
//tag::snippetB[]
public static enum States {
public enum States {
LOCKED, UNLOCKED
}
//end::snippetB[]
//tag::snippetC[]
public static enum Events {
public enum Events {
COIN, PUSH
}
//end::snippetC[]

4
spring-statemachine-samples/washer/src/main/java/demo/washer/Application.java
View File

@@ -80,7 +80,7 @@ public class Application {
}
//tag::snippetB[]
public static enum States {
public enum States {
RUNNING, HISTORY, END,
WASHING, RINSING, DRYING,
POWEROFF
@@ -88,7 +88,7 @@ public class Application {
//end::snippetB[]
//tag::snippetC[]
public static enum Events {
public enum Events {
RINSE, DRY, STOP,
RESTOREPOWER, CUTPOWER
}

4
spring-statemachine-samples/web/src/main/java/demo/web/StateMachineConfig.java
View File

@@ -196,11 +196,11 @@ public class StateMachineConfig {
}
public static enum States {
public enum States {
S0, S1, S11, S12, S2, S21, S211, S212
}
public static enum Events {
public enum Events {
A, B, C, D, E, F, G, H, I, J, K
}

4
spring-statemachine-samples/zookeeper/src/main/java/demo/zookeeper/Application.java
View File

@@ -88,11 +88,11 @@ public class Application {
}
public static enum States {
public enum States {
LOCKED, UNLOCKED
}
public static enum Events {
public enum Events {
COIN, PUSH
}

2
spring-statemachine-zookeeper/src/test/java/org/springframework/statemachine/zookeeper/docs/DocsZookeeperSampleTests.java
View File

@@ -35,7 +35,7 @@ public class DocsZookeeperSampleTests {
// tag::snippetA[]
@Configuration
@EnableStateMachine
static class Config
public class Config
extends StateMachineConfigurerAdapter<String, String> {
@Override