[flink] 03/16: [FLINK-13057][state] Correct comments in ListState class

[se...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sewen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git

commit 7f5d5838ec2d5c1bceb8f6acf76bb53e04aa3d8f
Author: hequn8128 <ch...@gmail.com>
AuthorDate: Sun Jul 7 21:25:10 2019 +0800

    [FLINK-13057][state] Correct comments in ListState class
    
    This closes #8994
---
 .../java/org/apache/flink/api/common/state/ListState.java  | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/flink-core/src/main/java/org/apache/flink/api/common/state/ListState.java b/flink-core/src/main/java/org/apache/flink/api/common/state/ListState.java
index 254dc1d..1e2caf6 100644
--- a/flink-core/src/main/java/org/apache/flink/api/common/state/ListState.java
+++ b/flink-core/src/main/java/org/apache/flink/api/common/state/ListState.java
@@ -27,10 +27,16 @@ import java.util.List;
  * The state is accessed and modified by user functions, and checkpointed consistently
  * by the system as part of the distributed snapshots.
  *
- * <p>The state is only accessible by functions applied on a {@code KeyedStream}. The key is
- * automatically supplied by the system, so the function always sees the value mapped to the
- * key of the current element. That way, the system can handle stream and state partitioning
- * consistently together.
+ * <p>The state can be a keyed list state or an operator list state.
+ *
+ * <p>When it is a keyed list state, it is accessed by functions applied on a {@code KeyedStream}.
+ * The key is automatically supplied by the system, so the function always sees the value mapped
+ * to the key of the current element. That way, the system can handle stream and state
+ * partitioning consistently together.
+ *
+ * <p>When it is an operator list state, the list is a collection of state items that are
+ * independent from each other and eligible for redistribution across operator instances in case
+ * of changed operator parallelism.
  *
  * @param <T> Type of values that this list state keeps.
  */