Skip to content

Commit f1aa9c2

Browse files
schauderchristophstrobl
authored andcommitted
Fix JavaDoc.
Self closing <p/> tags cause build failures now. Closes #1059
1 parent 6b538d0 commit f1aa9c2

20 files changed

+76
-51
lines changed

spring-data-relational/src/main/java/org/springframework/data/relational/core/conversion/DbAction.java

+3-4
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ public String toString() {
236236
* <p>
237237
* Note that deletes for contained entities that reference the root are to be represented by separate
238238
* {@link DbAction}s.
239-
*
239+
* </p>
240240
* @param <T> type of the entity for which this represents a database interaction.
241241
*/
242242
final class DeleteRoot<T> implements DbAction<T> {
@@ -300,7 +300,7 @@ public String toString() {
300300
* <p>
301301
* Note that deletes for contained entities that reference the root are to be represented by separate
302302
* {@link DbAction}s.
303-
*
303+
* </p>
304304
* @param <T> type of the entity for which this represents a database interaction.
305305
*/
306306
final class DeleteAllRoot<T> implements DbAction<T> {
@@ -322,7 +322,6 @@ public String toString() {
322322

323323
/**
324324
* Represents an acquire lock statement for a aggregate root when only the ID is known.
325-
* <p>
326325
*
327326
* @param <T> type of the entity for which this represents a database interaction.
328327
*/
@@ -392,7 +391,7 @@ interface WithDependingOn<T> extends WithPropertyPath<T>, WithEntity<T> {
392391
* Additional values to be set during insert or update statements.
393392
* <p>
394393
* Values come from parent entities but one might also add values manually.
395-
*
394+
* </p>
396395
* @return guaranteed to be not {@code null}.
397396
*/
398397
Map<PersistentPropertyPath<RelationalPersistentProperty>, Object> getQualifiers();

spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/Embedded.java

+6-4
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@
2727

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

4344
/**
4445
* Set the load strategy for the embedded object if all contained fields yield {@literal null} values.
45-
* <p />
46+
* <p>
4647
* {@link Nullable @Embedded.Nullable} and {@link Empty @Embedded.Empty} offer shortcuts for this.
47-
*
48+
* </p>
49+
*
4850
* @return never {@link} null.
4951
*/
5052
OnEmpty onEmpty();

spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/event/BeforeDeleteCallback.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public interface BeforeDeleteCallback<T> extends EntityCallback<T> {
3737
* account for deleting. Only transient fields of the entity should be changed in this callback.
3838
*
3939
* @param aggregate the aggregate.
40-
* @param aggregateChange the associated {@link DefaultAggregateChange}.
40+
* @param aggregateChange the associated {@link MutableAggregateChange}.
4141
* @return the aggregate to be deleted.
4242
*/
4343
T onBeforeDelete(T aggregate, MutableAggregateChange<T> aggregateChange);

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/AssignValue.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
/**
2121
* Assign a {@link Expression} to a {@link Column}.
22-
* <p/>
22+
* <p>
2323
* Results in a rendered assignment: {@code <column> = <value>} (e.g. {@code col = 'foo'}.
24-
*
24+
* </p>
2525
* @author Mark Paluch
2626
* @since 1.1
2727
*/

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/AsteriskFromTable.java

+9-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,15 @@
1717

1818
/**
1919
* {@link Segment} to select all columns from a {@link Table}.
20-
* <p/>
21-
* Renders to: {@code <table>.*} as in {@code SELECT <table>.* FROM …}.
20+
* <p>
21+
* Renders to: {@code
22+
*
23+
<table>
24+
* .*} as in {@code SELECT
25+
*
26+
<table>
27+
* .* FROM …}.
28+
* </p>
2229
*
2330
* @author Mark Paluch
2431
* @since 1.1

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Between.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@
1919

2020
/**
2121
* BETWEEN {@link Condition} comparing between {@link Expression}s.
22-
* <p/>
22+
* <p>
2323
* Results in a rendered condition: {@code <left> BETWEEN <begin> AND <end>}.
24-
*
24+
* </p>
25+
*
2526
* @author Mark Paluch
2627
* @since 2.2
2728
*/

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Column.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@
2020

2121
/**
2222
* Column name within a {@code SELECT … FROM} clause.
23-
* <p/>
23+
* <p>
2424
* Renders to: {@code <name>} or {@code <table(alias)>.<name>}.
25-
*
25+
* </p>
26+
*
2627
* @author Mark Paluch
2728
* @author Jens Schauder
2829
* @since 1.1

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Comparison.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@
1919

2020
/**
2121
* Comparing {@link Condition} comparing two {@link Expression}s.
22-
* <p/>
22+
* <p>
2323
* Results in a rendered condition: {@code <left> <comparator> <right>} (e.g. {@code col = 'predicate'}.
24+
* </p>
2425
*
2526
* @author Mark Paluch
2627
* @author Jens Schauder

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DeleteValidator.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@
1717

1818
/**
1919
* Validator for {@link Delete} statements.
20-
* <p/>
20+
* <p>
2121
* Validates that all {@link Column}s using a table qualifier have a table import from the {@code FROM} clause.
22-
*
22+
* </p>
23+
*
2324
* @author Mark Paluch
2425
* @since 1.1
2526
*/

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Join.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,13 @@
1717

1818
/**
1919
* {@link Segment} for a {@code JOIN} declaration.
20-
* <p/>
20+
* <p>
2121
* Renders to: {@code JOIN
2222
*
2323
<table>
2424
* ON <condition>}.
25-
*
25+
* </p>
26+
*
2627
* @author Mark Paluch
2728
* @since 1.1
2829
*/

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Like.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
/**
2121
* LIKE {@link Condition} comparing two {@link Expression}s.
22-
* <p/>
22+
* <p>
2323
* Results in a rendered condition: {@code <left> LIKE <right>}.
24-
*
24+
* </p>
2525
* @author Mark Paluch
2626
* @since 1.1
2727
*/

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SQL.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@
2222
/**
2323
* Utility to create SQL {@link Segment}s. Typically used as entry point to the Statement Builder. Objects and dependent
2424
* objects created by the Query AST are immutable except for builders.
25-
* <p/>
25+
* <p>
2626
* The Statement Builder API is intended for framework usage to produce SQL required for framework operations.
27-
*
27+
* </p>
28+
*
2829
* @author Mark Paluch
2930
* @author Jens Schauder
3031
* @since 1.1

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Segment.java

+9-6
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,10 @@ public interface Segment extends Visitable {
2626

2727
/**
2828
* Check whether this {@link Segment} is equal to another {@link Segment}.
29-
* <p/>
29+
* <p>
3030
* Equality is typically given if the {@link #toString()} representation matches.
31-
*
31+
* </p>
32+
*
3233
* @param other the reference object with which to compare.
3334
* @return {@literal true} if this object is the same as the {@code other} argument; {@literal false} otherwise.
3435
*/
@@ -37,22 +38,24 @@ public interface Segment extends Visitable {
3738

3839
/**
3940
* Generate a hash code from this{@link Segment}.
40-
* <p/>
41+
* <p>
4142
* Hashcode typically derives from the {@link #toString()} representation so two {@link Segment}s yield the same
4243
* {@link #hashCode()} if their {@link #toString()} representation matches.
43-
*
44+
* </p>
45+
*
4446
* @return a hash code value for this object.
4547
*/
4648
@Override
4749
int hashCode();
4850

4951
/**
5052
* Return a SQL string representation of this {@link Segment}.
51-
* <p/>
53+
* <p>
5254
* The representation is intended for debugging purposes and an approximation to the generated SQL. While it might
5355
* work in the context of a specific dialect, you should not that the {@link #toString()} representation works across
5456
* multiple databases.
55-
*
57+
* </p>
58+
*
5659
* @return a SQL string representation of this {@link Segment}.
5760
*/
5861
@Override

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SelectValidator.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@
2121

2222
/**
2323
* Validator for {@link Select} statements.
24-
* <p/>
24+
* <p>
2525
* Validates that all {@link Column}s using a table qualifier have a table import from either the {@code FROM} or
2626
* {@code JOIN} clause.
27-
*
27+
* </p>
2828
* @author Mark Paluch
2929
* @author Jens Schauder
3030
* @since 1.1

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Table.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@
2020
/**
2121
* Represents a table reference within a SQL statement. Typically used to denote {@code FROM} or {@code JOIN} or to
2222
* prefix a {@link Column}.
23-
* <p/>
23+
* <p>
2424
* Renders to: {@code <name>} or {@code <name> AS <name>}.
25+
* </p>
2526
*
2627
* @author Mark Paluch
2728
* @since 1.1
@@ -107,7 +108,6 @@ public Table as(SqlIdentifier alias) {
107108
return new AliasedTable(name, alias);
108109
}
109110

110-
111111
/*
112112
* (non-Javadoc)
113113
* @see org.springframework.data.relational.core.sql.Named#getName()

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/UpdateBuilder.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public interface UpdateBuilder {
2929
/**
3030
* Configure the {@link Table} to which the update is applied.
3131
*
32-
* @param count the top count.
32+
* @param table the table to update.
3333
* @return {@code this} {@link SelectBuilder}.
3434
*/
3535
UpdateAssign table(Table table);

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/package-info.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
* Statement Builder implementation. Use {@link org.springframework.data.relational.core.sql.StatementBuilder} to create
44
* statements and {@link org.springframework.data.relational.core.sql.SQL} to create SQL objects. Objects and dependent
55
* objects created by the Statement Builder are immutable except for builders.
6-
* <p/>
6+
* <p>
77
* The Statement Builder API is intended for framework usage to produce SQL required for framework operations.
8-
*
8+
* </p>
9+
*
910
* @since 1.1
1011
*/
1112
@NonNullApi

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/DelegatingVisitor.java

+13-8
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,21 @@
2626
* Abstract base class for delegating {@link Visitor} implementations. This class implements a delegation pattern using
2727
* visitors. A delegating {@link Visitor} can implement {@link #doEnter(Visitable)} and {@link #doLeave(Visitable)}
2828
* methods to provide its functionality.
29-
* <p/>
29+
* <p>
3030
* <h3>Delegation</h3> Typically, a {@link Visitor} is scoped to a single responsibility. If a {@link Visitor segment}
3131
* requires {@link #doEnter(Visitable) processing} that is not directly implemented by the visitor itself, the current
3232
* {@link Visitor} can delegate processing to a {@link DelegatingVisitor delegate}. Once a delegation is installed, the
3333
* {@link DelegatingVisitor delegate} is used as {@link Visitor} for the current and all subsequent items until it
3434
* {@link #doLeave(Visitable) signals} that it is no longer responsible.
35-
* <p/>
35+
* </p>
36+
* <p>
3637
* Nested visitors are required to properly signal once they are no longer responsible for a {@link Visitor segment} to
3738
* step back from the delegation. Otherwise, parents are no longer involved in the visitation.
38-
* <p/>
39+
* </p>
40+
* <p>
3941
* Delegation is recursive and limited by the stack size.
40-
*
42+
* </p>
43+
*
4144
* @author Mark Paluch
4245
* @since 1.1
4346
* @see FilteredSubtreeVisitor
@@ -49,11 +52,12 @@ abstract class DelegatingVisitor implements Visitor {
4952

5053
/**
5154
* Invoked for a {@link Visitable segment} when entering the segment.
52-
* <p/>
55+
* <p>
5356
* This method can signal whether it is responsible for handling the {@link Visitor segment} or whether the segment
5457
* requires delegation to a sub-{@link Visitor}. When delegating to a sub-{@link Visitor}, {@link #doEnter(Visitable)}
5558
* is called on the {@link DelegatingVisitor delegate}.
56-
*
59+
* </p>
60+
*
5761
* @param segment must not be {@literal null}.
5862
* @return
5963
*/
@@ -86,11 +90,12 @@ public final void enter(Visitable segment) {
8690

8791
/**
8892
* Invoked for a {@link Visitable segment} when leaving the segment.
89-
* <p/>
93+
* <p>
9094
* This method can signal whether this {@link Visitor} should remain responsible for handling subsequent
9195
* {@link Visitor segments} or whether it should step back from delegation. When stepping back from delegation,
9296
* {@link #doLeave(Visitable)} is called on the {@link DelegatingVisitor parent delegate}.
93-
*
97+
* </p>
98+
*
9499
* @param segment must not be {@literal null}.
95100
* @return
96101
*/

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/FilteredSubtreeVisitor.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
* Filtering {@link DelegatingVisitor visitor} applying a {@link Predicate filter}. Typically used as base class for
2626
* {@link Visitor visitors} that wish to apply hierarchical processing based on a well-defined entry {@link Visitor
2727
* segment}.
28-
* <p/>
28+
* <p>
2929
* Filtering is a three-way process:
3030
* <ol>
3131
* <li>Ignores elements that do not match the filter {@link Predicate}.</li>
@@ -35,7 +35,8 @@
3535
* children of the matched {@link Visitable} until {@link #leaveMatched(Visitable) leaving the matched}
3636
* {@link Visitable}.</li>
3737
* </ol>
38-
*
38+
* </p>
39+
*
3940
* @author Mark Paluch
4041
* @see TypedSubtreeVisitor
4142
* @since 1.1

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/render/TypedSubtreeVisitor.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
* Type-filtering {@link DelegatingVisitor visitor} applying a {@link Class type filter} derived from the generic type
2727
* parameter. Typically used as base class for {@link Visitor visitors} that wish to apply hierarchical processing based
2828
* on a well-defined entry {@link Visitor segment}.
29-
* <p/>
29+
* <p>
3030
* Filtering is a three-way process:
3131
* <ol>
3232
* <li>Ignores elements that do not match the filter {@link Predicate}.</li>
@@ -36,7 +36,8 @@
3636
* children of the matched {@link Visitable} until {@link #leaveMatched(Visitable) leaving the matched}
3737
* {@link Visitable}.</li>
3838
* </ol>
39-
*
39+
* </p>
40+
*
4041
* @author Mark Paluch
4142
* @since 1.1
4243
* @see FilteredSubtreeVisitor

0 commit comments

Comments
 (0)