Consistent javadoc param declarations for type variables

Author: jhoeller

spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/JCacheOperation.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -28,21 +28,21 @@
  * <p>A cache operation can be statically cached as it does not contain
  * any runtime operation of a specific cache invocation.
  *
- * @param <A> the type of the JSR-107 annotation
  * @author Stephane Nicoll
  * @since 4.1
+ * @param <A> the type of the JSR-107 annotation
  */
 public interface JCacheOperation<A extends Annotation> extends BasicOperation, CacheMethodDetails<A> {
 
 	/**
-	 * Return the {@link CacheResolver} instance to use to resolve the cache to
-	 * use for this operation.
+	 * Return the {@link CacheResolver} instance to use to resolve the cache
+	 * to use for this operation.
 	 */
 	CacheResolver getCacheResolver();
 
 	/**
-	 * Return the {@link CacheInvocationParameter} instances based on the specified
-	 * method arguments.
+	 * Return the {@link CacheInvocationParameter} instances based on the
+	 * specified method arguments.
 	 * <p>The method arguments must match the signature of the related method invocation
 	 * @param values the parameters value for a particular invocation
 	 */

spring-context/src/main/java/org/springframework/context/ApplicationListener.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2015 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.

spring-context/src/main/java/org/springframework/context/PayloadApplicationEvent.java

@@ -20,25 +20,26 @@
 
 /**
  * An {@link ApplicationEvent} that carries an arbitrary payload.
- * <p>
- * Mainly intended for internal use within the framework.
  *
- * @param <T> the payload type of the event
+ * <p>Mainly intended for internal use within the framework.
+ *
  * @author Stephane Nicoll
  * @since 4.2
+ * @param <T> the payload type of the event
  */
 @SuppressWarnings("serial")
-public class PayloadApplicationEvent<T>
-		extends ApplicationEvent {
+public class PayloadApplicationEvent<T> extends ApplicationEvent {
 
 	private final T payload;
 
+
 	public PayloadApplicationEvent(Object source, T payload) {
 		super(source);
 		Assert.notNull(payload, "Payload must not be null");
 		this.payload = payload;
 	}
 
+
 	/**
 	 * Return the payload of the event.
 	 */

spring-context/src/main/java/org/springframework/context/annotation/AdviceModeImportSelector.java

@@ -1,5 +1,5 @@
- /*
- * Copyright 2002-2013 the original author or authors.
+/*
+ * Copyright 2002-2015 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.
@@ -28,9 +28,9 @@
  * based on an {@link AdviceMode} value from an annotation (such as the {@code @Enable*}
  * annotations).
  *
- * @param <A> Annotation containing {@linkplain #getAdviceModeAttributeName() AdviceMode attribute}
  * @author Chris Beams
  * @since 3.1
+ * @param <A> annotation containing {@linkplain #getAdviceModeAttributeName() AdviceMode attribute}
  */
 public abstract class AdviceModeImportSelector<A extends Annotation> implements ImportSelector {
 

spring-core/src/main/java/org/springframework/core/convert/converter/ConverterFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2015 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,8 +24,8 @@
  * @author Keith Donald
  * @since 3.0
  * @see ConditionalConverter
- * @param <S> The source type converters created by this factory can convert from
- * @param <R> The target range (or base) type converters created by this factory can convert to;
+ * @param <S> the source type converters created by this factory can convert from
+ * @param <R> the target range (or base) type converters created by this factory can convert to;
  * for example {@link Number} for a set of number subtypes.
  */
 public interface ConverterFactory<S, R> {

spring-core/src/main/java/org/springframework/core/convert/converter/ConvertingComparator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -29,9 +29,9 @@
  * {@code Comparator}.
  *
  * @author Phillip Webb
+ * @since 3.2
  * @param <S> the source type
  * @param <T> the target type
- * @since 3.2
  */
 public class ConvertingComparator<S, T> implements Comparator<S> {
 
@@ -42,7 +42,6 @@ public class ConvertingComparator<S, T> implements Comparator<S> {
 
 	/**
 	 * Create a new {@link ConvertingComparator} instance.
-	 *
 	 * @param converter the converter
 	 */
 	@SuppressWarnings("unchecked")
@@ -52,7 +51,6 @@ public ConvertingComparator(Converter<S, T> converter) {
 
 	/**
 	 * Create a new {@link ConvertingComparator} instance.
-	 *
 	 * @param comparator the underlying comparator used to compare the converted values
 	 * @param converter the converter
 	 */
@@ -65,15 +63,14 @@ public ConvertingComparator(Comparator<T> comparator, Converter<S, T> converter)
 
 	/**
 	 * Create a new {@link ComparableComparator} instance.
-	 *
 	 * @param comparator the underlying comparator
 	 * @param conversionService the conversion service
 	 * @param targetType the target type
 	 */
-	public ConvertingComparator(Comparator<T> comparator,
-		ConversionService conversionService, Class<? extends T> targetType) {
-		this(comparator, new ConversionServiceConverter<S, T>(
-				conversionService, targetType));
+	public ConvertingComparator(
+			Comparator<T> comparator, ConversionService conversionService, Class<? extends T> targetType) {
+
+		this(comparator, new ConversionServiceConverter<S, T>(conversionService, targetType));
 	}
 
 
@@ -87,14 +84,11 @@ public int compare(S o1, S o2) {
 	/**
 	 * Create a new {@link ConvertingComparator} that compares {@link java.util.Map.Entry
 	 * map * entries} based on their {@link java.util.Map.Entry#getKey() keys}.
-	 *
 	 * @param comparator the underlying comparator used to compare keys
 	 * @return a new {@link ConvertingComparator} instance
 	 */
-	public static <K, V> ConvertingComparator<Map.Entry<K, V>, K> mapEntryKeys(
-			Comparator<K> comparator) {
+	public static <K, V> ConvertingComparator<Map.Entry<K, V>, K> mapEntryKeys(Comparator<K> comparator) {
 		return new ConvertingComparator<Map.Entry<K,V>, K>(comparator, new Converter<Map.Entry<K, V>, K>() {
-
 			@Override
 			public K convert(Map.Entry<K, V> source) {
 				return source.getKey();
@@ -105,14 +99,11 @@ public K convert(Map.Entry<K, V> source) {
 	/**
 	 * Create a new {@link ConvertingComparator} that compares {@link java.util.Map.Entry
 	 * map entries} based on their {@link java.util.Map.Entry#getValue() values}.
-	 *
 	 * @param comparator the underlying comparator used to compare values
 	 * @return a new {@link ConvertingComparator} instance
 	 */
-	public static <K, V> ConvertingComparator<Map.Entry<K, V>, V> mapEntryValues(
-			Comparator<V> comparator) {
+	public static <K, V> ConvertingComparator<Map.Entry<K, V>, V> mapEntryValues(Comparator<V> comparator) {
 		return new ConvertingComparator<Map.Entry<K,V>, V>(comparator, new Converter<Map.Entry<K, V>, V>() {
-
 			@Override
 			public V convert(Map.Entry<K, V> source) {
 				return source.getValue();

spring-core/src/main/java/org/springframework/core/convert/converter/GenericConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -27,9 +27,9 @@
  * <p>This is the most flexible of the Converter SPI interfaces, but also the most complex.
  * It is flexible in that a GenericConverter may support converting between multiple source/target
  * type pairs (see {@link #getConvertibleTypes()}. In addition, GenericConverter implementations
- * have access to source/target {@link TypeDescriptor field context} during the type conversion process.
- * This allows for resolving source and target field metadata such as annotations and generics
- * information, which can be used influence the conversion logic.
+ * have access to source/target {@link TypeDescriptor field context} during the type conversion
+ * process. This allows for resolving source and target field metadata such as annotations and
+ * generics information, which can be used influence the conversion logic.
  *
  * <p>This interface should generally not be used when the simpler {@link Converter} or
  * {@link ConverterFactory} interfaces are sufficient.
@@ -49,9 +49,8 @@ public interface GenericConverter {
 	/**
 	 * Return the source and target types which this converter can convert between. Each
 	 * entry is a convertible source-to-target type pair.
-	 * <p>
-	 * For {@link ConditionalConverter conditional} converters this method may return
-	 * {@code null} to indicate all source-to-target pairs should be considered. *
+	 * <p>For {@link ConditionalConverter conditional} converters this method may return
+	 * {@code null} to indicate all source-to-target pairs should be considered.
 	 */
 	Set<ConvertiblePair> getConvertibleTypes();
 
@@ -95,25 +94,25 @@ public Class<?> getTargetType() {
 		}
 
 		@Override
-		public boolean equals(Object obj) {
-			if (this == obj) {
+		public boolean equals(Object other) {
+			if (this == other) {
 				return true;
 			}
-			if (obj == null || obj.getClass() != ConvertiblePair.class) {
+			if (other == null || other.getClass() != ConvertiblePair.class) {
 				return false;
 			}
-			ConvertiblePair other = (ConvertiblePair) obj;
-			return this.sourceType.equals(other.sourceType) && this.targetType.equals(other.targetType);
+			ConvertiblePair otherPair = (ConvertiblePair) other;
+			return (this.sourceType.equals(otherPair.sourceType) && this.targetType.equals(otherPair.targetType));
 		}
 
 		@Override
 		public int hashCode() {
-			return this.sourceType.hashCode() * 31 + this.targetType.hashCode();
+			return (this.sourceType.hashCode() * 31 + this.targetType.hashCode());
 		}
 
 		@Override
 		public String toString() {
-			return this.sourceType.getName() + " -> " + this.targetType.getName();
+			return (this.sourceType.getName() + " -> " + this.targetType.getName());
 		}
 	}
 

spring-core/src/main/java/org/springframework/util/ConcurrentReferenceHashMap.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -51,10 +51,10 @@
  * <p>If not explicitly specified, this implementation will use
  * {@linkplain SoftReference soft entry references}.
  *
- * @param <K> The key type
- * @param <V> The value type
  * @author Phillip Webb
  * @since 3.2
+ * @param <K> the key type
+ * @param <V> the value type
  */
 public class ConcurrentReferenceHashMap<K, V> extends AbstractMap<K, V> implements ConcurrentMap<K, V> {
 

spring-core/src/main/java/org/springframework/util/comparator/InstanceComparator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -32,8 +32,8 @@
  *
  * @author Phillip Webb
  * @since 3.2
- * @param <T> the type of objects being compared
  * @see CompoundComparator
+ * @param <T> the type of objects being compared
  */
 public class InstanceComparator<T> implements Comparator<T> {
 

spring-core/src/main/java/org/springframework/util/concurrent/ListenableFutureAdapter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -25,10 +25,10 @@
  * and {@link ListenableFutureCallback#onSuccess(Object)} call {@link #adapt(Object)}
  * on the adaptee's result.
  *
- * @param <T> the type of this {@code Future}
- * @param <S> the type of the adaptee's {@code Future}
  * @author Arjen Poutsma
  * @since 4.0
+ * @param <T> the type of this {@code Future}
+ * @param <S> the type of the adaptee's {@code Future}
  */
 public abstract class ListenableFutureAdapter<T, S> extends FutureAdapter<T, S> implements ListenableFuture<T> {
 

spring-messaging/src/main/java/org/springframework/messaging/core/MessageReceivingOperations.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -22,12 +22,11 @@
 /**
  * Operations for receiving messages from a destination.
  *
- * @param <D> the type of destination to receive messages from
- *
  * @author Mark Fisher
  * @author Rossen Stoyanchev
  * @since 4.0
  * @see GenericMessagingTemplate
+ * @param <D> the type of destination to receive messages from
  */
 public interface MessageReceivingOperations<D> {
 

spring-messaging/src/main/java/org/springframework/messaging/core/MessageRequestReplyOperations.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2015 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,12 +24,11 @@
 /**
  * Operations for sending messages to and receiving the reply from a destination.
  *
- * @param <D> the type of destination
- *
  * @author Mark Fisher
  * @author Rossen Stoyanchev
  * @since 4.0
  * @see GenericMessagingTemplate
+ * @param <D> the type of destination
  */
 public interface MessageRequestReplyOperations<D> {
 

spring-messaging/src/main/java/org/springframework/messaging/core/MessageSendingOperations.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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,11 +24,10 @@
 /**
  * Operations for sending messages to a destination.
  *
- * @param <D> the type of destination to send messages to
- *
  * @author Mark Fisher
  * @author Rossen Stoyanchev
  * @since 4.0
+ * @param <D> the type of destination to send messages to
  */
 public interface MessageSendingOperations<D> {
 

spring-messaging/src/main/java/org/springframework/messaging/handler/MessageCondition.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -25,10 +25,9 @@
  * matched to a specific Message, as well as compared to each other in the
  * context of a Message to determine which one matches a request more closely.
  *
- * @param <T> The kind of condition that this condition can be combined with or compared to
- *
  * @author Rossen Stoyanchev
  * @since 4.0
+ * @param <T> the kind of condition that this condition can be combined with or compared to
  */
 public interface MessageCondition<T> {