[jira] [Created] (FLINK-13057) Correct comments in ListState class

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Created] (FLINK-13057) Correct comments in ListState class

Shang Yuanchun (Jira)
Hequn Cheng created FLINK-13057:
-----------------------------------

             Summary: Correct comments in ListState class
                 Key: FLINK-13057
                 URL: https://issues.apache.org/jira/browse/FLINK-13057
             Project: Flink
          Issue Type: Bug
          Components: Runtime / State Backends
            Reporter: Hequn Cheng
            Assignee: Hequn Cheng


ListState can be a keyed state or an operator state, but the comment in ListState said it can only be a keyed stateļ¼š
{code:java}
The state is only accessible by functions applied on a {@code KeyedStream}.
{code}
We can change the comment from
{code:java}
* <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.{code}
to
{code:java}
* <p>The state can be a keyed state or an operator state. When it is a keyed state, it 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.{code}
Appreciate any suggestions.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)