Skip to content

Commit 1a79514

Browse files
committed
Polishing.
Refine Javadoc. See #4203 Original pull request: #4024
1 parent 1f2da5e commit 1a79514

File tree

5 files changed

+25
-33
lines changed

5 files changed

+25
-33
lines changed

spring-data-jpa/src/main/java/org/springframework/data/jpa/domain/DeleteSpecification.java

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,11 @@ public interface DeleteSpecification<T> extends Serializable {
5151
/**
5252
* Simple static factory method to create a specification which does not participate in matching. The specification
5353
* returned is {@code null}-like, and is elided in all operations.
54-
*
55-
* <pre>
56-
* {@code
54+
*
55+
* <pre class="code">
5756
* unrestricted().and(other) // consider only `other`
5857
* unrestricted().or(other) // consider only `other`
5958
* not(unrestricted()) // equivalent to `unrestricted()`
60-
* }
6159
* </pre>
6260
*
6361
* @param <T> the type of the {@link Root} the resulting {@literal DeleteSpecification} operates on.
@@ -177,7 +175,7 @@ static <T> DeleteSpecification<T> not(DeleteSpecification<T> spec) {
177175

178176
/**
179177
* Applies an AND operation to all the given {@link DeleteSpecification}s. If {@code specifications} is empty, the
180-
* resulting {@link DeleteSpecification} will be unrestricted applying to all objects.
178+
* resulting {@link DeleteSpecification} will be {@link #unrestricted()} applying to all objects.
181179
*
182180
* @param specifications the {@link DeleteSpecification}s to compose.
183181
* @return the conjunction of the specifications.
@@ -191,7 +189,7 @@ static <T> DeleteSpecification<T> allOf(DeleteSpecification<T>... specifications
191189

192190
/**
193191
* Applies an AND operation to all the given {@link DeleteSpecification}s. If {@code specifications} is empty, the
194-
* resulting {@link DeleteSpecification} will be unrestricted applying to all objects.
192+
* resulting {@link DeleteSpecification} will be {@link #unrestricted()} applying to all objects.
195193
*
196194
* @param specifications the {@link DeleteSpecification}s to compose.
197195
* @return the conjunction of the specifications.
@@ -206,7 +204,7 @@ static <T> DeleteSpecification<T> allOf(Iterable<DeleteSpecification<T>> specifi
206204

207205
/**
208206
* Applies an OR operation to all the given {@link DeleteSpecification}s. If {@code specifications} is empty, the
209-
* resulting {@link DeleteSpecification} will be unrestricted applying to all objects.
207+
* resulting {@link DeleteSpecification} will be {@link #unrestricted()} applying to all objects.
210208
*
211209
* @param specifications the {@link DeleteSpecification}s to compose.
212210
* @return the disjunction of the specifications.
@@ -220,7 +218,7 @@ static <T> DeleteSpecification<T> anyOf(DeleteSpecification<T>... specifications
220218

221219
/**
222220
* Applies an OR operation to all the given {@link DeleteSpecification}s. If {@code specifications} is empty, the
223-
* resulting {@link DeleteSpecification} will be unrestricted applying to all objects.
221+
* resulting {@link DeleteSpecification} will be {@link #unrestricted()} applying to all objects.
224222
*
225223
* @param specifications the {@link DeleteSpecification}s to compose.
226224
* @return the disjunction of the specifications.

spring-data-jpa/src/main/java/org/springframework/data/jpa/domain/PredicateSpecification.java

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,11 @@ public interface PredicateSpecification<T> extends Serializable {
5050
/**
5151
* Simple static factory method to create a specification which does not participate in matching. The specification
5252
* returned is {@code null}-like, and is elided in all operations.
53-
*
54-
* <pre>
55-
* {@code
53+
*
54+
* <pre class="code">
5655
* unrestricted().and(other) // consider only `other`
5756
* unrestricted().or(other) // consider only `other`
5857
* not(unrestricted()) // equivalent to `unrestricted()`
59-
* }
6058
* </pre>
6159
*
6260
* @param <T> the type of the {@link Root} the resulting {@literal PredicateSpecification} operates on.
@@ -131,7 +129,7 @@ static <T> PredicateSpecification<T> not(PredicateSpecification<T> spec) {
131129

132130
/**
133131
* Applies an AND operation to all the given {@link PredicateSpecification}s. If {@code specifications} is empty, the
134-
* resulting {@link PredicateSpecification} will be unrestricted applying to all objects.
132+
* resulting {@link PredicateSpecification} will be {@link #unrestricted()} applying to all objects.
135133
*
136134
* @param specifications the {@link PredicateSpecification}s to compose.
137135
* @return the conjunction of the specifications.
@@ -145,7 +143,7 @@ static <T> PredicateSpecification<T> allOf(PredicateSpecification<T>... specific
145143

146144
/**
147145
* Applies an AND operation to all the given {@link PredicateSpecification}s. If {@code specifications} is empty, the
148-
* resulting {@link PredicateSpecification} will be unrestricted applying to all objects.
146+
* resulting {@link PredicateSpecification} will be {@link #unrestricted()} applying to all objects.
149147
*
150148
* @param specifications the {@link PredicateSpecification}s to compose.
151149
* @return the conjunction of the specifications.
@@ -160,7 +158,7 @@ static <T> PredicateSpecification<T> allOf(Iterable<PredicateSpecification<T>> s
160158

161159
/**
162160
* Applies an OR operation to all the given {@link PredicateSpecification}s. If {@code specifications} is empty, the
163-
* resulting {@link PredicateSpecification} will be unrestricted applying to all objects.
161+
* resulting {@link PredicateSpecification} will be {@link #unrestricted()} applying to all objects.
164162
*
165163
* @param specifications the {@link PredicateSpecification}s to compose.
166164
* @return the disjunction of the specifications.
@@ -174,7 +172,7 @@ static <T> PredicateSpecification<T> anyOf(PredicateSpecification<T>... specific
174172

175173
/**
176174
* Applies an OR operation to all the given {@link PredicateSpecification}s. If {@code specifications} is empty, the
177-
* resulting {@link PredicateSpecification} will be unrestricted applying to all objects.
175+
* resulting {@link PredicateSpecification} will be {@link #unrestricted()} applying to all objects.
178176
*
179177
* @param specifications the {@link PredicateSpecification}s to compose.
180178
* @return the disjunction of the specifications.

spring-data-jpa/src/main/java/org/springframework/data/jpa/domain/Specification.java

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,11 @@ public interface Specification<T> extends Serializable {
5858
/**
5959
* Simple static factory method to create a specification which does not participate in matching. The specification
6060
* returned is {@code null}-like, and is elided in all operations.
61-
*
62-
* <pre>
63-
* {@code
61+
*
62+
* <pre class="code">
6463
* unrestricted().and(other) // consider only `other`
6564
* unrestricted().or(other) // consider only `other`
6665
* not(unrestricted()) // equivalent to `unrestricted()`
67-
* }
6866
* </pre>
6967
*
7068
* @param <T> the type of the {@link Root} the resulting {@literal Specification} operates on.
@@ -192,7 +190,7 @@ static <T> Specification<T> not(Specification<T> spec) {
192190

193191
/**
194192
* Applies an AND operation to all the given {@link Specification}s. If {@code specifications} is empty, the resulting
195-
* {@link Specification} will be unrestricted applying to all objects.
193+
* {@link Specification} will be {@link #unrestricted()} applying to all objects.
196194
*
197195
* @param specifications the {@link Specification}s to compose.
198196
* @return the conjunction of the specifications.
@@ -207,7 +205,7 @@ static <T> Specification<T> allOf(Specification<T>... specifications) {
207205

208206
/**
209207
* Applies an AND operation to all the given {@link Specification}s. If {@code specifications} is empty, the resulting
210-
* {@link Specification} will be unrestricted applying to all objects.
208+
* {@link Specification} will be {@link #unrestricted()} applying to all objects.
211209
*
212210
* @param specifications the {@link Specification}s to compose.
213211
* @return the conjunction of the specifications.
@@ -223,7 +221,7 @@ static <T> Specification<T> allOf(Iterable<Specification<T>> specifications) {
223221

224222
/**
225223
* Applies an OR operation to all the given {@link Specification}s. If {@code specifications} is empty, the resulting
226-
* {@link Specification} will be unrestricted applying to all objects.
224+
* {@link Specification} will be {@link #unrestricted()} applying to all objects.
227225
*
228226
* @param specifications the {@link Specification}s to compose.
229227
* @return the disjunction of the specifications
@@ -238,7 +236,7 @@ static <T> Specification<T> anyOf(Specification<T>... specifications) {
238236

239237
/**
240238
* Applies an OR operation to all the given {@link Specification}s. If {@code specifications} is empty, the resulting
241-
* {@link Specification} will be unrestricted applying to all objects.
239+
* {@link Specification} will be {@link #unrestricted()} applying to all objects.
242240
*
243241
* @param specifications the {@link Specification}s to compose.
244242
* @return the disjunction of the specifications

spring-data-jpa/src/main/java/org/springframework/data/jpa/domain/SpecificationComposition.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@
3434
* @author Oliver Gierke
3535
* @author Jens Schauder
3636
* @author Mark Paluch
37-
* @see Specification
3837
* @since 2.2
38+
* @see Specification
3939
*/
4040
class SpecificationComposition {
4141

spring-data-jpa/src/main/java/org/springframework/data/jpa/domain/UpdateSpecification.java

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,11 @@ public interface UpdateSpecification<T> extends Serializable {
5151
/**
5252
* Simple static factory method to create a specification which does not participate in matching. The specification
5353
* returned is {@code null}-like, and is elided in all operations.
54-
*
55-
* <pre>
56-
* {@code
54+
*
55+
* <pre class="code">
5756
* unrestricted().and(other) // consider only `other`
5857
* unrestricted().or(other) // consider only `other`
5958
* not(unrestricted()) // equivalent to `unrestricted()`
60-
* }
6159
* </pre>
6260
*
6361
* @param <T> the type of the {@link Root} the resulting {@literal UpdateSpecification} operates on.
@@ -198,7 +196,7 @@ static <T> UpdateSpecification<T> not(UpdateSpecification<T> spec) {
198196

199197
/**
200198
* Applies an AND operation to all the given {@link UpdateSpecification}s. If {@code specifications} is empty, the
201-
* resulting {@link UpdateSpecification} will be unrestricted applying to all objects.
199+
* resulting {@link UpdateSpecification} will be {@link #unrestricted()} applying to all objects.
202200
*
203201
* @param specifications the {@link UpdateSpecification}s to compose.
204202
* @return the conjunction of the specifications.
@@ -212,7 +210,7 @@ static <T> UpdateSpecification<T> allOf(UpdateSpecification<T>... specifications
212210

213211
/**
214212
* Applies an AND operation to all the given {@link UpdateSpecification}s. If {@code specifications} is empty, the
215-
* resulting {@link UpdateSpecification} will be unrestricted applying to all objects.
213+
* resulting {@link UpdateSpecification} will be {@link #unrestricted()} applying to all objects.
216214
*
217215
* @param specifications the {@link UpdateSpecification}s to compose.
218216
* @return the conjunction of the specifications.
@@ -227,7 +225,7 @@ static <T> UpdateSpecification<T> allOf(Iterable<UpdateSpecification<T>> specifi
227225

228226
/**
229227
* Applies an OR operation to all the given {@link UpdateSpecification}s. If {@code specifications} is empty, the
230-
* resulting {@link UpdateSpecification} will be unrestricted applying to all objects.
228+
* resulting {@link UpdateSpecification} will be {@link #unrestricted()} applying to all objects.
231229
*
232230
* @param specifications the {@link UpdateSpecification}s to compose.
233231
* @return the disjunction of the specifications.
@@ -241,7 +239,7 @@ static <T> UpdateSpecification<T> anyOf(UpdateSpecification<T>... specifications
241239

242240
/**
243241
* Applies an OR operation to all the given {@link UpdateSpecification}s. If {@code specifications} is empty, the
244-
* resulting {@link UpdateSpecification} will be unrestricted applying to all objects.
242+
* resulting {@link UpdateSpecification} will be {@link #unrestricted()} applying to all objects.
245243
*
246244
* @param specifications the {@link UpdateSpecification}s to compose.
247245
* @return the disjunction of the specifications.

0 commit comments

Comments
 (0)