[jira] [Created] (FLINK-16310) Javadoc of AppendingState.get() contradicts with behavior of UserFacingListState

[Shang Yuanchun (Jira)]

Tzu-Li (Gordon) Tai created FLINK-16310:
-------------------------------------------

             Summary: Javadoc of AppendingState.get() contradicts with behavior of UserFacingListState
                 Key: FLINK-16310
                 URL: https://issues.apache.org/jira/browse/FLINK-16310
             Project: Flink
          Issue Type: Improvement
          Components: Documentation, Runtime / State Backends
    Affects Versions: 1.10.0, 1.9.2, 1.8.3, 1.7.2, 1.6.4
            Reporter: Tzu-Li (Gordon) Tai
            Assignee: Tzu-Li (Gordon) Tai


The {{get()}} method on the user-facing state handle interface {{AppendingState}} states that:
{code}
@return The operator state value corresponding to the current input or NULL if the state is empty.
{code}

This behavior, is not true for the user-facing list state handles, as the behavior has always been that if the list state does not have elements, an empty list is returned (see FLINK-4307 / {{UserFacingListState}}).

The fix would be to only mention the null-returning behavior on the internal list state interface, i.e. {{InternalListState}}, and fix the Javadoc for {{AppendingState}}.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)