docs: add comprehensive Javadoc for dynamic indexing classes

Add missing Javadoc comments to fix build warnings in the indexing
module. This includes documentation for constructors, builder classes,
and all public methods in ConfigurableIndexDefinitionProvider,
EphemeralIndexService, IndexMigrationService, MigrationResult,
ReindexResult, and RediSearchIndexer.

Also wrap SpEL expressions in {@code} blocks in RediSearchIndexer
to prevent them from being parsed as Javadoc tags.

Author: bsbodden

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

@@ -34,6 +34,12 @@ public class ConfigurableIndexDefinitionProvider {
   private final Map<Class<?>, IndexResolver> customResolvers = new ConcurrentHashMap<>();
   private final ObjectMapper objectMapper = new ObjectMapper();
 
+  /**
+   * Constructs a new ConfigurableIndexDefinitionProvider.
+   *
+   * @param indexer            the RediSearchIndexer to use for index operations
+   * @param applicationContext the Spring application context
+   */
   public ConfigurableIndexDefinitionProvider(RediSearchIndexer indexer, ApplicationContext applicationContext) {
     this.indexer = indexer;
     this.applicationContext = applicationContext;
@@ -276,15 +282,31 @@ public static class IndexDefinitionConfig {
     private final String indexName;
     private final String keyPrefix;
 
+    /**
+     * Constructs a new IndexDefinitionConfig.
+     *
+     * @param indexName the name of the index
+     * @param keyPrefix the key prefix for the index
+     */
     public IndexDefinitionConfig(String indexName, String keyPrefix) {
       this.indexName = indexName;
       this.keyPrefix = keyPrefix;
     }
 
+    /**
+     * Returns the index name.
+     *
+     * @return the index name
+     */
     public String getIndexName() {
       return indexName;
     }
 
+    /**
+     * Returns the key prefix.
+     *
+     * @return the key prefix
+     */
     public String getKeyPrefix() {
       return keyPrefix;
     }
@@ -298,20 +320,42 @@ public static class IndexDefinition {
     private final String keyPrefix;
     private final Class<?> entityClass;
 
+    /**
+     * Constructs a new IndexDefinition.
+     *
+     * @param indexName   the name of the index
+     * @param keyPrefix   the key prefix for the index
+     * @param entityClass the entity class for the index
+     */
     public IndexDefinition(String indexName, String keyPrefix, Class<?> entityClass) {
       this.indexName = indexName;
       this.keyPrefix = keyPrefix;
       this.entityClass = entityClass;
     }
 
+    /**
+     * Returns the index name.
+     *
+     * @return the index name
+     */
     public String getIndexName() {
       return indexName;
     }
 
+    /**
+     * Returns the key prefix.
+     *
+     * @return the key prefix
+     */
     public String getKeyPrefix() {
       return keyPrefix;
     }
 
+    /**
+     * Returns the entity class.
+     *
+     * @return the entity class
+     */
     public Class<?> getEntityClass() {
       return entityClass;
     }
@@ -325,39 +369,83 @@ public static class IndexStatistics {
     private final long documentCount;
     private final long indexSize;
 
+    /**
+     * Constructs a new IndexStatistics instance.
+     *
+     * @param indexName     the name of the index
+     * @param documentCount the number of documents in the index
+     * @param indexSize     the size of the index in bytes
+     */
     public IndexStatistics(String indexName, long documentCount, long indexSize) {
       this.indexName = indexName;
       this.documentCount = documentCount;
       this.indexSize = indexSize;
     }
 
+    /**
+     * Returns the name of the index.
+     *
+     * @return the index name
+     */
     public String getIndexName() {
       return indexName;
     }
 
+    /**
+     * Returns the number of documents in the index.
+     *
+     * @return the document count
+     */
     public long getDocumentCount() {
       return documentCount;
     }
 
+    /**
+     * Returns the size of the index in bytes.
+     *
+     * @return the index size
+     */
     public long getIndexSize() {
       return indexSize;
     }
   }
 
   /**
-   * Inner class representing validation results.
+   * Inner class representing validation results for index configurations.
    */
   public static class ValidationResult {
     private final List<String> errors = new ArrayList<>();
 
+    /**
+     * Creates a new empty ValidationResult.
+     */
+    public ValidationResult() {
+      // Default constructor
+    }
+
+    /**
+     * Adds an error message to this validation result.
+     *
+     * @param error the error message to add
+     */
     public void addError(String error) {
       errors.add(error);
     }
 
+    /**
+     * Checks if this validation result is valid (has no errors).
+     *
+     * @return true if there are no errors, false otherwise
+     */
     public boolean isValid() {
       return errors.isEmpty();
     }
 
+    /**
+     * Returns the list of error messages.
+     *
+     * @return the list of errors
+     */
     public List<String> getErrors() {
       return errors;
     }

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

@@ -26,6 +26,11 @@ public class EphemeralIndexService implements DisposableBean {
   private final ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(2);
   private final ConcurrentHashMap<String, EphemeralIndexInfo> ephemeralIndexes = new ConcurrentHashMap<>();
 
+  /**
+   * Constructs a new EphemeralIndexService.
+   *
+   * @param indexer the RediSearchIndexer to use for index operations
+   */
   @Autowired
   public EphemeralIndexService(RediSearchIndexer indexer) {
     this.indexer = indexer;

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

@@ -36,6 +36,12 @@ private enum MigrationStatus {
     FAILED
   }
 
+  /**
+   * Constructs a new IndexMigrationService.
+   *
+   * @param indexer            the RediSearchIndexer to use for index operations
+   * @param applicationContext the Spring application context
+   */
   public IndexMigrationService(RediSearchIndexer indexer, ApplicationContext applicationContext) {
     this.indexer = indexer;
     this.applicationContext = applicationContext;

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

@@ -28,42 +28,90 @@ private MigrationResult(Builder builder) {
     this.documentsProcessed = builder.documentsProcessed;
   }
 
+  /**
+   * Returns whether the migration was successful.
+   *
+   * @return true if the migration succeeded, false otherwise
+   */
   public boolean isSuccessful() {
     return successful;
   }
 
+  /**
+   * Returns the name of the old index before migration.
+   *
+   * @return the old index name
+   */
   public String getOldIndexName() {
     return oldIndexName;
   }
 
+  /**
+   * Returns the name of the new index after migration.
+   *
+   * @return the new index name
+   */
   public String getNewIndexName() {
     return newIndexName;
   }
 
+  /**
+   * Returns the migration strategy used.
+   *
+   * @return the migration strategy
+   */
   public MigrationStrategy getStrategy() {
     return strategy;
   }
 
+  /**
+   * Returns the start time of the migration.
+   *
+   * @return the start time
+   */
   public Instant getStartTime() {
     return startTime;
   }
 
+  /**
+   * Returns the end time of the migration.
+   *
+   * @return the end time
+   */
   public Instant getEndTime() {
     return endTime;
   }
 
+  /**
+   * Returns the error message if the migration failed.
+   *
+   * @return the error message, or null if successful
+   */
   public String getErrorMessage() {
     return errorMessage;
   }
 
+  /**
+   * Returns the number of documents processed during migration.
+   *
+   * @return the number of documents processed
+   */
   public long getDocumentsProcessed() {
     return documentsProcessed;
   }
 
+  /**
+   * Creates a new Builder for constructing MigrationResult instances.
+   *
+   * @return a new Builder instance
+   */
   public static Builder builder() {
     return new Builder();
   }
 
+  /**
+   * Builder class for constructing MigrationResult instances.
+   */
   public static class Builder {
     private boolean successful;
     private String oldIndexName;
@@ -74,48 +122,108 @@ public static class Builder {
     private String errorMessage;
     private long documentsProcessed;
 
+    /**
+     * Creates a new Builder instance.
+     */
+    public Builder() {
+      // Default constructor
+    }
+
+    /**
+     * Sets whether the migration was successful.
+     *
+     * @param successful true if successful, false otherwise
+     * @return this builder for chaining
+     */
     public Builder successful(boolean successful) {
       this.successful = successful;
       return this;
     }
 
+    /**
+     * Sets the old index name.
+     *
+     * @param oldIndexName the name of the old index
+     * @return this builder for chaining
+     */
     public Builder oldIndexName(String oldIndexName) {
       this.oldIndexName = oldIndexName;
       return this;
     }
 
+    /**
+     * Sets the new index name.
+     *
+     * @param newIndexName the name of the new index
+     * @return this builder for chaining
+     */
     public Builder newIndexName(String newIndexName) {
       this.newIndexName = newIndexName;
       return this;
     }
 
+    /**
+     * Sets the migration strategy used.
+     *
+     * @param strategy the migration strategy
+     * @return this builder for chaining
+     */
     public Builder strategy(MigrationStrategy strategy) {
       this.strategy = strategy;
       return this;
     }
 
+    /**
+     * Sets the start time of the migration.
+     *
+     * @param startTime the start time
+     * @return this builder for chaining
+     */
     public Builder startTime(Instant startTime) {
       this.startTime = startTime;
       return this;
     }
 
+    /**
+     * Sets the end time of the migration.
+     *
+     * @param endTime the end time
+     * @return this builder for chaining
+     */
     public Builder endTime(Instant endTime) {
       this.endTime = endTime;
       return this;
     }
 
+    /**
+     * Sets the error message for failed migrations.
+     *
+     * @param errorMessage the error message
+     * @return this builder for chaining
+     */
     public Builder errorMessage(String errorMessage) {
       this.errorMessage = errorMessage;
       return this;
     }
 
+    /**
+     * Sets the number of documents processed.
+     *
+     * @param documentsProcessed the number of documents
+     * @return this builder for chaining
+     */
     public Builder documentsProcessed(long documentsProcessed) {
       this.documentsProcessed = documentsProcessed;
       return this;
     }
 
+    /**
+     * Builds the MigrationResult instance.
+     *
+     * @return a new MigrationResult with the configured values
+     */
     public MigrationResult build() {
       return new MigrationResult(this);
     }
   }
-}
+}