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

Polish javadocs

Browse Source
This commit is contained in:
Janne Valkealahti
2016-01-09 09:44:25 +00:00
parent 51bc34b897
commit f22fc8495c
11 changed files with 46 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnEventNotAccepted.java
View File

@@ -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.
@@ -30,8 +30,8 @@ import org.springframework.statemachine.ExtendedState;
* is not accepted by a state machine.
* <p>
* A method annotated with @OnEventNotAccepted may accept a parameter of type
* {@link ExtendedState} or {@link Map} if map argument is itself is annotated
* with {@link EventHeaders}.
* {@link ExtendedState}, {@link Map} if map argument itself is annotated
* with {@link EventHeaders}, {@link StateMachine}, {@link Message} or {@link Exception}.
* <p>
* Return value can be anything and is effectively discarded.
*

7
spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnExtendedStateChanged.java
View File

@@ -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.
@@ -21,6 +21,7 @@ import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.Map;
import org.springframework.statemachine.ExtendedState;
@@ -28,6 +29,10 @@ import org.springframework.statemachine.ExtendedState;
* Indicates that a method is candidate to be called when {@link ExtendedState}
* is changed.
* <p>
* A method annotated with @OnExtendedStateChanged may accept a parameter of type
* {@link ExtendedState}, {@link Map} if map argument itself is annotated
* with {@link EventHeaders}, {@link StateMachine}, {@link Message} or {@link Exception}.
* <p>
* Return value can be anything and is effectively discarded.
*
* @author Janne Valkealahti

6
spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateChanged.java
View File

@@ -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.
@@ -31,8 +31,8 @@ import org.springframework.statemachine.state.State;
* is changed.
* <p>
* A method annotated with @OnStateChanged may accept a parameter of type
* {@link ExtendedState} or {@link Map} if map argument is itself is annotated
* with {@link EventHeaders}.
* {@link ExtendedState}, {@link Map} if map argument itself is annotated
* with {@link EventHeaders}, {@link StateMachine}, {@link Message} or {@link Exception}.
* <p>
* Return value can be anything and is effectively discarded.
*

6
spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateEntry.java
View File

@@ -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.
@@ -31,8 +31,8 @@ import org.springframework.statemachine.state.State;
* is entered.
* <p>
* A method annotated with @OnStateChanged may accept a parameter of type
* {@link ExtendedState} or {@link Map} if map argument is itself is annotated
* with {@link EventHeaders}.
* {@link ExtendedState}, {@link Map} if map argument itself is annotated
* with {@link EventHeaders}, {@link StateMachine}, {@link Message} or {@link Exception}.
* <p>
* Return value can be anything and is effectively discarded.
*

6
spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateExit.java
View File

@@ -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.
@@ -31,8 +31,8 @@ import org.springframework.statemachine.state.State;
* is exited.
* <p>
* A method annotated with @OnStateChanged may accept a parameter of type
* {@link ExtendedState} or {@link Map} if map argument is itself is annotated
* with {@link EventHeaders}.
* {@link ExtendedState}, {@link Map} if map argument itself is annotated
* with {@link EventHeaders}, {@link StateMachine}, {@link Message} or {@link Exception}.
* <p>
* Return value can be anything and is effectively discarded.
*

6
spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineError.java
View File

@@ -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.
@@ -30,8 +30,8 @@ import org.springframework.statemachine.ExtendedState;
* has been entered in error it cannot recover.
* <p>
* A method annotated with @OnStateMachineError may accept a parameter of type
* {@link ExtendedState} or {@link Map} if map argument is itself is annotated
* with {@link EventHeaders}.
* {@link ExtendedState}, {@link Map} if map argument itself is annotated
* with {@link EventHeaders}, {@link StateMachine}, {@link Message} or {@link Exception}.
* <p>
* Return value can be anything and is effectively discarded.
*

7
spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineStart.java
View File

@@ -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.
@@ -21,7 +21,9 @@ import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.Map;
import org.springframework.statemachine.ExtendedState;
import org.springframework.statemachine.StateMachine;
/**
@@ -29,7 +31,8 @@ import org.springframework.statemachine.StateMachine;
* is started.
* <p>
* A method annotated with @OnStateMachineStart may accept a parameter of type
* {@link StateMachine}.
* {@link ExtendedState}, {@link Map} if map argument itself is annotated
* with {@link EventHeaders}, {@link StateMachine}, {@link Message} or {@link Exception}.
* <p>
* Return value can be anything and is effectively discarded.
*

10
spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineStop.java
View File

@@ -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.
@@ -21,11 +21,19 @@ import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.Map;
import org.springframework.statemachine.ExtendedState;
import org.springframework.statemachine.StateMachine;
/**
* Indicates that a method is a candidate to be called when state machine
* is stopped.
* <p>
* A method annotated with @OnStateMachineStop may accept a parameter of type
* {@link ExtendedState}, {@link Map} if map argument itself is annotated
* with {@link EventHeaders}, {@link StateMachine}, {@link Message} or {@link Exception}.
* <p>
* Return value can be anything and is effectively discarded.
*
* @author Janne Valkealahti

6
spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransition.java
View File

@@ -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.
@@ -30,8 +30,8 @@ import org.springframework.statemachine.transition.Transition;
* Indicates that a method is a candidate to be called with a {@link Transition}.
* <p>
* A method annotated with @OnTransition may accept a parameter of type
* {@link ExtendedState} or {@link Map} if map argument itself is annotated
* with {@link EventHeaders}.
* {@link ExtendedState}, {@link Map} if map argument itself is annotated
* with {@link EventHeaders}, {@link StateMachine}, {@link Message} or {@link Exception}.
* <p>
* Return value can be anything and is effectively discarded.
*

7
spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransitionEnd.java
View File

@@ -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.
@@ -24,14 +24,15 @@ import java.lang.annotation.Target;
import java.util.Map;
import org.springframework.statemachine.ExtendedState;
import org.springframework.statemachine.StateMachine;
import org.springframework.statemachine.transition.Transition;
/**
* Indicates that a method is candidate to be called with a {@link Transition}.
* <p>
* A method annotated with @OnTransitionEnd may accept a parameter of type
* {@link ExtendedState} or {@link Map} if map argument is itself is annotated
* with {@link EventHeaders}.
* {@link ExtendedState}, {@link Map} if map argument itself is annotated
* with {@link EventHeaders}, {@link StateMachine}, {@link Message} or {@link Exception}.
* <p>
* Return value can be anything and is effectively discarded.
*

7
spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransitionStart.java
View File

@@ -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.
@@ -24,14 +24,15 @@ import java.lang.annotation.Target;
import java.util.Map;
import org.springframework.statemachine.ExtendedState;
import org.springframework.statemachine.StateMachine;
import org.springframework.statemachine.transition.Transition;
/**
* Indicates that a method is candidate to be called with a {@link Transition}.
* <p>
* A method annotated with @OnTransitionStart may accept a parameter of type
* {@link ExtendedState} or {@link Map} if map argument is itself is annotated
* with {@link EventHeaders}.
* {@link ExtendedState}, {@link Map} if map argument itself is annotated
* with {@link EventHeaders}, {@link StateMachine}, {@link Message} or {@link Exception}.
* <p>
* Return value can be anything and is effectively discarded.
*