Uploaded image for project: 'Ignite'
  1. Ignite
  2. IGNITE-22582

Improve javadoc for KeyValueView#getAllAsync regarding not existing keys

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • 3.0.0-beta1
    • None
    • documentation
    • Docs Required, Release Notes Required

    Description

      The [current javadoc|
      https://github.com/apache/ignite-3/blob/38d13fcd5f0b45879f210bcc15b1e048b8916fa4/modules/api/src/main/java/org/apache/ignite/table/KeyValueView.java#L129-L137] for the `getAll` methods in the KeyValueView does not specify what happens if the requested keys are not found.

      The user might expect the following behaviours:

      • Method fails because cannot find all the keys
      • The returned map contains all the keys but non-existing keys are mapped to a null value.
      • The returned map does not contain non-existing keys.

      What to do:

      • Clarify the actual scenario in the javadoc.

      Attachments

        Issue Links

          Activity

            People

              tmgodinho Tiago Marques Godinho
              tmgodinho Tiago Marques Godinho
              Pavel Tupitsyn Pavel Tupitsyn
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 10m
                  10m