Skip to content

Commit

Permalink
Polishing touches
Browse files Browse the repository at this point in the history
  • Loading branch information
@tishun
tishun committed Sep 25, 2024
1 parent 538fdc8 commit ae602b0
Show file tree
Hide file tree
Showing 18 changed files with 101 additions and 113 deletions.
16 changes: 8 additions & 8 deletions src/main/java/io/lettuce/core/api/async/RedisJsonAsyncCommands.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
public interface RedisJsonAsyncCommands<K, V> {

/**
* Append the JSON values into the array at a given {@link JsonPath} after the last element in said array.
* Append the JSON values into the array at a given {@link JsonPath} after the last element in a said array.
*
* @param key the key holding the JSON document.
* @param jsonPath the {@link JsonPath} pointing to the array inside the document.
Expand All @@ -40,7 +40,7 @@ public interface RedisJsonAsyncCommands<K, V> {
RedisFuture<List<Long>> jsonArrappend(K key, JsonPath jsonPath, JsonValue... values);

/**
* Append the JSON values into the array at the {@link JsonPath#ROOT_PATH} after the last element in said array.
* Append the JSON values into the array at the {@link JsonPath#ROOT_PATH} after the last element in a said array.
*
* @param key the key holding the JSON document.
* @param values one or more {@link JsonValue} to be appended.
Expand Down Expand Up @@ -139,7 +139,7 @@ public interface RedisJsonAsyncCommands<K, V> {

/**
* Trim an array at a given {@link JsonPath} so that it contains only the specified inclusive range of elements. All
* elements with indexes smaller the start range and all elements with indexes bigger the end range are trimmed.
* elements with indexes smaller than the start range and all elements with indexes bigger than the end range are trimmed.
* <p>
* Behavior as of RedisJSON v2.0:
* <ul>
Expand Down Expand Up @@ -195,7 +195,7 @@ public interface RedisJsonAsyncCommands<K, V> {
RedisFuture<Long> jsonDel(K key);

/**
* Return the value at path in JSON serialized form.
* Return the value at the specified path in JSON serialized form.
* <p>
* When using a single JSONPath, the root of the matching values is a JSON string with a top-level array of serialized JSON
* value. In contrast, a legacy path returns a single value.
Expand All @@ -214,7 +214,7 @@ public interface RedisJsonAsyncCommands<K, V> {
RedisFuture<List<JsonValue>> jsonGet(K key, JsonGetArgs options, JsonPath... jsonPaths);

/**
* Return the value at path in JSON serialized form. Uses defaults for the {@link JsonGetArgs}.
* Return the value at the specified path in JSON serialized form. Uses defaults for the {@link JsonGetArgs}.
* <p>
* When using a single JSONPath, the root of the matching values is a JSON string with a top-level array of serialized JSON
* value. In contrast, a legacy path returns a single value.
Expand Down Expand Up @@ -256,7 +256,7 @@ public interface RedisJsonAsyncCommands<K, V> {
RedisFuture<String> jsonMerge(K key, JsonPath jsonPath, JsonValue value);

/**
* Return the values at path from multiple key arguments.
* Return the values at the specified path from multiple key arguments.
*
* @param jsonPath the {@link JsonPath} pointing to the value to fetch.
* @param keys the keys holding the {@link JsonValue}s to fetch.
Expand All @@ -269,7 +269,7 @@ public interface RedisJsonAsyncCommands<K, V> {
* Set or update one or more JSON values according to the specified {@link JsonMsetArgs}
* <p>
* JSON.MSET is atomic, hence, all given additions or updates are either applied or not. It is not possible for clients to
* see that some of the keys were updated while others are unchanged.
* see that some keys were updated while others are unchanged.
* <p>
* A JSON value is a hierarchical structure. If you change a value in a specific path - nested values are affected.
*
Expand Down Expand Up @@ -331,7 +331,7 @@ public interface RedisJsonAsyncCommands<K, V> {
/**
* Sets the JSON value at a given {@link JsonPath} in the JSON document.
* <p>
* For new Redis keys the path must be the root. For existing keys, when the entire path exists, the value that it contains
* For new Redis keys, the path must be the root. For existing keys, when the entire path exists, the value that it contains
* is replaced with the JSON value. For existing keys, when the path exists, except for the last element, a new child is
* added with the JSON value.
* <p>
Expand Down
16 changes: 8 additions & 8 deletions src/main/java/io/lettuce/core/api/reactive/RedisJsonReactiveCommands.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
public interface RedisJsonReactiveCommands<K, V> {

/**
* Append the JSON values into the array at a given {@link JsonPath} after the last element in said array.
* Append the JSON values into the array at a given {@link JsonPath} after the last element in a said array.
*
* @param key the key holding the JSON document.
* @param jsonPath the {@link JsonPath} pointing to the array inside the document.
Expand All @@ -41,7 +41,7 @@ public interface RedisJsonReactiveCommands<K, V> {
Flux<Long> jsonArrappend(K key, JsonPath jsonPath, JsonValue... values);

/**
* Append the JSON values into the array at the {@link JsonPath#ROOT_PATH} after the last element in said array.
* Append the JSON values into the array at the {@link JsonPath#ROOT_PATH} after the last element in a said array.
*
* @param key the key holding the JSON document.
* @param values one or more {@link JsonValue} to be appended.
Expand Down Expand Up @@ -140,7 +140,7 @@ public interface RedisJsonReactiveCommands<K, V> {

/**
* Trim an array at a given {@link JsonPath} so that it contains only the specified inclusive range of elements. All
* elements with indexes smaller the start range and all elements with indexes bigger the end range are trimmed.
* elements with indexes smaller than the start range and all elements with indexes bigger than the end range are trimmed.
* <p>
* Behavior as of RedisJSON v2.0:
* <ul>
Expand Down Expand Up @@ -196,7 +196,7 @@ public interface RedisJsonReactiveCommands<K, V> {
Mono<Long> jsonDel(K key);

/**
* Return the value at path in JSON serialized form.
* Return the value at the specified path in JSON serialized form.
* <p>
* When using a single JSONPath, the root of the matching values is a JSON string with a top-level array of serialized JSON
* value. In contrast, a legacy path returns a single value.
Expand All @@ -215,7 +215,7 @@ public interface RedisJsonReactiveCommands<K, V> {
Flux<JsonValue> jsonGet(K key, JsonGetArgs options, JsonPath... jsonPaths);

/**
* Return the value at path in JSON serialized form. Uses defaults for the {@link JsonGetArgs}.
* Return the value at the specified path in JSON serialized form. Uses defaults for the {@link JsonGetArgs}.
* <p>
* When using a single JSONPath, the root of the matching values is a JSON string with a top-level array of serialized JSON
* value. In contrast, a legacy path returns a single value.
Expand Down Expand Up @@ -257,7 +257,7 @@ public interface RedisJsonReactiveCommands<K, V> {
Mono<String> jsonMerge(K key, JsonPath jsonPath, JsonValue value);

/**
* Return the values at path from multiple key arguments.
* Return the values at the specified path from multiple key arguments.
*
* @param jsonPath the {@link JsonPath} pointing to the value to fetch.
* @param keys the keys holding the {@link JsonValue}s to fetch.
Expand All @@ -270,7 +270,7 @@ public interface RedisJsonReactiveCommands<K, V> {
* Set or update one or more JSON values according to the specified {@link JsonMsetArgs}
* <p>
* JSON.MSET is atomic, hence, all given additions or updates are either applied or not. It is not possible for clients to
* see that some of the keys were updated while others are unchanged.
* see that some keys were updated while others are unchanged.
* <p>
* A JSON value is a hierarchical structure. If you change a value in a specific path - nested values are affected.
*
Expand Down Expand Up @@ -332,7 +332,7 @@ public interface RedisJsonReactiveCommands<K, V> {
/**
* Sets the JSON value at a given {@link JsonPath} in the JSON document.
* <p>
* For new Redis keys the path must be the root. For existing keys, when the entire path exists, the value that it contains
* For new Redis keys, the path must be the root. For existing keys, when the entire path exists, the value that it contains
* is replaced with the JSON value. For existing keys, when the path exists, except for the last element, a new child is
* added with the JSON value.
* <p>
Expand Down
16 changes: 8 additions & 8 deletions src/main/java/io/lettuce/core/api/sync/RedisJsonCommands.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
public interface RedisJsonCommands<K, V> {

/**
* Append the JSON values into the array at a given {@link JsonPath} after the last element in said array.
* Append the JSON values into the array at a given {@link JsonPath} after the last element in a said array.
*
* @param key the key holding the JSON document.
* @param jsonPath the {@link JsonPath} pointing to the array inside the document.
Expand All @@ -39,7 +39,7 @@ public interface RedisJsonCommands<K, V> {
List<Long> jsonArrappend(K key, JsonPath jsonPath, JsonValue... values);

/**
* Append the JSON values into the array at the {@link JsonPath#ROOT_PATH} after the last element in said array.
* Append the JSON values into the array at the {@link JsonPath#ROOT_PATH} after the last element in a said array.
*
* @param key the key holding the JSON document.
* @param values one or more {@link JsonValue} to be appended.
Expand Down Expand Up @@ -138,7 +138,7 @@ public interface RedisJsonCommands<K, V> {

/**
* Trim an array at a given {@link JsonPath} so that it contains only the specified inclusive range of elements. All
* elements with indexes smaller the start range and all elements with indexes bigger the end range are trimmed.
* elements with indexes smaller than the start range and all elements with indexes bigger than the end range are trimmed.
* <p>
* Behavior as of RedisJSON v2.0:
* <ul>
Expand Down Expand Up @@ -194,7 +194,7 @@ public interface RedisJsonCommands<K, V> {
Long jsonDel(K key);

/**
* Return the value at path in JSON serialized form.
* Return the value at the specified path in JSON serialized form.
* <p>
* When using a single JSONPath, the root of the matching values is a JSON string with a top-level array of serialized JSON
* value. In contrast, a legacy path returns a single value.
Expand All @@ -213,7 +213,7 @@ public interface RedisJsonCommands<K, V> {
List<JsonValue> jsonGet(K key, JsonGetArgs options, JsonPath... jsonPaths);

/**
* Return the value at path in JSON serialized form. Uses defaults for the {@link JsonGetArgs}.
* Return the value at the specified path in JSON serialized form. Uses defaults for the {@link JsonGetArgs}.
* <p>
* When using a single JSONPath, the root of the matching values is a JSON string with a top-level array of serialized JSON
* value. In contrast, a legacy path returns a single value.
Expand Down Expand Up @@ -255,7 +255,7 @@ public interface RedisJsonCommands<K, V> {
String jsonMerge(K key, JsonPath jsonPath, JsonValue value);

/**
* Return the values at path from multiple key arguments.
* Return the values at the specified path from multiple key arguments.
*
* @param jsonPath the {@link JsonPath} pointing to the value to fetch.
* @param keys the keys holding the {@link JsonValue}s to fetch.
Expand All @@ -268,7 +268,7 @@ public interface RedisJsonCommands<K, V> {
* Set or update one or more JSON values according to the specified {@link JsonMsetArgs}
* <p>
* JSON.MSET is atomic, hence, all given additions or updates are either applied or not. It is not possible for clients to
* see that some of the keys were updated while others are unchanged.
* see that some keys were updated while others are unchanged.
* <p>
* A JSON value is a hierarchical structure. If you change a value in a specific path - nested values are affected.
*
Expand Down Expand Up @@ -330,7 +330,7 @@ public interface RedisJsonCommands<K, V> {
/**
* Sets the JSON value at a given {@link JsonPath} in the JSON document.
* <p>
* For new Redis keys the path must be the root. For existing keys, when the entire path exists, the value that it contains
* For new Redis keys, the path must be the root. For existing keys, when the entire path exists, the value that it contains
* is replaced with the JSON value. For existing keys, when the path exists, except for the last element, a new child is
* added with the JSON value.
* <p>
Expand Down
16 changes: 8 additions & 8 deletions src/main/java/io/lettuce/core/cluster/api/async/NodeSelectionJsonAsyncCommands.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
public interface NodeSelectionJsonAsyncCommands<K, V> {

/**
* Append the JSON values into the array at a given {@link JsonPath} after the last element in said array.
* Append the JSON values into the array at a given {@link JsonPath} after the last element in a said array.
*
* @param key the key holding the JSON document.
* @param jsonPath the {@link JsonPath} pointing to the array inside the document.
Expand All @@ -39,7 +39,7 @@ public interface NodeSelectionJsonAsyncCommands<K, V> {
AsyncExecutions<List<Long>> jsonArrappend(K key, JsonPath jsonPath, JsonValue... values);

/**
* Append the JSON values into the array at the {@link JsonPath#ROOT_PATH} after the last element in said array.
* Append the JSON values into the array at the {@link JsonPath#ROOT_PATH} after the last element in a said array.
*
* @param key the key holding the JSON document.
* @param values one or more {@link JsonValue} to be appended.
Expand Down Expand Up @@ -138,7 +138,7 @@ public interface NodeSelectionJsonAsyncCommands<K, V> {

/**
* Trim an array at a given {@link JsonPath} so that it contains only the specified inclusive range of elements. All
* elements with indexes smaller the start range and all elements with indexes bigger the end range are trimmed.
* elements with indexes smaller than the start range and all elements with indexes bigger than the end range are trimmed.
* <p>
* Behavior as of RedisJSON v2.0:
* <ul>
Expand Down Expand Up @@ -194,7 +194,7 @@ public interface NodeSelectionJsonAsyncCommands<K, V> {
AsyncExecutions<Long> jsonDel(K key);

/**
* Return the value at path in JSON serialized form.
* Return the value at the specified path in JSON serialized form.
* <p>
* When using a single JSONPath, the root of the matching values is a JSON string with a top-level array of serialized JSON
* value. In contrast, a legacy path returns a single value.
Expand All @@ -213,7 +213,7 @@ public interface NodeSelectionJsonAsyncCommands<K, V> {
AsyncExecutions<List<JsonValue>> jsonGet(K key, JsonGetArgs options, JsonPath... jsonPaths);

/**
* Return the value at path in JSON serialized form. Uses defaults for the {@link JsonGetArgs}.
* Return the value at the specified path in JSON serialized form. Uses defaults for the {@link JsonGetArgs}.
* <p>
* When using a single JSONPath, the root of the matching values is a JSON string with a top-level array of serialized JSON
* value. In contrast, a legacy path returns a single value.
Expand Down Expand Up @@ -255,7 +255,7 @@ public interface NodeSelectionJsonAsyncCommands<K, V> {
AsyncExecutions<String> jsonMerge(K key, JsonPath jsonPath, JsonValue value);

/**
* Return the values at path from multiple key arguments.
* Return the values at the specified path from multiple key arguments.
*
* @param jsonPath the {@link JsonPath} pointing to the value to fetch.
* @param keys the keys holding the {@link JsonValue}s to fetch.
Expand All @@ -268,7 +268,7 @@ public interface NodeSelectionJsonAsyncCommands<K, V> {
* Set or update one or more JSON values according to the specified {@link JsonMsetArgs}
* <p>
* JSON.MSET is atomic, hence, all given additions or updates are either applied or not. It is not possible for clients to
* see that some of the keys were updated while others are unchanged.
* see that some keys were updated while others are unchanged.
* <p>
* A JSON value is a hierarchical structure. If you change a value in a specific path - nested values are affected.
*
Expand Down Expand Up @@ -330,7 +330,7 @@ public interface NodeSelectionJsonAsyncCommands<K, V> {
/**
* Sets the JSON value at a given {@link JsonPath} in the JSON document.
* <p>
* For new Redis keys the path must be the root. For existing keys, when the entire path exists, the value that it contains
* For new Redis keys, the path must be the root. For existing keys, when the entire path exists, the value that it contains
* is replaced with the JSON value. For existing keys, when the path exists, except for the last element, a new child is
* added with the JSON value.
* <p>
Expand Down
Loading

0 comments on commit ae602b0

Please sign in to comment.