Skip to content

Commit e646c85

Browse files
committed
docs: fix all Javadoc warnings in lexicographic classes
Add missing Javadoc comments for public constructors and methods in lexicographic query classes. Update Spring Boot Javadoc URL to prevent redirect warning. - Add Javadoc for constructors and getters in marker classes - Document constructor parameters in LexicographicIndexer and LexicographicQueryExecutor - Fix Spring Boot docs URL from /docs/current/api/ to /api/java/
1 parent 4652972 commit e646c85

File tree

6 files changed

+53
-1
lines changed

6 files changed

+53
-1
lines changed

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ tasks.register('aggregateJavadoc', Javadoc) {
6262
'https://docs.oracle.com/en/java/javase/21/docs/api/',
6363
'https://docs.spring.io/spring-framework/docs/current/javadoc-api/',
6464
'https://docs.spring.io/spring-data/redis/docs/current/api/',
65-
'https://docs.spring.io/spring-boot/docs/current/api/'
65+
'https://docs.spring.io/spring-boot/api/java/'
6666
)
6767
}
6868

redis-om-spring/src/main/java/com/redis/om/spring/indexing/LexicographicIndexer.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ public class LexicographicIndexer {
2323
private final RedisTemplate<String, String> redisTemplate;
2424
private final RediSearchIndexer indexer;
2525

26+
/**
27+
* Creates a new LexicographicIndexer with the specified dependencies.
28+
*
29+
* @param redisTemplate the Redis template for executing Redis operations
30+
* @param indexer the RediSearch indexer for accessing field metadata
31+
*/
2632
public LexicographicIndexer(RedisTemplate<String, String> redisTemplate, RediSearchIndexer indexer) {
2733
this.redisTemplate = redisTemplate;
2834
this.indexer = indexer;

redis-om-spring/src/main/java/com/redis/om/spring/repository/query/lexicographic/LexicographicQueryExecutor.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,13 @@ public class LexicographicQueryExecutor {
3838
private final RedisModulesOperations<String> modulesOperations;
3939
private final RediSearchIndexer indexer;
4040

41+
/**
42+
* Creates a new LexicographicQueryExecutor with the specified dependencies.
43+
*
44+
* @param rediSearchQuery the RediSearch query being executed
45+
* @param modulesOperations the Redis modules operations for executing commands
46+
* @param indexer the RediSearch indexer for accessing field metadata
47+
*/
4148
public LexicographicQueryExecutor(RediSearchQuery rediSearchQuery, RedisModulesOperations<String> modulesOperations,
4249
RediSearchIndexer indexer) {
4350
this.rediSearchQuery = rediSearchQuery;

redis-om-spring/src/main/java/com/redis/om/spring/search/stream/predicates/lexicographic/LexicographicBetweenMarker.java

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,33 @@ public class LexicographicBetweenMarker<E, T> extends BaseAbstractPredicate<E, T
1919
private final T min;
2020
private final T max;
2121

22+
/**
23+
* Creates a new LexicographicBetweenMarker for the specified field and range.
24+
*
25+
* @param field the field accessor for the target string field
26+
* @param min the minimum value (inclusive)
27+
* @param max the maximum value (inclusive)
28+
*/
2229
public LexicographicBetweenMarker(SearchFieldAccessor field, T min, T max) {
2330
super(field);
2431
this.min = min;
2532
this.max = max;
2633
}
2734

35+
/**
36+
* Returns the minimum value for the range.
37+
*
38+
* @return the minimum value
39+
*/
2840
public T getMin() {
2941
return min;
3042
}
3143

44+
/**
45+
* Returns the maximum value for the range.
46+
*
47+
* @return the maximum value
48+
*/
3249
public T getMax() {
3350
return max;
3451
}

redis-om-spring/src/main/java/com/redis/om/spring/search/stream/predicates/lexicographic/LexicographicGreaterThanMarker.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,22 @@ public class LexicographicGreaterThanMarker<E, T> extends BaseAbstractPredicate<
1919
LexicographicPredicate {
2020
private final T value;
2121

22+
/**
23+
* Creates a new LexicographicGreaterThanMarker for the specified field and threshold.
24+
*
25+
* @param field the field accessor for the target string field
26+
* @param value the threshold value (field must be lexicographically greater than this)
27+
*/
2228
public LexicographicGreaterThanMarker(SearchFieldAccessor field, T value) {
2329
super(field);
2430
this.value = value;
2531
}
2632

33+
/**
34+
* Returns the threshold value for comparison.
35+
*
36+
* @return the threshold value
37+
*/
2738
public T getValue() {
2839
return value;
2940
}

redis-om-spring/src/main/java/com/redis/om/spring/search/stream/predicates/lexicographic/LexicographicLessThanMarker.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,22 @@
1818
public class LexicographicLessThanMarker<E, T> extends BaseAbstractPredicate<E, T> implements LexicographicPredicate {
1919
private final T value;
2020

21+
/**
22+
* Creates a new LexicographicLessThanMarker for the specified field and threshold.
23+
*
24+
* @param field the field accessor for the target string field
25+
* @param value the threshold value (field must be lexicographically less than this)
26+
*/
2127
public LexicographicLessThanMarker(SearchFieldAccessor field, T value) {
2228
super(field);
2329
this.value = value;
2430
}
2531

32+
/**
33+
* Returns the threshold value for comparison.
34+
*
35+
* @return the threshold value
36+
*/
2637
public T getValue() {
2738
return value;
2839
}

0 commit comments

Comments
 (0)