Fix Javadoc.

Fix invalid links. Replace Javadoc links to JSR-305 with code annotations.

Replace self-enclosing tags with simple ones.

See #2423

Author: mp911de

Diff for: src/main/java/org/springframework/data/annotation/PersistenceConstructor.java

@@ -21,7 +21,7 @@
 import java.lang.annotation.Target;
 
 /**
- * @author Jon Brisbin <[email protected]>
+ * @author Jon Brisbin
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.CONSTRUCTOR)

Diff for: src/main/java/org/springframework/data/auditing/IsNewAwareAuditingHandler.java

@@ -15,8 +15,6 @@
  */
 package org.springframework.data.auditing;
 
-import java.util.Optional;
-
 import org.springframework.data.mapping.PersistentEntity;
 import org.springframework.data.mapping.PersistentProperty;
 import org.springframework.data.mapping.context.MappingContext;
@@ -26,8 +24,8 @@
 
 /**
  * {@link AuditingHandler} extension that uses {@link PersistentEntity#isNew(Object)} to expose a generic
- * {@link #markAudited(Optional)} method that will route calls to {@link #markCreated(Optional)} or
- * {@link #markModified(Optional)} based on the {@link IsNewStrategy} determined from the factory.
+ * {@link #markAudited(Object)} method that will route calls to {@link #markCreated(Object)} or
+ * {@link #markModified(Object)} based on the {@link IsNewStrategy} determined from the factory.
  *
  * @author Oliver Gierke
  * @author Christoph Strobl
@@ -65,7 +63,7 @@ public IsNewAwareAuditingHandler(PersistentEntities entities) {
 
 	/**
 	 * Marks the given object created or modified based on {@link PersistentEntity#isNew(Object)}. Will route the calls to
-	 * {@link #markCreated(Optional)} and {@link #markModified(Optional)} accordingly.
+	 * {@link #markCreated(Object)} and {@link #markModified(Object)} accordingly.
 	 *
 	 * @param object must not be {@literal null}.
 	 */

Diff for: src/main/java/org/springframework/data/domain/Sort.java

@@ -402,7 +402,7 @@ public Order(@Nullable Direction direction, String property) {
 		 *
 		 * @param direction can be {@literal null}, will default to {@link Sort#DEFAULT_DIRECTION}
 		 * @param property must not be {@literal null} or empty.
-		 * @param nullHandling must not be {@literal null}.
+		 * @param nullHandlingHint must not be {@literal null}.
 		 */
 		public Order(@Nullable Direction direction, String property, NullHandling nullHandlingHint) {
 			this(direction, property, DEFAULT_IGNORE_CASE, nullHandlingHint);

Diff for: src/main/java/org/springframework/data/domain/jaxb/SpringDataJaxb.java

@@ -108,7 +108,6 @@ public static class PageDto extends RepresentationModel {
 	 * @param source
 	 * @param adapter must not be {@literal null}.
 	 * @return
-	 * @throws Exception
 	 */
 	public static <T, S> List<T> unmarshal(Collection<S> source, XmlAdapter<S, T> adapter) {
 
@@ -136,7 +135,6 @@ public static <T, S> List<T> unmarshal(Collection<S> source, XmlAdapter<S, T> ad
 	 * @param source
 	 * @param adapter must not be {@literal null}.
 	 * @return
-	 * @throws Exception
 	 */
 	public static <T, S> List<S> marshal(@Nullable Iterable<T> source, XmlAdapter<S, T> adapter) {
 

Diff for: src/main/java/org/springframework/data/geo/GeoPage.java

@@ -41,7 +41,7 @@ public class GeoPage<T> extends PageImpl<GeoResult<T>> {
 	/**
 	 * Creates a new {@link GeoPage} from the given {@link GeoResults}.
 	 *
-	 * @param content must not be {@literal null}.
+	 * @param results must not be {@literal null}.
 	 */
 	public GeoPage(GeoResults<T> results) {
 

Diff for: src/main/java/org/springframework/data/geo/format/DistanceFormatter.java

@@ -33,7 +33,7 @@
 /**
  * Converter to create {@link Distance} instances from {@link String} representations. The supported format is a decimal
  * followed by whitespace and a metric abbreviation. We currently support the following abbreviations:
- * {@value #SUPPORTED_METRICS}.
+ * {@link #SUPPORTED_METRICS}.
  *
  * @author Oliver Gierke
  * @author Christoph Strobl

Diff for: src/main/java/org/springframework/data/history/AnnotationRevisionMetadata.java

@@ -29,7 +29,7 @@
 
 /**
  * A {@link RevisionMetadata} implementation that inspects the given object for fields with the configured annotations
- * and returns the field's values on calls to {@link #getRevisionDate()}, {@link #getRevisionInstant()} and
+ * and returns the field's values on calls to {@link #getRevisionInstant()}, {@link #getRevisionInstant()} and
  * {@link #getRevisionNumber()}.
  *
  * @author Oliver Gierke

Diff for: src/main/java/org/springframework/data/mapping/Alias.java

@@ -22,10 +22,10 @@
 /**
  * A container object which may or may not contain a type alias value. If a value is present, {@code isPresent()} will
  * return {@code true} and {@link #getValue()} will return the value.
- * <p/>
+ * <p>
  * Additional methods that depend on the presence or absence of a contained value are provided, such as
  * {@link #hasValue(Object)} or {@link #isPresent()}
- * <p/>
+ * <p>
  * Aliases are immutable once created.
  *
  * @author Oliver Gierke

Diff for: src/main/java/org/springframework/data/mapping/Association.java

@@ -21,7 +21,7 @@
  * Value object to capture {@link Association}s.
  *
  * @param <P> {@link PersistentProperty}s the association connects.
- * @author Jon Brisbin <[email protected]>
+ * @author Jon Brisbin
  * @author Mark Paluch
  */
 public class Association<P extends PersistentProperty<P>> {

Diff for: src/main/java/org/springframework/data/mapping/AssociationHandler.java

@@ -18,7 +18,7 @@
 /**
  * Callback interface to implement functionality to be applied to a collection of {@link Association}s.
  *
- * @author Jon Brisbin <[email protected]>
+ * @author Jon Brisbin
  * @author Oliver Gierke
  */
 public interface AssociationHandler<P extends PersistentProperty<P>> {

Diff for: src/main/java/org/springframework/data/mapping/MappingException.java

@@ -18,7 +18,7 @@
 import org.springframework.lang.Nullable;
 
 /**
- * @author Jon Brisbin <[email protected]>
+ * @author Jon Brisbin
  */
 public class MappingException extends RuntimeException {
 

Diff for: src/main/java/org/springframework/data/mapping/PersistentProperty.java

@@ -128,7 +128,7 @@ default Method getRequiredSetter() {
 	/**
 	 * Returns the with {@link Method} to set a property value on a new object instance. Might return {@literal null} in
 	 * case there is no with available.
-	 * <p/>
+	 * <p>
 	 * With {@link Method methods} are property-bound instance {@link Method methods} that accept a single argument of the
 	 * property type creating a new object instance.
 	 *

Diff for: src/main/java/org/springframework/data/mapping/PersistentPropertyAccessor.java

@@ -23,7 +23,7 @@
  * Domain service to allow accessing and setting {@link PersistentProperty}s of an entity. Usually obtained through
  * {@link PersistentEntity#getPropertyAccessor(Object)}. In case type conversion shall be applied on property access,
  * use a {@link ConvertingPropertyAccessor}.
- * <p />
+ * <p>
  * This service supports mutation for immutable classes by creating new object instances. These are managed as state of
  * {@link PersistentPropertyAccessor} and must be obtained from {@link #getBean()} after processing all updates.
  *

Diff for: src/main/java/org/springframework/data/mapping/PersistentPropertyPathAccessor.java

@@ -61,7 +61,7 @@ default Object getProperty(PersistentPropertyPath<? extends PersistentProperty<?
 	 *
 	 * @param path must not be {@literal null} or empty.
 	 * @param value can be {@literal null}.
-	 * @see AccessOptions#DEFAULT
+	 * @see AccessOptions#defaultSetOptions()
 	 */
 	void setProperty(PersistentPropertyPath<? extends PersistentProperty<?>> path, @Nullable Object value);
 

Diff for: src/main/java/org/springframework/data/mapping/PropertyHandler.java

@@ -19,7 +19,7 @@
  * Callback interface to do something with all plain {@link PersistentProperty} instances <em>except</em> associations
  * and transient properties.
  *
- * @author Jon Brisbin <[email protected]>
+ * @author Jon Brisbin
  */
 public interface PropertyHandler<P extends PersistentProperty<P>> {
 

Diff for: src/main/java/org/springframework/data/mapping/callback/EntityCallback.java

@@ -19,29 +19,28 @@
  * Marker interface for entity callbacks to be implemented in specific callback subtypes. Intended for internal usage
  * within store specific implementations.
  * <h3>Ordering {@link EntityCallback}</h3>
- * <p/>
+ * <p>
  * Multiple entity callbacks are invoked sequentially with the result of the previous callback. Callbacks are unordered
  * by default. It is possible to define the order in which listeners for a certain domain type are to be invoked. To do
  * so, add Spring's common {@link org.springframework.core.annotation.Order @Order} annotation or implement
  * {@link org.springframework.core.Ordered}.
  * <h3>Exception Handling</h3>
- * <p />
+ * <p>
  * While it is possible for a {@link EntityCallback} to declare that it throws arbitrary exception types, any checked
  * exceptions thrown from a {@link EntityCallback} are wrapped in an
  * {@link java.lang.reflect.UndeclaredThrowableException UndeclaredThrowableException} since the callback mechanism can
  * only handle runtime exceptions. Entity callback processing is stopped on the {@link EntityCallback} that raised an
  * exception and the caused exception is propagated to the caller.
  * <h3>Domain Type Binding</h3>
- * <p />
+ * <p>
  * An {@link EntityCallback} can generically declare the domain type that it is able to process by specifying the
  * generic type parameter {@code <T>}. When registered with a Spring
  * {@link org.springframework.context.ApplicationContext}, callbacks are filtered accordingly, with the callback getting
  * invoked for assignable domain objects only.
- * <p/>
+ * <p>
  * Typically, entity callbacks are invoked after publishing {@link org.springframework.context.ApplicationEvent events}.
- * <p/>
  * <h3>Defining {@link EntityCallback} Interfaces</h3>
- * <p />
+ * <p>
  * A {@link EntityCallback} interface needs to define a callback method accepting an object of the parameterized type as
  * its first argument followed by additional <i>optional</i> arguments.
  *

Diff for: src/main/java/org/springframework/data/mapping/callback/EntityCallbackDiscoverer.java

@@ -64,7 +64,7 @@ class EntityCallbackDiscoverer {
 
 	/**
 	 * Create a new {@link EntityCallback} instance.
-	 * <p />
+	 * <p>
 	 * Pre loads {@link EntityCallback} beans by scanning the {@link BeanFactory}.
 	 */
 	EntityCallbackDiscoverer(BeanFactory beanFactory) {

Diff for: src/main/java/org/springframework/data/mapping/callback/EntityCallbacks.java

@@ -72,7 +72,7 @@ static EntityCallbacks create() {
 
 	/**
 	 * Obtain a new {@link EntityCallbacks} instance.
-	 * <p />
+	 * <p>
 	 * {@link EntityCallback callbacks} are pre loaded from the given {@link BeanFactory}. <br />
 	 * Use {@link #addEntityCallback(EntityCallback)} to register additional callbacks manually.
 	 *

Diff for: src/main/java/org/springframework/data/mapping/callback/ReactiveEntityCallbacks.java

@@ -75,7 +75,7 @@ static ReactiveEntityCallbacks create() {
 
 	/**
 	 * Obtain a new {@link ReactiveEntityCallbacks} instance.
-	 * <p />
+	 * <p>
 	 * {@link EntityCallback callbacks} are pre loaded from the given {@link BeanFactory}. <br />
 	 * Use {@link #addEntityCallback(EntityCallback)} to register additional callbacks manually.
 	 *

Diff for: src/main/java/org/springframework/data/mapping/context/AbstractMappingContext.java

@@ -479,7 +479,6 @@ public void initialize() {
 	 * default this will reject all types considered simple and non-supported Kotlin classes, but it might be necessary to
 	 * tweak that in case you have registered custom converters for top level types (which renders them to be considered
 	 * simple) but still need meta-information about them.
-	 * <p/>
 	 *
 	 * @param type will never be {@literal null}.
 	 * @return

Diff for: src/main/java/org/springframework/data/mapping/context/InvalidPersistentPropertyPath.java

@@ -49,8 +49,7 @@ public class InvalidPersistentPropertyPath extends MappingException {
 	 *
 	 * @param source must not be {@literal null}.
 	 * @param unresolvableSegment must not be {@literal null} or empty.
-	 * @param resolvedPath
-	 * @param message must not be {@literal null} or empty.
+	 * @param resolvedPath must not be {@literal null} or empty.
 	 */
 	public InvalidPersistentPropertyPath(String source, TypeInformation<?> type, String unresolvableSegment,
 			PersistentPropertyPath<? extends PersistentProperty<?>> resolvedPath) {

Diff for: src/main/java/org/springframework/data/mapping/model/KotlinClassGeneratingEntityInstantiator.java

@@ -159,7 +159,7 @@ private static boolean parametersMatch(java.lang.reflect.Parameter[] constructor
 	 * <li>{@code DefaultConstructorMarker} (usually null)</li>
 	 * </ul>
 	 * <strong>Defaulting bitmask</strong>
-	 * <p/>
+	 * <p>
 	 * The defaulting bitmask is a 32 bit integer representing which positional argument should be defaulted. Defaulted
 	 * arguments are passed as {@literal null} and require the appropriate positional bit set ( {@code 1 << 2} for the 2.
 	 * argument)). Since the bitmask represents only 32 bit states, it requires additional masks (slots) if more than 32

Diff for: src/main/java/org/springframework/data/querydsl/binding/QuerydslBindings.java

@@ -136,7 +136,7 @@ public final void excluding(Path<?>... paths) {
 	/**
 	 * Include properties for binding. Include the property considered a binding candidate.
 	 *
-	 * @param properties must not be {@literal null} or empty.
+	 * @param paths must not be {@literal null} or empty.
 	 */
 	public final void including(Path<?>... paths) {
 
@@ -388,7 +388,6 @@ public class PathBinder<P extends Path<? extends T>, T> {
 		 * Defines the given {@link SingleValueBinding} to be used for the paths.
 		 *
 		 * @param binding must not be {@literal null}.
-		 * @return
 		 */
 		public void firstOptional(OptionalValueBinding<P, T> binding) {
 
@@ -407,7 +406,6 @@ public void first(SingleValueBinding<P, T> binding) {
 		 * Defines the given {@link MultiValueBinding} to be used for the paths.
 		 *
 		 * @param binding must not be {@literal null}.
-		 * @return
 		 */
 		public void all(MultiValueBinding<P, T> binding) {
 

Diff for: src/main/java/org/springframework/data/repository/NoRepositoryBean.java

@@ -24,7 +24,7 @@
 /**
  * Annotation to exclude repository interfaces from being picked up and thus in consequence getting an instance being
  * created.
- * <p/>
+ * <p>
  * This will typically be used when providing an extended base interface for all repositories in combination with a
  * custom repository base class to implement methods declared in that intermediate interface. In this case you typically
  * derive your concrete repository interfaces from the intermediate one but don't want to create a Spring bean for the

Diff for: src/main/java/org/springframework/data/repository/config/CustomRepositoryImplementationDetector.java

@@ -34,8 +34,7 @@
  * configured with a {@link ImplementationDetectionConfiguration} at construction time, the necessary component scan is
  * executed on first access, cached and its result is the filtered on every further implementation lookup according to
  * the given {@link ImplementationDetectionConfiguration}. If none is given initially, every invocation to
- * {@link #detectCustomImplementation(String, String, ImplementationDetectionConfiguration)} will issue a new component
- * scan.
+ * {@link #detectCustomImplementation(ImplementationLookupConfiguration)} will issue a new component scan.
  *
  * @author Oliver Gierke
  * @author Mark Paluch
@@ -57,7 +56,7 @@ public class CustomRepositoryImplementationDetector {
 	 * Creates a new {@link CustomRepositoryImplementationDetector} with the given {@link Environment},
 	 * {@link ResourceLoader} and {@link ImplementationDetectionConfiguration}. The latter will be registered for a
 	 * one-time component scan for implementation candidates that will the be used and filtered in all subsequent calls to
-	 * {@link #detectCustomImplementation(RepositoryConfiguration)}.
+	 * {@link #detectCustomImplementation(ImplementationLookupConfiguration)}.
 	 *
 	 * @param environment must not be {@literal null}.
 	 * @param resourceLoader must not be {@literal null}.

Diff for: src/main/java/org/springframework/data/repository/config/RepositoryBeanDefinitionParser.java

@@ -33,8 +33,8 @@
 
 /**
  * Base class to implement repository namespaces. These will typically consist of a main XML element potentially having
- * child elements. The parser will wrap the XML element into a {@link GlobalRepositoryConfigInformation} object and
- * allow either manual configuration or automatic detection of repository interfaces.
+ * child elements. The parser will wrap the XML element into a {@link XmlRepositoryConfigurationSource} object and allow
+ * either manual configuration or automatic detection of repository interfaces.
  *
  * @author Oliver Gierke
  */

Diff for: src/main/java/org/springframework/data/repository/config/RepositoryConfigurationExtension.java

@@ -71,7 +71,7 @@ <T extends RepositoryConfigurationSource> Collection<RepositoryConfiguration<T>>
 	 * repositories bean definitions have been registered.
 	 *
 	 * @param registry
-	 * @param source
+	 * @param configurationSource
 	 */
 	void registerBeansForRoot(BeanDefinitionRegistry registry, RepositoryConfigurationSource configurationSource);
 

Diff for: src/main/java/org/springframework/data/repository/core/support/MethodInvocationValidator.java

@@ -41,7 +41,7 @@
  *
  * @author Mark Paluch
  * @since 2.0
- * @see javax.annotation.Nonnull
+ * @see org.springframework.lang.NonNull
  * @see ReflectionUtils#isNullable(MethodParameter)
  * @see NullableUtils
  */

Diff for: src/main/java/org/springframework/data/repository/core/support/MethodLookup.java

@@ -27,7 +27,7 @@
 /**
  * Strategy interface providing {@link MethodPredicate predicates} to resolve a method called on a composite to its
  * implementation method.
- * <p />
+ * <p>
  * {@link MethodPredicate Predicates} are ordered by filtering priority and applied individually. If a predicate does
  * not yield any positive match, the next predicate is applied.
  *

Diff for: src/main/java/org/springframework/data/repository/core/support/MethodLookups.java

@@ -65,7 +65,7 @@ static MethodLookup direct() {
 
 	/**
 	 * Repository type-aware method lookup composed of {@link #direct()} and {@link RepositoryAwareMethodLookup}.
-	 * <p/>
+	 * <p>
 	 * Repository-aware lookups resolve generic types from the repository declaration to verify assignability to Id/domain
 	 * types. This lookup also permits assignable method signatures but prefers {@link #direct()} matches.
 	 *
@@ -79,7 +79,7 @@ static MethodLookup forRepositoryTypes(RepositoryMetadata repositoryMetadata) {
 
 	/**
 	 * Repository type-aware method lookup composed of {@link #direct()} and {@link ReactiveTypeInteropMethodLookup}.
-	 * <p/>
+	 * <p>
 	 * This method lookup considers adaptability of reactive types in method signatures. Repository methods accepting a
 	 * reactive type can be possibly called with a different reactive type if the reactive type can be adopted to the
 	 * target type. This lookup also permits assignable method signatures and resolves repository id/entity types but

Diff for: src/main/java/org/springframework/data/repository/core/support/ReactiveRepositoryFactorySupport.java

@@ -64,7 +64,7 @@ protected void validate(RepositoryMetadata repositoryMetadata) {
 	 * queries.
 	 *
 	 * @param evaluationContextProvider can be {@literal null}, defaults to
-	 *          {@link ReactiveQueryMethodEvaluationContextProvider#INSTANCE}.
+	 *          {@link ReactiveQueryMethodEvaluationContextProvider#DEFAULT}.
 	 */
 	@Override
 	public void setEvaluationContextProvider(QueryMethodEvaluationContextProvider evaluationContextProvider) {