Fix JavaDoc.

Self closing <p/> tags cause build failures now. Closes #1059
2021-09-24 10:15:48 +02:00
parent a75dba3d20
commit 45c57acbb4
21 changed files with 81 additions and 56 deletions
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/conversion/DbAction.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/conversion/DbAction.java
@@ -236,7 +236,7 @@ public interface DbAction<T> {
 	 * <p>
 	 * Note that deletes for contained entities that reference the root are to be represented by separate
 	 * {@link DbAction}s.
-	 *
+	 * </p>
 	 * @param <T> type of the entity for which this represents a database interaction.
 	 */
 	final class DeleteRoot<T> implements DbAction<T> {
@@ -300,7 +300,7 @@ public interface DbAction<T> {
 	 * <p>
 	 * Note that deletes for contained entities that reference the root are to be represented by separate
 	 * {@link DbAction}s.
-	 *
+	 * </p>
 	 * @param <T> type of the entity for which this represents a database interaction.
 	 */
 	final class DeleteAllRoot<T> implements DbAction<T> {
@@ -322,7 +322,6 @@ public interface DbAction<T> {

 	/**
 	 * Represents an acquire lock statement for a aggregate root when only the ID is known.
-	 * <p>
 	 *
 	 * @param <T> type of the entity for which this represents a database interaction.
 	 */
@@ -392,7 +391,7 @@ public interface DbAction<T> {
 		 * Additional values to be set during insert or update statements.
 		 * <p>
 		 * Values come from parent entities but one might also add values manually.
-		 *
+		 * </p>
 		 * @return guaranteed to be not {@code null}.
 		 */
 		Map<PersistentPropertyPath<RelationalPersistentProperty>, Object> getQualifiers();
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/Embedded.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/Embedded.java
@@ -27,10 +27,11 @@ import org.springframework.core.annotation.AliasFor;

 /**
 * The annotation to configure a value object as embedded in the current table.
- * <p />
+ * <p>
 * Depending on the {@link OnEmpty value} of {@link #onEmpty()} the property is set to {@literal null} or an empty
 * instance in the case all embedded values are {@literal null} when reading from the result set.
- *
+ * </p>
+ * 
 * @author Bastian Wilhelm
 * @author Christoph Strobl
 * @since 1.1
@@ -42,9 +43,10 @@ public @interface Embedded {

 	/**
 	 * Set the load strategy for the embedded object if all contained fields yield {@literal null} values.
-	 * <p />
+	 * <p>
 	 * {@link Nullable @Embedded.Nullable} and {@link Empty @Embedded.Empty} offer shortcuts for this.
-	 *
+	 * </p>
+	 * 
 	 * @return never {@link} null.
 	 */
 	OnEmpty onEmpty();
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/event/BeforeDeleteCallback.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/event/BeforeDeleteCallback.java
@@ -37,7 +37,7 @@ public interface BeforeDeleteCallback<T> extends EntityCallback<T> {
 	 * account for deleting. Only transient fields of the entity should be changed in this callback.
 	 *
 	 * @param aggregate the aggregate.
-	 * @param aggregateChange the associated {@link DefaultAggregateChange}.
+	 * @param aggregateChange the associated {@link MutableAggregateChange}.
 	 * @return the aggregate to be deleted.
 	 */
 	T onBeforeDelete(T aggregate, MutableAggregateChange<T> aggregateChange);
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/AssignValue.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/AssignValue.java
@@ -19,9 +19,9 @@ import org.springframework.util.Assert;

 /**
 * Assign a {@link Expression} to a {@link Column}.
- * <p/>
+ * <p>
 * Results in a rendered assignment: {@code <column> = <value>} (e.g. {@code col = 'foo'}.
- *
+ * </p>
 * @author Mark Paluch
 * @since 1.1
 */
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/AsteriskFromTable.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/AsteriskFromTable.java
@@ -17,8 +17,15 @@ package org.springframework.data.relational.core.sql;

 /**
 * {@link Segment} to select all columns from a {@link Table}.
- * <p/>
- * Renders to: {@code <table>.*} as in {@code SELECT <table>.* FROM …}.
+ * <p>
+ * Renders to: {@code
+ *
+<table>
+ * .*} as in {@code SELECT
+ *
+<table>
+ * .* FROM …}.
+ * </p>
 *
 * @author Mark Paluch
 * @since 1.1
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Between.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Between.java
@@ -19,9 +19,10 @@ import org.springframework.util.Assert;

 /**
 * BETWEEN {@link Condition} comparing between {@link Expression}s.
- * <p/>
+ * <p>
 * Results in a rendered condition: {@code <left> BETWEEN <begin> AND <end>}.
- *
+ * </p>
+ * 
 * @author Mark Paluch
 * @since 2.2
 */
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Column.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Column.java
@@ -20,9 +20,10 @@ import org.springframework.util.Assert;

 /**
 * Column name within a {@code SELECT … FROM} clause.
- * <p/>
+ * <p>
 * Renders to: {@code <name>} or {@code <table(alias)>.<name>}.
- *
+ * </p>
+ * 
 * @author Mark Paluch
 * @author Jens Schauder
 * @since 1.1
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Comparison.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Comparison.java
@@ -19,8 +19,9 @@ import org.springframework.util.Assert;

 /**
 * Comparing {@link Condition} comparing two {@link Expression}s.
- * <p/>
+ * <p>
 * Results in a rendered condition: {@code <left> <comparator> <right>} (e.g. {@code col = 'predicate'}.
+ * </p>
 *
 * @author Mark Paluch
 * @author Jens Schauder
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DeleteValidator.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DeleteValidator.java
@@ -17,9 +17,10 @@ package org.springframework.data.relational.core.sql;

 /**
 * Validator for {@link Delete} statements.
- * <p/>
+ * <p>
 * Validates that all {@link Column}s using a table qualifier have a table import from the {@code FROM} clause.
- *
+ * </p>
+ * 
 * @author Mark Paluch
 * @since 1.1
 */
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Join.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Join.java
@@ -17,12 +17,13 @@ package org.springframework.data.relational.core.sql;

 /**
 * {@link Segment} for a {@code JOIN} declaration.
- * <p/>
+ * <p>
 * Renders to: {@code JOIN
 *
 <table>
 *  ON <condition>}.
- *
+ * </p>
+ * 
 * @author Mark Paluch
 * @since 1.1
 */
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Like.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Like.java
@@ -19,9 +19,9 @@ import org.springframework.util.Assert;

 /**
 * LIKE {@link Condition} comparing two {@link Expression}s.
- * <p/>
+ * <p>
 * Results in a rendered condition: {@code <left> LIKE <right>}.
- *
+ * </p>
 * @author Mark Paluch
 * @since 1.1
 */
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SQL.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SQL.java
@@ -22,9 +22,10 @@ import org.springframework.util.Assert;
 /**
 * Utility to create SQL {@link Segment}s. Typically used as entry point to the Statement Builder. Objects and dependent
 * objects created by the Query AST are immutable except for builders.
- * <p/>
+ * <p>
 * The Statement Builder API is intended for framework usage to produce SQL required for framework operations.
- *
+ * </p>
+ * 
 * @author Mark Paluch
 * @author Jens Schauder
 * @since 1.1
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Segment.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Segment.java
@@ -26,9 +26,10 @@ public interface Segment extends Visitable {

 	/**
 	 * Check whether this {@link Segment} is equal to another {@link Segment}.
-	 * <p/>
+	 * <p>
 	 * Equality is typically given if the {@link #toString()} representation matches.
-	 *
+	 * </p>
+	 * 
 	 * @param other the reference object with which to compare.
 	 * @return {@literal true} if this object is the same as the {@code other} argument; {@literal false} otherwise.
 	 */
@@ -37,10 +38,11 @@ public interface Segment extends Visitable {

 	/**
 	 * Generate a hash code from this{@link Segment}.
-	 * <p/>
+	 * <p>
 	 * Hashcode typically derives from the {@link #toString()} representation so two {@link Segment}s yield the same
 	 * {@link #hashCode()} if their {@link #toString()} representation matches.
-	 *
+	 * </p>
+	 * 
 	 * @return a hash code value for this object.
 	 */
 	@Override
@@ -48,11 +50,12 @@ public interface Segment extends Visitable {

 	/**
 	 * Return a SQL string representation of this {@link Segment}.
-	 * <p/>
+	 * <p>
 	 * The representation is intended for debugging purposes and an approximation to the generated SQL. While it might
 	 * work in the context of a specific dialect, you should not assume that the {@link #toString()} representation works across
 	 * multiple databases.
-	 *
+	 * </p>
+	 * 
 	 * @return a SQL string representation of this {@link Segment}.
 	 */
 	@Override
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SelectValidator.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SelectValidator.java
@@ -21,10 +21,10 @@ import java.util.Stack;

 /**
 * Validator for {@link Select} statements.
- * <p/>
+ * <p>
 * Validates that all {@link Column}s using a table qualifier have a table import from either the {@code FROM} or
 * {@code JOIN} clause.
- *
+ * </p>
 * @author Mark Paluch
 * @author Jens Schauder
 * @since 1.1
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Table.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Table.java
@@ -20,8 +20,9 @@ import org.springframework.util.Assert;
 /**
 * Represents a table reference within a SQL statement. Typically used to denote {@code FROM} or {@code JOIN} or to
 * prefix a {@link Column}.
- * <p/>
+ * <p>
 * Renders to: {@code <name>} or {@code <name> AS <name>}.
+ * </p>
 *
 * @author Mark Paluch
 * @since 1.1
@@ -107,7 +108,6 @@ public class Table extends AbstractSegment implements TableLike {
 		return new AliasedTable(name, alias);
 	}

-
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.relational.core.sql.Named#getName()
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/TableLike.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/TableLike.java
@@ -31,7 +31,7 @@ import org.springframework.util.Assert;
 public interface TableLike extends Segment {
 	/**
 	 * Creates a new {@link Column} associated with this {@link Table}.
-	 * <p/>
+	 * <p>
 	 * Note: This {@link Table} does not track column creation and there is no possibility to enumerate all
 	 * {@link Column}s that were created for this table.
 	 *
@@ -47,7 +47,7 @@ public interface TableLike extends Segment {

 	/**
 	 * Creates a new {@link Column} associated with this {@link Table}.
-	 * <p/>
+	 * <p>
 	 * Note: This {@link Table} does not track column creation and there is no possibility to enumerate all
 	 * {@link Column}s that were created for this table.
 	 *
@@ -64,7 +64,7 @@ public interface TableLike extends Segment {

 	/**
 	 * Creates a {@link List} of {@link Column}s associated with this {@link Table}.
-	 * <p/>
+	 * <p>
 	 * Note: This {@link Table} does not track column creation and there is no possibility to enumerate all
 	 * {@link Column}s that were created for this table.
 	 *
@@ -80,7 +80,7 @@ public interface TableLike extends Segment {

 	/**
 	 * Creates a {@link List} of {@link Column}s associated with this {@link Table}.
-	 * <p/>
+	 * <p>
 	 * Note: This {@link Table} does not track column creation and there is no possibility to enumerate all
 	 * {@link Column}s that were created for this table.
 	 *
@@ -102,7 +102,7 @@ public interface TableLike extends Segment {

 	/**
 	 * Creates a {@link List} of {@link Column}s associated with this {@link Table}.
-	 * <p/>
+	 * <p>
 	 * Note: This {@link Table} does not track column creation and there is no possibility to enumerate all
 	 * {@link Column}s that were created for this table.
 	 *
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/UpdateBuilder.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/UpdateBuilder.java
@@ -29,7 +29,7 @@ public interface UpdateBuilder {
 	/**
 	 * Configure the {@link Table} to which the update is applied.
 	 *
-	 * @param count the top count.
+	 * @param table the table to update.
 	 * @return {@code this} {@link SelectBuilder}.
 	 */
 	UpdateAssign table(Table table);
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/package-info.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/package-info.java
@@ -3,9 +3,10 @@
 * Statement Builder implementation. Use {@link org.springframework.data.relational.core.sql.StatementBuilder} to create
 * statements and {@link org.springframework.data.relational.core.sql.SQL} to create SQL objects. Objects and dependent
 * objects created by the Statement Builder are immutable except for builders.
- * <p/>
+ * <p>
 * The Statement Builder API is intended for framework usage to produce SQL required for framework operations.
- *
+ * </p>
+ * 
 * @since 1.1
 */
@NonNullApi
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/DelegatingVisitor.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/DelegatingVisitor.java
@@ -26,18 +26,21 @@ import org.springframework.util.Assert;
 * Abstract base class for delegating {@link Visitor} implementations. This class implements a delegation pattern using
 * visitors. A delegating {@link Visitor} can implement {@link #doEnter(Visitable)} and {@link #doLeave(Visitable)}
 * methods to provide its functionality.
- * <p/>
+ * <p>
 * <h3>Delegation</h3> Typically, a {@link Visitor} is scoped to a single responsibility. If a {@link Visitor segment}
 * requires {@link #doEnter(Visitable) processing} that is not directly implemented by the visitor itself, the current
 * {@link Visitor} can delegate processing to a {@link DelegatingVisitor delegate}. Once a delegation is installed, the
 * {@link DelegatingVisitor delegate} is used as {@link Visitor} for the current and all subsequent items until it
 * {@link #doLeave(Visitable) signals} that it is no longer responsible.
- * <p/>
+ * </p>
+ * <p>
 * Nested visitors are required to properly signal once they are no longer responsible for a {@link Visitor segment} to
 * step back from the delegation. Otherwise, parents are no longer involved in the visitation.
- * <p/>
+ * </p>
+ * <p>
 * Delegation is recursive and limited by the stack size.
- *
+ * </p>
+ * 
 * @author Mark Paluch
 * @since 1.1
 * @see FilteredSubtreeVisitor
@@ -49,11 +52,12 @@ abstract class DelegatingVisitor implements Visitor {

 	/**
 	 * Invoked for a {@link Visitable segment} when entering the segment.
-	 * <p/>
+	 * <p>
 	 * This method can signal whether it is responsible for handling the {@link Visitor segment} or whether the segment
 	 * requires delegation to a sub-{@link Visitor}. When delegating to a sub-{@link Visitor}, {@link #doEnter(Visitable)}
 	 * is called on the {@link DelegatingVisitor delegate}.
-	 *
+	 * </p>
+	 * 
 	 * @param segment must not be {@literal null}.
 	 * @return
 	 */
@@ -86,11 +90,12 @@ abstract class DelegatingVisitor implements Visitor {

 	/**
 	 * Invoked for a {@link Visitable segment} when leaving the segment.
-	 * <p/>
+	 * <p>
 	 * This method can signal whether this {@link Visitor} should remain responsible for handling subsequent
 	 * {@link Visitor segments} or whether it should step back from delegation. When stepping back from delegation,
 	 * {@link #doLeave(Visitable)} is called on the {@link DelegatingVisitor parent delegate}.
-	 *
+	 * </p>
+	 * 
 	 * @param segment must not be {@literal null}.
 	 * @return
 	 */
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/FilteredSubtreeVisitor.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/FilteredSubtreeVisitor.java
@@ -25,7 +25,7 @@ import org.springframework.lang.Nullable;
 * Filtering {@link DelegatingVisitor visitor} applying a {@link Predicate filter}. Typically used as base class for
 * {@link Visitor visitors} that wish to apply hierarchical processing based on a well-defined entry {@link Visitor
 * segment}.
- * <p/>
+ * <p>
 * Filtering is a three-way process:
 * <ol>
 * <li>Ignores elements that do not match the filter {@link Predicate}.</li>
@@ -35,7 +35,8 @@ import org.springframework.lang.Nullable;
 * children of the matched {@link Visitable} until {@link #leaveMatched(Visitable) leaving the matched}
 * {@link Visitable}.</li>
 * </ol>
- *
+ * </p>
+ * 
 * @author Mark Paluch
 * @see TypedSubtreeVisitor
 * @since 1.1
--- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/TypedSubtreeVisitor.java
+++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/TypedSubtreeVisitor.java
@@ -26,7 +26,7 @@ import org.springframework.lang.Nullable;
 * Type-filtering {@link DelegatingVisitor visitor} applying a {@link Class type filter} derived from the generic type
 * parameter. Typically used as base class for {@link Visitor visitors} that wish to apply hierarchical processing based
 * on a well-defined entry {@link Visitor segment}.
- * <p/>
+ * <p>
 * Filtering is a three-way process:
 * <ol>
 * <li>Ignores elements that do not match the filter {@link Predicate}.</li>
@@ -36,7 +36,8 @@ import org.springframework.lang.Nullable;
 * children of the matched {@link Visitable} until {@link #leaveMatched(Visitable) leaving the matched}
 * {@link Visitable}.</li>
 * </ol>
- *
+ * </p>
+ * 
 * @author Mark Paluch
 * @since 1.1
 * @see FilteredSubtreeVisitor