Fix Javadoc.

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

Replace self-enclosing tags with simple ones.

See #2423
This commit is contained in:
Mark Paluch
2021-09-20 10:08:00 +02:00
parent bf3c9a5c6c
commit 9fbf39154f
53 changed files with 101 additions and 114 deletions

View File

@@ -22,10 +22,10 @@ import org.springframework.util.ObjectUtils;
/**
* 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

View File

@@ -21,7 +21,7 @@ import org.springframework.lang.Nullable;
* Value object to capture {@link Association}s.
*
* @param <P> {@link PersistentProperty}s the association connects.
* @author Jon Brisbin <jbrisbin@vmware.com>
* @author Jon Brisbin
* @author Mark Paluch
*/
public class Association<P extends PersistentProperty<P>> {

View File

@@ -18,7 +18,7 @@ package org.springframework.data.mapping;
/**
* Callback interface to implement functionality to be applied to a collection of {@link Association}s.
*
* @author Jon Brisbin <jbrisbin@vmware.com>
* @author Jon Brisbin
* @author Oliver Gierke
*/
public interface AssociationHandler<P extends PersistentProperty<P>> {

View File

@@ -18,7 +18,7 @@ package org.springframework.data.mapping;
import org.springframework.lang.Nullable;
/**
* @author Jon Brisbin <jbrisbin@vmware.com>
* @author Jon Brisbin
*/
public class MappingException extends RuntimeException {

View File

@@ -128,7 +128,7 @@ public interface PersistentProperty<P extends PersistentProperty<P>> {
/**
* 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.
*

View File

@@ -23,7 +23,7 @@ import org.springframework.util.Assert;
* 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.
*

View File

@@ -61,7 +61,7 @@ public interface PersistentPropertyPathAccessor<T> extends PersistentPropertyAcc
*
* @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);

View File

@@ -19,7 +19,7 @@ package org.springframework.data.mapping;
* Callback interface to do something with all plain {@link PersistentProperty} instances <em>except</em> associations
* and transient properties.
*
* @author Jon Brisbin <jbrisbin@vmware.com>
* @author Jon Brisbin
*/
public interface PropertyHandler<P extends PersistentProperty<P>> {

View File

@@ -19,29 +19,28 @@ package org.springframework.data.mapping.callback;
* 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.
*

View File

@@ -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) {

View File

@@ -72,7 +72,7 @@ public interface EntityCallbacks {
/**
* 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.
*

View File

@@ -75,7 +75,7 @@ public interface ReactiveEntityCallbacks {
/**
* 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.
*

View File

@@ -479,7 +479,6 @@ public abstract class AbstractMappingContext<E extends MutablePersistentEntity<?
* 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

View File

@@ -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) {

View File

@@ -159,7 +159,7 @@ class KotlinClassGeneratingEntityInstantiator extends ClassGeneratingEntityInsta
* <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