DATAMONGO-2112 - Polishing.

Align Indexed(expireAfter) default to empty string according to the documentation. Slightly reword Javadoc.

Author: mp911de

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/Indexed.java

@@ -136,27 +136,29 @@
 	int expireAfterSeconds() default -1;
 
 	/**
-	 * Alternative for {@link #expireAfterSeconds()} to configure the timeout after which the collection should expire.
-	 * Defaults to an empty String for no expiry. Accepts numeric values followed by their unit of measure (d(ays),
-	 * h(ours), m(inutes), s(seconds)) or a Spring {@literal template expression}. The expression can result in a a valid
-	 * expiration {@link String} following the conventions already mentioned or a {@link java.time.Duration}.
+	 * Alternative for {@link #expireAfterSeconds()} to configure the timeout after which the document should expire.
+	 * Defaults to an empty {@link String} for no expiry. Accepts numeric values followed by their unit of measure:
+	 * <ul>
+	 * <li><b>d</b>: Days</li>
+	 * <li><b>h</b>: Hours</li>
+	 * <li><b>m</b>: Minutes</li>
+	 * <li><b>s</b>: Seconds</li>
+	 * <li>Alternatively: A Spring {@literal template expression}. The expression can result in a
+	 * {@link java.time.Duration} or a valid expiration {@link String} according to the already mentioned
+	 * conventions.</li>
+	 * </ul>
 	 *
-	 * <pre>
-	 *     <code>
+	 * <pre class="code">
 	 *
-	 * &#0064;Indexed(expireAfter = "10s")
-	 * String expireAfterTenSeconds;
+	 * &#0064;Indexed(expireAfter = "10s") String expireAfterTenSeconds;
 	 *
-	 * &#0064;Indexed(expireAfter = "1d")
-	 * String expireAfterOneDay;
+	 * &#0064;Indexed(expireAfter = "1d") String expireAfterOneDay;
 	 *
-	 * &#0064;Indexed(expireAfter = "#{&#0064;mySpringBean.timeout}")
-	 * String expireAfterTimeoutObtainedFromSpringBean;
-	 *     </code>
+	 * &#0064;Indexed(expireAfter = "#{&#0064;mySpringBean.timeout}") String expireAfterTimeoutObtainedFromSpringBean;
 	 * </pre>
 	 *
-	 * @return {@literal 0s} by default.
+	 * @return empty by default.
 	 * @since 2.2
 	 */
-	String expireAfter() default "0s";
+	String expireAfter() default "";
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/MongoPersistentEntityIndexResolver.java

@@ -35,6 +35,7 @@
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+
 import org.springframework.dao.InvalidDataAccessApiUsageException;
 import org.springframework.data.domain.Sort;
 import org.springframework.data.mapping.Association;
@@ -450,11 +451,11 @@ protected IndexDefinitionHolder createIndexDefinition(String dotPath, String col
 			indexDefinition.expire(index.expireAfterSeconds(), TimeUnit.SECONDS);
 		}
 
-		if (!index.expireAfter().isEmpty() && !index.expireAfter().equals("0s")) {
+		if (StringUtils.hasText(index.expireAfter())) {
 
 			if (index.expireAfterSeconds() >= 0) {
 				throw new IllegalStateException(String.format(
-						"@Indexed already defines an expiration timeout of %s sec. via Indexed#expireAfterSeconds. Please make to use either expireAfterSeconds or expireAfter.",
+						"@Indexed already defines an expiration timeout of %s seconds via Indexed#expireAfterSeconds. Please make to use either expireAfterSeconds or expireAfter.",
 						index.expireAfterSeconds()));
 			}
 
@@ -480,7 +481,7 @@ protected EvaluationContext getEvaluationContext() {
 
 	/**
 	 * Get the {@link EvaluationContext} for a given {@link PersistentEntity entity} the default one.
-	 * 
+	 *
 	 * @param persistentEntity can be {@literal null}
 	 * @return
 	 */
@@ -626,7 +627,7 @@ private static Duration computeIndexTimeout(String timeoutValue, EvaluationConte
 		Matcher matcher = TIMEOUT_PATTERN.matcher(val);
 		if (matcher.find()) {
 
-			Long timeout = NumberUtils.parseNumber(matcher.group(1), Long.class);
+			long timeout = NumberUtils.parseNumber(matcher.group(1), Long.class);
 			String unit = matcher.group(3);
 
 			switch (unit) {
@@ -642,7 +643,7 @@ private static Duration computeIndexTimeout(String timeoutValue, EvaluationConte
 		}
 
 		throw new IllegalArgumentException(
-				String.format("Index timeout %s cannot be parsed. Please use the following pattern '\\d+\\W?[dhms]'.", val));
+				String.format("Index timeout %s cannot be parsed. Please use the pattern '\\d+\\W?[dhms]'.", val));
 	}
 
 	@Nullable

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/index/MongoPersistentEntityIndexResolverUnitTests.java

@@ -32,6 +32,7 @@
 import org.junit.runner.RunWith;
 import org.junit.runners.Suite;
 import org.junit.runners.Suite.SuiteClasses;
+
 import org.springframework.core.annotation.AliasFor;
 import org.springframework.data.annotation.Id;
 import org.springframework.data.geo.Point;
@@ -237,7 +238,6 @@ public void shouldErrorOnInvalidTimeoutExpression() {
 
 			Assertions.assertThatExceptionOfType(IllegalArgumentException.class).isThrownBy(() -> indexResolver
 					.resolveIndexForEntity(mappingContext.getRequiredPersistentEntity(WithInvalidExpireAfter.class)));
-
 		}
 
 		@Test // DATAMONGO-2112
@@ -384,7 +384,6 @@ static class WithIndexNameAsExpression {
 	@Retention(RetentionPolicy.RUNTIME)
 	@Indexed
 	@interface IndexedFieldAnnotation {
-
 	}
 
 	@Document
@@ -660,22 +659,16 @@ static class CompoundIndexOnLevelZeroWithEmptyIndexDef {}
 				unique = true)
 		static class SingleCompoundIndex {}
 
-		static class IndexDefinedOnSuperClass extends CompoundIndexOnLevelZero {
-
-		}
+		static class IndexDefinedOnSuperClass extends CompoundIndexOnLevelZero {}
 
 		@Document("ComountIndexWithAutogeneratedName")
 		@CompoundIndexes({ @CompoundIndex(useGeneratedName = true, def = "{'foo': 1, 'bar': -1}", background = true,
 				sparse = true, unique = true) })
-		static class ComountIndexWithAutogeneratedName {
-
-		}
+		static class ComountIndexWithAutogeneratedName {}
 
 		@Document("WithComposedAnnotation")
 		@ComposedCompoundIndex
-		static class CompoundIndexDocumentWithComposedAnnotation {
-
-		}
+		static class CompoundIndexDocumentWithComposedAnnotation {}
 
 		@Retention(RetentionPolicy.RUNTIME)
 		@Target({ ElementType.TYPE })