Polishing.

Update IndexOperations javadoc. Add missing parameters and change wording to reflect what the methods actually do.

See: #4587
This commit is contained in:
Christoph Strobl
2023-12-12 08:04:03 +01:00
parent a3c67e3ce5
commit 7856c7264f
2 changed files with 7 additions and 4 deletions

View File

@@ -32,13 +32,15 @@ public interface IndexOperations {
* class. If not it will be created.
*
* @param indexDefinition must not be {@literal null}.
* @return the index name.
*/
String ensureIndex(IndexDefinition indexDefinition);
/**
* Drops an index from this collection.
* Alters the index with given {@literal name}.
*
* @param name name of index to hide.
* @param name name of index to change.
* @param options index options.
* @since 4.1
*/
void alterIndex(String name, IndexOptions options);

View File

@@ -32,14 +32,15 @@ public interface ReactiveIndexOperations {
* class. If not it will be created.
*
* @param indexDefinition must not be {@literal null}.
* @return a {@link Mono} emitting the name of the index on completion.
*/
Mono<String> ensureIndex(IndexDefinition indexDefinition);
/**
* Alters the index with given {@literal name}.
*
* @param name name of index to hide.
* @param
* @param name name of index to change.
* @param options index options.
* @since 4.1
*/
Mono<Void> alterIndex(String name, IndexOptions options);