Polishing

Author: jhoeller

Diff for: spring-context/src/main/java/org/springframework/context/event/ApplicationListenerMethodAdapter.java

@@ -81,6 +81,7 @@ public class ApplicationListenerMethodAdapter implements GenericApplicationListe
 
 	private EventListener eventListener;
 
+
 	public ApplicationListenerMethodAdapter(String beanName, Class<?> targetClass, Method method) {
 		this.beanName = beanName;
 		this.method = method;
@@ -90,6 +91,7 @@ public ApplicationListenerMethodAdapter(String beanName, Class<?> targetClass, M
 		this.methodKey = new AnnotatedElementKey(this.method, this.targetClass);
 	}
 
+
 	/**
 	 * Initialize this instance.
 	 */
@@ -98,11 +100,40 @@ void init(ApplicationContext applicationContext, EventExpressionEvaluator evalua
 		this.evaluator = evaluator;
 	}
 
+
 	@Override
 	public void onApplicationEvent(ApplicationEvent event) {
 		processEvent(event);
 	}
 
+	@Override
+	public boolean supportsEventType(ResolvableType eventType) {
+		for (ResolvableType declaredEventType : this.declaredEventTypes) {
+			if (declaredEventType.isAssignableFrom(eventType)) {
+				return true;
+			}
+			else if (PayloadApplicationEvent.class.isAssignableFrom(eventType.getRawClass())) {
+				ResolvableType payloadType = eventType.as(PayloadApplicationEvent.class).getGeneric();
+				if (declaredEventType.isAssignableFrom(payloadType)) {
+					return true;
+				}
+			}
+		}
+		return eventType.hasUnresolvableGenerics();
+	}
+
+	@Override
+	public boolean supportsSourceType(Class<?> sourceType) {
+		return true;
+	}
+
+	@Override
+	public int getOrder() {
+		Order order = getMethodAnnotation(Order.class);
+		return (order != null ? order.value() : 0);
+	}
+
+
 	/**
 	 * Process the specified {@link ApplicationEvent}, checking if the condition
 	 * match and handling non-null result, if any.
@@ -144,7 +175,6 @@ protected Object[] resolveArguments(ApplicationEvent event) {
 	}
 
 	protected void handleResult(Object result) {
-		Assert.notNull(this.applicationContext, "ApplicationContext must no be null.");
 		if (result.getClass().isArray()) {
 			Object[] events = ObjectUtils.toObjectArray(result);
 			for (Object event : events) {
@@ -164,6 +194,7 @@ else if (result instanceof Collection<?>) {
 
 	private void publishEvent(Object event) {
 		if (event != null) {
+			Assert.notNull(this.applicationContext, "ApplicationContext must no be null");
 			this.applicationContext.publishEvent(event);
 		}
 	}
@@ -174,41 +205,14 @@ private boolean shouldHandle(ApplicationEvent event, Object[] args) {
 		}
 		String condition = getCondition();
 		if (StringUtils.hasText(condition)) {
-			Assert.notNull(this.evaluator, "Evaluator must no be null.");
-			EvaluationContext evaluationContext = this.evaluator.createEvaluationContext(event,
-					this.targetClass, this.method, args);
+			Assert.notNull(this.evaluator, "EventExpressionEvaluator must no be null");
+			EvaluationContext evaluationContext = this.evaluator.createEvaluationContext(
+					event, this.targetClass, this.method, args);
 			return this.evaluator.condition(condition, this.methodKey, evaluationContext);
 		}
 		return true;
 	}
 
-	@Override
-	public boolean supportsEventType(ResolvableType eventType) {
-		for (ResolvableType declaredEventType : this.declaredEventTypes) {
-			if (declaredEventType.isAssignableFrom(eventType)) {
-				return true;
-			}
-			else if (PayloadApplicationEvent.class.isAssignableFrom(eventType.getRawClass())) {
-				ResolvableType payloadType = eventType.as(PayloadApplicationEvent.class).getGeneric();
-				if (declaredEventType.isAssignableFrom(payloadType)) {
-					return true;
-				}
-			}
-		}
-		return eventType.hasUnresolvableGenerics();
-	}
-
-	@Override
-	public boolean supportsSourceType(Class<?> sourceType) {
-		return true;
-	}
-
-	@Override
-	public int getOrder() {
-		Order order = getMethodAnnotation(Order.class);
-		return (order != null ? order.value() : 0);
-	}
-
 	protected <A extends Annotation> A getMethodAnnotation(Class<A> annotationType) {
 		return AnnotationUtils.findAnnotation(this.method, annotationType);
 	}
@@ -246,7 +250,7 @@ protected Object doInvoke(Object... args) {
 	 * Return the target bean instance to use.
 	 */
 	protected Object getTargetBean() {
-		Assert.notNull(this.applicationContext, "ApplicationContext must no be null.");
+		Assert.notNull(this.applicationContext, "ApplicationContext must no be null");
 		return this.applicationContext.getBean(this.beanName);
 	}
 
@@ -346,8 +350,8 @@ private ResolvableType getResolvableType(ApplicationEvent event) {
 	private List<ResolvableType> resolveDeclaredEventTypes() {
 		int count = this.method.getParameterTypes().length;
 		if (count > 1) {
-			throw new IllegalStateException("Maximum one parameter is allowed " +
-					"for event listener method: " + method);
+			throw new IllegalStateException(
+					"Maximum one parameter is allowed for event listener method: " + this.method);
 		}
 		EventListener ann = getEventListener();
 		if (ann != null && ann.classes().length > 0) {
@@ -359,13 +363,14 @@ private List<ResolvableType> resolveDeclaredEventTypes() {
 		}
 		else {
 			if (count == 0) {
-				throw new IllegalStateException("Event parameter is mandatory " +
-						"for event listener method: " + method);
+				throw new IllegalStateException(
+						"Event parameter is mandatory for event listener method: " + this.method);
 			}
 			return Collections.singletonList(ResolvableType.forMethodParameter(this.method, 0));
 		}
 	}
 
+
 	@Override
 	public String toString() {
 		return this.method.toGenericString();

Diff for: spring-context/src/main/java/org/springframework/context/event/EventListener.java

@@ -29,8 +29,8 @@
  * Annotation that marks a method as a listener for application events.
  *
  * <p>If an annotated method supports a single event type, the method may
- * declare a single parameter that reflects the event type to listen to. If
- * an annotated method supports multiple event types, this annotation may
+ * declare a single parameter that reflects the event type to listen to.
+ * If an annotated method supports multiple event types, this annotation may
  * refer to one or more supported event types using the {@code classes}
  * attribute. See {@link #classes} for further details.
  *
@@ -42,20 +42,19 @@
  * when using Java config or manually via the {@code <context:annotation-driven/>}
  * element when using XML config.
  *
- * <p>Annotated methods may have a non-{@code void} return type. When they
- * do, the result of the method invocation is sent as a new event. If the
- * return type is either an array or a collection, each element is sent as
- * a new event.
+ * <p>Annotated methods may have a non-{@code void} return type. When they do,
+ * the result of the method invocation is sent as a new event. If the return type
+ * is either an array or a collection, each element is sent as a new event.
  *
- * <p>It is also possible to define the order in which listeners for a
- * certain event are invoked. To do so, add a regular
+ * <p>It is also possible to define the order in which listeners for a certain
+ * event are invoked. To do so, add Spring's common
  * {@link org.springframework.core.annotation.Order @Order} annotation
  * alongside this annotation.
  *
- * <p>While it is possible for an event listener to declare that it throws
- * arbitrary exception types, any checked exceptions thrown from an event
- * listener will be wrapped in a {@link java.lang.reflect.UndeclaredThrowableException}
- * since the caller can only handle runtime exceptions.
+ * <p>While it is possible for an event listener to declare that it throws arbitrary
+ * exception types, any checked exceptions thrown from an event listener will be
+ * wrapped in an {@link java.lang.reflect.UndeclaredThrowableException} since
+ * the caller can only handle runtime exceptions.
  *
  * @author Stephane Nicoll
  * @since 4.2
@@ -89,4 +88,4 @@
 	 */
 	String condition() default "";
 
-}
+}

Diff for: spring-jms/src/main/java/org/springframework/jms/annotation/JmsListener.java

@@ -26,21 +26,20 @@
 import org.springframework.messaging.handler.annotation.MessageMapping;
 
 /**
- * Annotation that marks a method to be the target of a JMS message
- * listener on the specified {@link #destination}. The {@link #containerFactory}
- * identifies the {@link org.springframework.jms.config.JmsListenerContainerFactory
- * JmsListenerContainerFactory} to use to build the JMS listener container. If not
- * set, a <em>default</em> container factory is assumed to be available with a bean
- * name of {@code jmsListenerContainerFactory} unless an explicit default has been
- * provided through configuration.
+ * Annotation that marks a method to be the target of a JMS message listener on the
+ * specified {@link #destination}. The {@link #containerFactory} identifies the
+ * {@link org.springframework.jms.config.JmsListenerContainerFactory} to use to build
+ * the JMS listener container. If not set, a <em>default</em> container factory is
+ * assumed to be available with a bean name of {@code jmsListenerContainerFactory}
+ * unless an explicit default has been provided through configuration.
  *
- * <p>Processing of {@code @JmsListener} annotations is performed by
- * registering a {@link JmsListenerAnnotationBeanPostProcessor}. This can be
- * done manually or, more conveniently, through the {@code <jms:annotation-driven/>}
- * element or {@link EnableJms @EnableJms} annotation.
+ * <p>Processing of {@code @JmsListener} annotations is performed by registering a
+ * {@link JmsListenerAnnotationBeanPostProcessor}. This can be done manually or,
+ * more conveniently, through the {@code <jms:annotation-driven/>} element or
+ * {@link EnableJms @EnableJms} annotation.
  *
- * <p>Annotated methods are allowed to have flexible signatures similar to what
- * {@link MessageMapping} provides:
+ * <p>Annotated JMS listener methods are allowed to have flexible signatures similar
+ * to what {@link MessageMapping} provides:
  * <ul>
  * <li>{@link javax.jms.Session} to get access to the JMS session</li>
  * <li>{@link javax.jms.Message} or one of its subclasses to get access to the raw JMS message</li>
@@ -49,15 +48,15 @@
  * arguments, including support for validation</li>
  * <li>{@link org.springframework.messaging.handler.annotation.Header @Header}-annotated method
  * arguments to extract specific header values, including standard JMS headers defined by
- * {@link org.springframework.jms.support.JmsHeaders JmsHeaders}</li>
+ * {@link org.springframework.jms.support.JmsHeaders}</li>
  * <li>{@link org.springframework.messaging.handler.annotation.Headers @Headers}-annotated
- * method argument that must also be assignable to {@link java.util.Map} for obtaining access to all
- * headers</li>
- * <li>{@link org.springframework.messaging.MessageHeaders MessageHeaders} arguments for
- * obtaining access to all headers</li>
- * <li>{@link org.springframework.messaging.support.MessageHeaderAccessor MessageHeaderAccessor}
- * or {@link org.springframework.jms.support.JmsMessageHeaderAccessor JmsMessageHeaderAccessor}
- * for convenient access to all method arguments</li>
+ * method argument that must also be assignable to {@link java.util.Map} for obtaining
+ * access to all headers</li>
+ * <li>{@link org.springframework.messaging.MessageHeaders} arguments for obtaining
+ * access to all headers</li>
+ * <li>{@link org.springframework.messaging.support.MessageHeaderAccessor} or
+ * {@link org.springframework.jms.support.JmsMessageHeaderAccessor} for convenient
+ * access to all method arguments</li>
  * </ul>
  *
  * <p>Annotated methods may have a non-{@code void} return type. When they do,
@@ -75,9 +74,9 @@
  */
 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 @Retention(RetentionPolicy.RUNTIME)
-@MessageMapping
 @Documented
 @Repeatable(JmsListeners.class)
+@MessageMapping
 public @interface JmsListener {
 
 	/**
@@ -88,16 +87,15 @@
 	String id() default "";
 
 	/**
-	 * The bean name of the {@link org.springframework.jms.config.JmsListenerContainerFactory JmsListenerContainerFactory}
+	 * The bean name of the {@link org.springframework.jms.config.JmsListenerContainerFactory}
 	 * to use to create the message listener container responsible for serving this endpoint.
 	 * <p>If not specified, the default container factory is used, if any.
 	 */
 	String containerFactory() default "";
 
 	/**
 	 * The destination name for this listener, resolved through the container-wide
-	 * {@link org.springframework.jms.support.destination.DestinationResolver DestinationResolver}
-	 * strategy.
+	 * {@link org.springframework.jms.support.destination.DestinationResolver} strategy.
 	 */
 	String destination();
 

Diff for: spring-jms/src/main/java/org/springframework/jms/annotation/JmsListenerAnnotationBeanPostProcessor.java

@@ -54,19 +54,19 @@
 /**
  * Bean post-processor that registers methods annotated with {@link JmsListener}
  * to be invoked by a JMS message listener container created under the cover
- * by a {@link org.springframework.jms.config.JmsListenerContainerFactory} according
- * to the parameters of the annotation.
+ * by a {@link org.springframework.jms.config.JmsListenerContainerFactory}
+ * according to the attributes of the annotation.
  *
  * <p>Annotated methods can use flexible arguments as defined by {@link JmsListener}.
  *
  * <p>This post-processor is automatically registered by Spring's
  * {@code <jms:annotation-driven>} XML element, and also by the {@link EnableJms}
  * annotation.
  *
- * <p>Auto-detect any {@link JmsListenerConfigurer} instances in the container,
+ * <p>Autodetects any {@link JmsListenerConfigurer} instances in the container,
  * allowing for customization of the registry to be used, the default container
- * factory or for fine-grained control over endpoints registration. See
- * {@link EnableJms} Javadoc for complete usage details.
+ * factory or for fine-grained control over endpoints registration. See the
+ * {@link EnableJms} javadocs for complete usage details.
  *
  * @author Stephane Nicoll
  * @author Juergen Hoeller
@@ -282,7 +282,7 @@ private String getEndpointId(JmsListener jmsListener) {
 			return resolve(jmsListener.id());
 		}
 		else {
-			return "org.springframework.jms.JmsListenerEndpointContainer#" + counter.getAndIncrement();
+			return "org.springframework.jms.JmsListenerEndpointContainer#" + this.counter.getAndIncrement();
 		}
 	}