From f22fc8495c4561d244b8032bbafda06a27b1b860 Mon Sep 17 00:00:00 2001
From: Janne Valkealahti <janne.valkealahti@gmail.com>
Date: Sat, 9 Jan 2016 09:44:25 +0000
Subject: [PATCH] Polish javadocs

---
 .../statemachine/annotation/OnEventNotAccepted.java    |  6 +++---
 .../annotation/OnExtendedStateChanged.java             |  7 ++++++-
 .../statemachine/annotation/OnStateChanged.java        |  6 +++---
 .../statemachine/annotation/OnStateEntry.java          |  6 +++---
 .../statemachine/annotation/OnStateExit.java           |  6 +++---
 .../statemachine/annotation/OnStateMachineError.java   |  6 +++---
 .../statemachine/annotation/OnStateMachineStart.java   |  7 +++++--
 .../statemachine/annotation/OnStateMachineStop.java    | 10 +++++++++-
 .../statemachine/annotation/OnTransition.java          |  6 +++---
 .../statemachine/annotation/OnTransitionEnd.java       |  7 ++++---
 .../statemachine/annotation/OnTransitionStart.java     |  7 ++++---
 11 files changed, 46 insertions(+), 28 deletions(-)

diff --git a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnEventNotAccepted.java b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnEventNotAccepted.java
index 849908db..53dda6d8 100644
--- a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnEventNotAccepted.java
+++ b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnEventNotAccepted.java
@@ -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.
  *
diff --git a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnExtendedStateChanged.java b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnExtendedStateChanged.java
index 5a3d5928..b2a072b1 100644
--- a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnExtendedStateChanged.java
+++ b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnExtendedStateChanged.java
@@ -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
diff --git a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateChanged.java b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateChanged.java
index 43e88bb7..ee3ceab5 100644
--- a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateChanged.java
+++ b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateChanged.java
@@ -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.
  *
diff --git a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateEntry.java b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateEntry.java
index 2482db09..a082f265 100644
--- a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateEntry.java
+++ b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateEntry.java
@@ -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.
  *
diff --git a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateExit.java b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateExit.java
index 3add82b1..2a84292d 100644
--- a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateExit.java
+++ b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateExit.java
@@ -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.
  *
diff --git a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineError.java b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineError.java
index 040eee37..37f11d41 100644
--- a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineError.java
+++ b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineError.java
@@ -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.
  *
diff --git a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineStart.java b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineStart.java
index e0a41488..2c2ed573 100644
--- a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineStart.java
+++ b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineStart.java
@@ -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.
  *
diff --git a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineStop.java b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineStop.java
index 1c92ad40..6cef3afe 100644
--- a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineStop.java
+++ b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnStateMachineStop.java
@@ -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
diff --git a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransition.java b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransition.java
index 173ea43f..e019a85c 100644
--- a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransition.java
+++ b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransition.java
@@ -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.
  *
diff --git a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransitionEnd.java b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransitionEnd.java
index 6bbb2992..eae35e14 100644
--- a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransitionEnd.java
+++ b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransitionEnd.java
@@ -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.
  *
diff --git a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransitionStart.java b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransitionStart.java
index 97951e3d..72f443ad 100644
--- a/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransitionStart.java
+++ b/spring-statemachine-core/src/main/java/org/springframework/statemachine/annotation/OnTransitionStart.java
@@ -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.
  *