This is an automated email from the ASF dual-hosted git repository.
pvillard pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi.git
The following commit(s) were added to refs/heads/main by this push:
new 6b78c42928 NIFI-13697 Clarify documentation in ProcessSession
regarding StateManager interactions
6b78c42928 is described below
commit 6b78c42928004bbc4c2f6d106ae476f968694231
Author: EndzeitBegins <[email protected]>
AuthorDate: Sat Aug 31 20:33:42 2024 +0200
NIFI-13697 Clarify documentation in ProcessSession regarding StateManager
interactions
Signed-off-by: Pierre Villard <[email protected]>
This closes #9223.
---
.../src/main/java/org/apache/nifi/processor/ProcessSession.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git
a/nifi-api/src/main/java/org/apache/nifi/processor/ProcessSession.java
b/nifi-api/src/main/java/org/apache/nifi/processor/ProcessSession.java
index e6516ca68e..26106b1b89 100644
--- a/nifi-api/src/main/java/org/apache/nifi/processor/ProcessSession.java
+++ b/nifi-api/src/main/java/org/apache/nifi/processor/ProcessSession.java
@@ -848,7 +848,7 @@ public interface ProcessSession {
/**
* Updates the value of the component's state, setting it to given value.
* <p>
- * This method does update the remote State Provider immediately but
rather caches the value until the session is committed.
+ * This method does not update the remote State Provider immediately but
rather caches the value until the session is committed.
* At that point, it will publish the state to the remote State Provider,
if the state is the latest according to the remote State Provider.
*
* @param state the value to change the state to
@@ -876,7 +876,7 @@ public interface ProcessSession {
* The oldValue will be compared against the value of the state as it is
known to {@code this} {@link ProcessSession}.
* If the Process Session does not currently know the state, it will be
fetched from the StateProvider.
* <p>
- * This method does update the remote State Provider immediately but
rather caches the value until the session is committed.
+ * This method does not update the remote State Provider immediately but
rather caches the value until the session is committed.
* At that point, it will publish the state to the remote State Provider,
if the state is the latest according to the remote State Provider.
*
* @param oldValue the value to compare the state's current value against
@@ -891,7 +891,7 @@ public interface ProcessSession {
/**
* Clears all keys and values from the component's state.
* <p>
- * This method does update the remote State Provider immediately but
rather caches the value until the session is committed.
+ * This method does not update the remote State Provider immediately but
rather caches the value until the session is committed.
* At that point, it will publish the state to the remote State Provider,
if the state is the latest according to the remote State Provider.
*
* @param scope the {@link Scope} to use for clearing the state
