Skip to content

Commit

Permalink
NIFI-13697 Clarify documentation in ProcessSession regarding StateMan…
Browse files Browse the repository at this point in the history
…ager interactions

Signed-off-by: Pierre Villard <pierre.villard.fr@gmail.com>

This closes #9223.
  • Loading branch information
EndzeitBegins authored and pvillard31 committed Sep 1, 2024
1 parent f92f6f1 commit 6b78c42
Showing 1 changed file with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -848,7 +848,7 @@ default void commitAsync(Runnable onSuccess) {
/**
* 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
Expand Down Expand Up @@ -876,7 +876,7 @@ default void commitAsync(Runnable onSuccess) {
* 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
Expand All @@ -891,7 +891,7 @@ default void commitAsync(Runnable onSuccess) {
/**
* 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
Expand Down

0 comments on commit 6b78c42

Please sign in to comment.