Browse Source

Polishing.

Tweak Javadoc comments.

See #2585
pull/2592/head
Mark Paluch 4 years ago
parent
commit
0ae04a219e
No known key found for this signature in database
GPG Key ID: 4406B84C1661DCD1
  1. 2
      src/main/java/org/springframework/data/domain/ExampleMatcher.java
  2. 6
      src/main/java/org/springframework/data/domain/Sort.java
  3. 10
      src/test/java/org/springframework/data/domain/SortUnitTests.java

2
src/main/java/org/springframework/data/domain/ExampleMatcher.java

@ -497,7 +497,7 @@ public interface ExampleMatcher {
} }
/** /**
* Creates a {@link GenericPropertyMatcher} that matches string case sensitive. * Creates a {@link GenericPropertyMatcher} that matches string case-sensitive.
* *
* @return * @return
*/ */

6
src/main/java/org/springframework/data/domain/Sort.java

@ -285,7 +285,7 @@ public class Sort implements Streamable<org.springframework.data.domain.Sort.Ord
* *
* @author Oliver Gierke * @author Oliver Gierke
*/ */
public static enum Direction { public enum Direction {
ASC, DESC; ASC, DESC;
@ -447,7 +447,7 @@ public class Sort implements Streamable<org.springframework.data.domain.Sort.Ord
* *
* @param direction can be {@literal null}, will default to {@link Sort#DEFAULT_DIRECTION} * @param direction can be {@literal null}, will default to {@link Sort#DEFAULT_DIRECTION}
* @param property must not be {@literal null} or empty. * @param property must not be {@literal null} or empty.
* @param ignoreCase true if sorting should be case insensitive. false if sorting should be case sensitive. * @param ignoreCase true if sorting should be case-insensitive. false if sorting should be case-sensitive.
* @param nullHandling must not be {@literal null}. * @param nullHandling must not be {@literal null}.
* @since 1.7 * @since 1.7
*/ */
@ -501,7 +501,7 @@ public class Sort implements Streamable<org.springframework.data.domain.Sort.Ord
} }
/** /**
* Returns whether or not the sort will be case sensitive. * Returns whether the sort will be case-sensitive or case-insensitive.
* *
* @return * @return
*/ */

10
src/test/java/org/springframework/data/domain/SortUnitTests.java

@ -40,8 +40,6 @@ class SortUnitTests {
/** /**
* Asserts that the class applies the default sort order if no order or {@code null} was provided. * Asserts that the class applies the default sort order if no order or {@code null} was provided.
*
* @throws Exception
*/ */
@Test @Test
void appliesDefaultForOrder() { void appliesDefaultForOrder() {
@ -50,8 +48,6 @@ class SortUnitTests {
/** /**
* Asserts that the class rejects {@code null} as properties array. * Asserts that the class rejects {@code null} as properties array.
*
* @throws Exception
*/ */
@Test @Test
@SuppressWarnings("null") @SuppressWarnings("null")
@ -61,8 +57,6 @@ class SortUnitTests {
/** /**
* Asserts that the class rejects {@code null} values in the properties array. * Asserts that the class rejects {@code null} values in the properties array.
*
* @throws Exception
*/ */
@Test @Test
void preventsNullProperty() { void preventsNullProperty() {
@ -71,8 +65,6 @@ class SortUnitTests {
/** /**
* Asserts that the class rejects empty strings in the properties array. * Asserts that the class rejects empty strings in the properties array.
*
* @throws Exception
*/ */
@Test @Test
void preventsEmptyProperty() { void preventsEmptyProperty() {
@ -81,8 +73,6 @@ class SortUnitTests {
/** /**
* Asserts that the class rejects no properties given at all. * Asserts that the class rejects no properties given at all.
*
* @throws Exception
*/ */
@Test @Test
void preventsNoProperties() { void preventsNoProperties() {

Loading…
Cancel
Save