[
https://issues.apache.org/jira/browse/NIFI-1305?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16535871#comment-16535871
]
ASF GitHub Bot commented on NIFI-1305:
--------------------------------------
GitHub user HorizonNet opened a pull request:
https://github.com/apache/nifi/pull/2857
NIFI-1305 Extended JavaDoc on DistributedMapCacheClient.getAndPutIfAbsent
Thank you for submitting a contribution to Apache NiFi.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [x] Does your PR title start with NIFI-XXXX where XXXX is the JIRA number
you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [x] Has your PR been rebased against the latest commit within the target
branch (typically master)?
- [x] Is your initial contribution a single, squashed commit?
### For code changes:
- [x] Have you ensured that the full suite of tests is executed via mvn
-Pcontrib-check clean install at the root nifi folder?
- [ ] Have you written or updated unit tests to verify your changes?
- [ ] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the LICENSE file, including the main
LICENSE file under nifi-assembly?
- [ ] If applicable, have you updated the NOTICE file, including the main
NOTICE file found under nifi-assembly?
- [ ] If adding new Properties, have you added .displayName in addition to
.name (programmatic access) for each of the new properties?
### For documentation related changes:
- [ ] Have you ensured that format looks appropriate for the output in
which it is rendered?
### Note:
Please ensure that once the PR is submitted, you check travis-ci for build
issues and submit an update to your PR as soon as possible.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/ultratendency/nifi NIFI-1305
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/nifi/pull/2857.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #2857
----
commit ba5bd534e04b00c8a84414ac26fc748266b2940d
Author: Jan Hentschel <jan.hentschel@...>
Date: 2018-07-07T18:58:37Z
NIFI-1305 Extended JavaDoc on DistributedMapCacheClient.getAndPutIfAbsent
----
> Clarify Javadoc on DistributedMapCacheClient.getAndPutIfAbsent
> --------------------------------------------------------------
>
> Key: NIFI-1305
> URL: https://issues.apache.org/jira/browse/NIFI-1305
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Documentation & Website
> Affects Versions: 0.4.0
> Reporter: Michael Kobit
> Priority: Trivial
>
> The Javadoc for this method on DistributedMapCacheClient
> (https://github.com/apache/nifi/blob/master/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-client-service-api/src/main/java/org/apache/nifi/distributed/cache/client/DistributedMapCacheClient.java#L53-L71)
> is unclear about what happens if the key does not exist in the cache.
> It looks like from the implementation of DistributedMapCacheClientService
> that it returns the value if it present, otherwise returns the computed
> value. The Javadoc doesn't state what is returned happens if an item does not
> exist.
> I spent some time trying to figure out what makes sense from a client's
> perspective, and I had some trouble trying to understand what should happen.
> It seems obvious to me now that the cache should return either the existing
> value or the newly computed value, but it took some time to get there.
> I think the documentation should be clearer about what is returned in the
> case where the item does not exist
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
