[jira] [Created] (KAFKA-5090) Kafka Streams SessionStore.findSessions javadoc broken

["Michal Borowiecki (JIRA)" <ji...@apache.org>]

Michal Borowiecki created KAFKA-5090:
----------------------------------------

             Summary: Kafka Streams SessionStore.findSessions javadoc broken
                 Key: KAFKA-5090
                 URL: https://issues.apache.org/jira/browse/KAFKA-5090
             Project: Kafka
          Issue Type: Bug
          Components: streams
    Affects Versions: 0.10.2.0
            Reporter: Michal Borowiecki
            Priority: Trivial


{code}
    /**
     * Fetch any sessions with the matching key and the sessions end is &le earliestEndTime and the sessions
     * start is &ge latestStartTime
     */
    KeyValueIterator<Windowed<K>, AGG> findSessions(final K key, long earliestSessionEndTime, final long latestSessionStartTime);
{code}

The conditions in the javadoc comment are inverted (le should be ge and ge shoudl be le), since this is what the code does. They were correct in the original KIP:
https://cwiki.apache.org/confluence/display/KAFKA/KIP-94+Session+Windows
{code}

    /**
     * Find any aggregated session values with the matching key and where the
     * session’s end time is >= earliestSessionEndTime, i.e, the oldest session to
     * merge with, and the session’s start time is <= latestSessionStartTime, i.e,
     * the newest session to merge with.
     */
   KeyValueIterator<Windowed<K>, AGG> findSessionsToMerge(final K key, final long earliestSessionEndTime, final long latestSessionStartTime);
{code}

Also, the escaped html character references are missing the trailing semicolon making them render as-is.

Happy to have this assigned to me to fix as it seems trivial.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)