You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@zookeeper.apache.org by "Patrick Hunt (Created) (JIRA)" <ji...@apache.org> on 2011/12/22 00:25:30 UTC
[jira] [Created] (ZOOKEEPER-1336) javadoc for multi is confusing,
references functionality that doesn't seem to exist
javadoc for multi is confusing, references functionality that doesn't seem to exist
------------------------------------------------------------------------------------
Key: ZOOKEEPER-1336
URL: https://issues.apache.org/jira/browse/ZOOKEEPER-1336
Project: ZooKeeper
Issue Type: Bug
Components: java client
Affects Versions: 3.4.1
Reporter: Patrick Hunt
There's this in org.apache.zookeeper.ZooKeeper.multi(Iterable<Op>)
{noformat}
* Executes multiple Zookeeper operations or none of them. On success, a list of results is returned.
* On failure, only a single exception is returned. If you want more details, it may be preferable to
* use the alternative form of this method that lets you pass a list into which individual results are
* placed so that you can zero in on exactly which operation failed and why.
{noformat}
What is the "alternate form of this method" that's being referred to? Seems like we should add this functionality, or at the very least update the javadoc. (I don't think this is referring to Transaction, although the docs there are pretty thin)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (ZOOKEEPER-1336) javadoc for multi is confusing,
references functionality that doesn't seem to exist
Posted by "Hadoop QA (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ZOOKEEPER-1336?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13175104#comment-13175104 ]
Hadoop QA commented on ZOOKEEPER-1336:
--------------------------------------
-1 overall. Here are the results of testing the latest attachment
http://issues.apache.org/jira/secure/attachment/12508418/ZOOKEEPER-1336.patch
against trunk revision 1221868.
+1 @author. The patch does not contain any @author tags.
-1 tests included. The patch doesn't appear to include any new or modified tests.
Please justify why no new tests are needed for this patch.
Also please list what manual steps were performed to verify this patch.
+1 javadoc. The javadoc tool did not generate any warning messages.
+1 javac. The applied patch does not increase the total number of javac compiler warnings.
+1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings.
+1 release audit. The applied patch does not increase the total number of release audit warnings.
-1 core tests. The patch failed core unit tests.
+1 contrib tests. The patch passed contrib unit tests.
Test results: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/852//testReport/
Findbugs warnings: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/852//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Console output: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/852//console
This message is automatically generated.
> javadoc for multi is confusing, references functionality that doesn't seem to exist
> ------------------------------------------------------------------------------------
>
> Key: ZOOKEEPER-1336
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-1336
> Project: ZooKeeper
> Issue Type: Bug
> Components: java client
> Affects Versions: 3.4.1
> Reporter: Patrick Hunt
> Assignee: Patrick Hunt
> Fix For: 3.5.0, 3.4.3
>
> Attachments: ZOOKEEPER-1336.patch
>
>
> There's this in org.apache.zookeeper.ZooKeeper.multi(Iterable<Op>)
> {noformat}
> * Executes multiple Zookeeper operations or none of them. On success, a list of results is returned.
> * On failure, only a single exception is returned. If you want more details, it may be preferable to
> * use the alternative form of this method that lets you pass a list into which individual results are
> * placed so that you can zero in on exactly which operation failed and why.
> {noformat}
> What is the "alternate form of this method" that's being referred to? Seems like we should add this functionality, or at the very least update the javadoc. (I don't think this is referring to Transaction, although the docs there are pretty thin)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (ZOOKEEPER-1336) javadoc for multi is confusing,
references functionality that doesn't seem to exist
Posted by "Patrick Hunt (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ZOOKEEPER-1336?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13181431#comment-13181431 ]
Patrick Hunt commented on ZOOKEEPER-1336:
-----------------------------------------
Rakesh, I'd suggest either update this patch or create a new jira/patch with your contribution.
> javadoc for multi is confusing, references functionality that doesn't seem to exist
> ------------------------------------------------------------------------------------
>
> Key: ZOOKEEPER-1336
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-1336
> Project: ZooKeeper
> Issue Type: Bug
> Components: java client
> Affects Versions: 3.4.1
> Reporter: Patrick Hunt
> Assignee: Patrick Hunt
> Fix For: 3.4.3, 3.5.0
>
> Attachments: ZOOKEEPER-1336.patch
>
>
> There's this in org.apache.zookeeper.ZooKeeper.multi(Iterable<Op>)
> {noformat}
> * Executes multiple Zookeeper operations or none of them. On success, a list of results is returned.
> * On failure, only a single exception is returned. If you want more details, it may be preferable to
> * use the alternative form of this method that lets you pass a list into which individual results are
> * placed so that you can zero in on exactly which operation failed and why.
> {noformat}
> What is the "alternate form of this method" that's being referred to? Seems like we should add this functionality, or at the very least update the javadoc. (I don't think this is referring to Transaction, although the docs there are pretty thin)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (ZOOKEEPER-1336) javadoc for multi is confusing,
references functionality that doesn't seem to exist
Posted by "Hadoop QA (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ZOOKEEPER-1336?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13175026#comment-13175026 ]
Hadoop QA commented on ZOOKEEPER-1336:
--------------------------------------
-1 overall. Here are the results of testing the latest attachment
http://issues.apache.org/jira/secure/attachment/12508418/ZOOKEEPER-1336.patch
against trunk revision 1221868.
+1 @author. The patch does not contain any @author tags.
-1 tests included. The patch doesn't appear to include any new or modified tests.
Please justify why no new tests are needed for this patch.
Also please list what manual steps were performed to verify this patch.
+1 javadoc. The javadoc tool did not generate any warning messages.
+1 javac. The applied patch does not increase the total number of javac compiler warnings.
+1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings.
+1 release audit. The applied patch does not increase the total number of release audit warnings.
-1 core tests. The patch failed core unit tests.
+1 contrib tests. The patch passed contrib unit tests.
Test results: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/849//testReport/
Findbugs warnings: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/849//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Console output: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/849//console
This message is automatically generated.
> javadoc for multi is confusing, references functionality that doesn't seem to exist
> ------------------------------------------------------------------------------------
>
> Key: ZOOKEEPER-1336
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-1336
> Project: ZooKeeper
> Issue Type: Bug
> Components: java client
> Affects Versions: 3.4.1
> Reporter: Patrick Hunt
> Assignee: Patrick Hunt
> Fix For: 3.5.0, 3.4.3
>
> Attachments: ZOOKEEPER-1336.patch
>
>
> There's this in org.apache.zookeeper.ZooKeeper.multi(Iterable<Op>)
> {noformat}
> * Executes multiple Zookeeper operations or none of them. On success, a list of results is returned.
> * On failure, only a single exception is returned. If you want more details, it may be preferable to
> * use the alternative form of this method that lets you pass a list into which individual results are
> * placed so that you can zero in on exactly which operation failed and why.
> {noformat}
> What is the "alternate form of this method" that's being referred to? Seems like we should add this functionality, or at the very least update the javadoc. (I don't think this is referring to Transaction, although the docs there are pretty thin)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (ZOOKEEPER-1336) javadoc for multi is confusing,
references functionality that doesn't seem to exist
Posted by "Hadoop QA (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ZOOKEEPER-1336?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13201116#comment-13201116 ]
Hadoop QA commented on ZOOKEEPER-1336:
--------------------------------------
-1 overall. Here are the results of testing the latest attachment
http://issues.apache.org/jira/secure/attachment/12508418/ZOOKEEPER-1336.patch
against trunk revision 1238176.
+1 @author. The patch does not contain any @author tags.
-1 tests included. The patch doesn't appear to include any new or modified tests.
Please justify why no new tests are needed for this patch.
Also please list what manual steps were performed to verify this patch.
+1 javadoc. The javadoc tool did not generate any warning messages.
+1 javac. The applied patch does not increase the total number of javac compiler warnings.
+1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings.
+1 release audit. The applied patch does not increase the total number of release audit warnings.
+1 core tests. The patch passed core unit tests.
+1 contrib tests. The patch passed contrib unit tests.
Test results: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/944//testReport/
Findbugs warnings: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/944//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Console output: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/944//console
This message is automatically generated.
> javadoc for multi is confusing, references functionality that doesn't seem to exist
> ------------------------------------------------------------------------------------
>
> Key: ZOOKEEPER-1336
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-1336
> Project: ZooKeeper
> Issue Type: Bug
> Components: java client
> Affects Versions: 3.4.1
> Reporter: Patrick Hunt
> Assignee: Patrick Hunt
> Fix For: 3.4.3, 3.5.0
>
> Attachments: ZOOKEEPER-1336.patch
>
>
> There's this in org.apache.zookeeper.ZooKeeper.multi(Iterable<Op>)
> {noformat}
> * Executes multiple Zookeeper operations or none of them. On success, a list of results is returned.
> * On failure, only a single exception is returned. If you want more details, it may be preferable to
> * use the alternative form of this method that lets you pass a list into which individual results are
> * placed so that you can zero in on exactly which operation failed and why.
> {noformat}
> What is the "alternate form of this method" that's being referred to? Seems like we should add this functionality, or at the very least update the javadoc. (I don't think this is referring to Transaction, although the docs there are pretty thin)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Assigned] (ZOOKEEPER-1336) javadoc for multi is confusing,
references functionality that doesn't seem to exist
Posted by "Patrick Hunt (Assigned) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ZOOKEEPER-1336?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Patrick Hunt reassigned ZOOKEEPER-1336:
---------------------------------------
Assignee: Patrick Hunt
> javadoc for multi is confusing, references functionality that doesn't seem to exist
> ------------------------------------------------------------------------------------
>
> Key: ZOOKEEPER-1336
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-1336
> Project: ZooKeeper
> Issue Type: Bug
> Components: java client
> Affects Versions: 3.4.1
> Reporter: Patrick Hunt
> Assignee: Patrick Hunt
>
> There's this in org.apache.zookeeper.ZooKeeper.multi(Iterable<Op>)
> {noformat}
> * Executes multiple Zookeeper operations or none of them. On success, a list of results is returned.
> * On failure, only a single exception is returned. If you want more details, it may be preferable to
> * use the alternative form of this method that lets you pass a list into which individual results are
> * placed so that you can zero in on exactly which operation failed and why.
> {noformat}
> What is the "alternate form of this method" that's being referred to? Seems like we should add this functionality, or at the very least update the javadoc. (I don't think this is referring to Transaction, although the docs there are pretty thin)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (ZOOKEEPER-1336) javadoc for multi is confusing,
references functionality that doesn't seem to exist
Posted by "Marshall McMullen (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ZOOKEEPER-1336?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13174895#comment-13174895 ]
Marshall McMullen commented on ZOOKEEPER-1336:
----------------------------------------------
Yes, the order of the results will exactly match the order of the operations.
Ted is correct, the "alternative method" was removed and we instead just return a list. Javadoc comments should be updated accordingly.
> javadoc for multi is confusing, references functionality that doesn't seem to exist
> ------------------------------------------------------------------------------------
>
> Key: ZOOKEEPER-1336
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-1336
> Project: ZooKeeper
> Issue Type: Bug
> Components: java client
> Affects Versions: 3.4.1
> Reporter: Patrick Hunt
>
> There's this in org.apache.zookeeper.ZooKeeper.multi(Iterable<Op>)
> {noformat}
> * Executes multiple Zookeeper operations or none of them. On success, a list of results is returned.
> * On failure, only a single exception is returned. If you want more details, it may be preferable to
> * use the alternative form of this method that lets you pass a list into which individual results are
> * placed so that you can zero in on exactly which operation failed and why.
> {noformat}
> What is the "alternate form of this method" that's being referred to? Seems like we should add this functionality, or at the very least update the javadoc. (I don't think this is referring to Transaction, although the docs there are pretty thin)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (ZOOKEEPER-1336) javadoc for multi is confusing,
references functionality that doesn't seem to exist
Posted by "Patrick Hunt (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ZOOKEEPER-1336?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13174494#comment-13174494 ]
Patrick Hunt commented on ZOOKEEPER-1336:
-----------------------------------------
Also, is there an implied order to the returned list? specifically is it the same order as the "ops" list? The javadocs should mention this.
> javadoc for multi is confusing, references functionality that doesn't seem to exist
> ------------------------------------------------------------------------------------
>
> Key: ZOOKEEPER-1336
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-1336
> Project: ZooKeeper
> Issue Type: Bug
> Components: java client
> Affects Versions: 3.4.1
> Reporter: Patrick Hunt
>
> There's this in org.apache.zookeeper.ZooKeeper.multi(Iterable<Op>)
> {noformat}
> * Executes multiple Zookeeper operations or none of them. On success, a list of results is returned.
> * On failure, only a single exception is returned. If you want more details, it may be preferable to
> * use the alternative form of this method that lets you pass a list into which individual results are
> * placed so that you can zero in on exactly which operation failed and why.
> {noformat}
> What is the "alternate form of this method" that's being referred to? Seems like we should add this functionality, or at the very least update the javadoc. (I don't think this is referring to Transaction, although the docs there are pretty thin)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (ZOOKEEPER-1336) javadoc for multi is confusing,
references functionality that doesn't seem to exist
Posted by "Rakesh R (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ZOOKEEPER-1336?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13181221#comment-13181221 ]
Rakesh R commented on ZOOKEEPER-1336:
-------------------------------------
I feel, it would be good provides sample usage of multi and transaction in javadocs. Below are few suggestions:
+multi usage as method-level javadoc:+
{noformat}
* <P>
* In the following example of multi-update, <code>zkper</code> represents
* an active ZK client connection:
* <PRE>
* Op createEphe1 = Op.create("/sample", new String ( "sample" ).getBytes (),
* org.apache.zookeeper.ZooDefs.Ids.OPEN_ACL_UNSAFE, CreateMode
* .fromFlag ( 2 ) );
* Op createEphe2 = Op.create("/sample", new String ( "sample" ).getBytes (),
* org.apache.zookeeper.ZooDefs.Ids.OPEN_ACL_UNSAFE, CreateMode
* .fromFlag ( 2 ) );
* List<Op> ops = new ArrayList<Op>();
* ops.add(createEphe1);
* ops.add(createEphe2);
* zkper.multi(ops);
* </PRE>
{noformat}
+Transaction usage as class-level javadoc:+
{noformat}
* <P>
* In the following example of transaction, <code>zkper</code> represents
* an active ZK client connection:
* <PRE>
* Transaction transaction = zkper.transaction();
* transaction.create("/sample", new String ( "sample" ).getBytes (),
* org.apache.zookeeper.ZooDefs.Ids.OPEN_ACL_UNSAFE, CreateMode
* .fromFlag ( 2 ) );
* transaction.create("/sample", new String ( "sample" ).getBytes (),
* org.apache.zookeeper.ZooDefs.Ids.OPEN_ACL_UNSAFE, CreateMode
* .fromFlag ( 2 ) );
* transaction.commit();
* </PRE>
{noformat}
Thanks,
Rakesh
> javadoc for multi is confusing, references functionality that doesn't seem to exist
> ------------------------------------------------------------------------------------
>
> Key: ZOOKEEPER-1336
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-1336
> Project: ZooKeeper
> Issue Type: Bug
> Components: java client
> Affects Versions: 3.4.1
> Reporter: Patrick Hunt
> Assignee: Patrick Hunt
> Fix For: 3.4.3, 3.5.0
>
> Attachments: ZOOKEEPER-1336.patch
>
>
> There's this in org.apache.zookeeper.ZooKeeper.multi(Iterable<Op>)
> {noformat}
> * Executes multiple Zookeeper operations or none of them. On success, a list of results is returned.
> * On failure, only a single exception is returned. If you want more details, it may be preferable to
> * use the alternative form of this method that lets you pass a list into which individual results are
> * placed so that you can zero in on exactly which operation failed and why.
> {noformat}
> What is the "alternate form of this method" that's being referred to? Seems like we should add this functionality, or at the very least update the javadoc. (I don't think this is referring to Transaction, although the docs there are pretty thin)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (ZOOKEEPER-1336) javadoc for multi is confusing,
references functionality that doesn't seem to exist
Posted by "Hudson (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ZOOKEEPER-1336?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13201215#comment-13201215 ]
Hudson commented on ZOOKEEPER-1336:
-----------------------------------
Integrated in ZooKeeper-trunk #1451 (See [https://builds.apache.org/job/ZooKeeper-trunk/1451/])
ZOOKEEPER-1336. javadoc for multi is confusing, references functionality that doesn't seem to exist. (phunt via mahadev)
mahadev : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1240931
Files :
* /zookeeper/trunk/CHANGES.txt
* /zookeeper/trunk/src/java/main/org/apache/zookeeper/KeeperException.java
* /zookeeper/trunk/src/java/main/org/apache/zookeeper/Transaction.java
* /zookeeper/trunk/src/java/main/org/apache/zookeeper/ZooKeeper.java
> javadoc for multi is confusing, references functionality that doesn't seem to exist
> ------------------------------------------------------------------------------------
>
> Key: ZOOKEEPER-1336
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-1336
> Project: ZooKeeper
> Issue Type: Bug
> Components: java client
> Affects Versions: 3.4.1
> Reporter: Patrick Hunt
> Assignee: Patrick Hunt
> Fix For: 3.4.3, 3.5.0
>
> Attachments: ZOOKEEPER-1336.patch
>
>
> There's this in org.apache.zookeeper.ZooKeeper.multi(Iterable<Op>)
> {noformat}
> * Executes multiple Zookeeper operations or none of them. On success, a list of results is returned.
> * On failure, only a single exception is returned. If you want more details, it may be preferable to
> * use the alternative form of this method that lets you pass a list into which individual results are
> * placed so that you can zero in on exactly which operation failed and why.
> {noformat}
> What is the "alternate form of this method" that's being referred to? Seems like we should add this functionality, or at the very least update the javadoc. (I don't think this is referring to Transaction, although the docs there are pretty thin)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (ZOOKEEPER-1336) javadoc for multi is confusing,
references functionality that doesn't seem to exist
Posted by "Ted Dunning (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ZOOKEEPER-1336?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13174569#comment-13174569 ]
Ted Dunning commented on ZOOKEEPER-1336:
----------------------------------------
Taking the easy question first, yes, the order is implied.
Regarding the javadoc, I believe that this refers to a capability that was removed because it turned out to be redundant after we decided to return a list.
> javadoc for multi is confusing, references functionality that doesn't seem to exist
> ------------------------------------------------------------------------------------
>
> Key: ZOOKEEPER-1336
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-1336
> Project: ZooKeeper
> Issue Type: Bug
> Components: java client
> Affects Versions: 3.4.1
> Reporter: Patrick Hunt
>
> There's this in org.apache.zookeeper.ZooKeeper.multi(Iterable<Op>)
> {noformat}
> * Executes multiple Zookeeper operations or none of them. On success, a list of results is returned.
> * On failure, only a single exception is returned. If you want more details, it may be preferable to
> * use the alternative form of this method that lets you pass a list into which individual results are
> * placed so that you can zero in on exactly which operation failed and why.
> {noformat}
> What is the "alternate form of this method" that's being referred to? Seems like we should add this functionality, or at the very least update the javadoc. (I don't think this is referring to Transaction, although the docs there are pretty thin)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (ZOOKEEPER-1336) javadoc for multi is confusing,
references functionality that doesn't seem to exist
Posted by "Patrick Hunt (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ZOOKEEPER-1336?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Patrick Hunt updated ZOOKEEPER-1336:
------------------------------------
Attachment: ZOOKEEPER-1336.patch
Thanks Marshall/Ted!
I updated the javadoc to correct the inaccuracies. I also added @since tags to let users know when this was introduced.
LMK if there's anything else we should add.
> javadoc for multi is confusing, references functionality that doesn't seem to exist
> ------------------------------------------------------------------------------------
>
> Key: ZOOKEEPER-1336
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-1336
> Project: ZooKeeper
> Issue Type: Bug
> Components: java client
> Affects Versions: 3.4.1
> Reporter: Patrick Hunt
> Assignee: Patrick Hunt
> Fix For: 3.5.0, 3.4.3
>
> Attachments: ZOOKEEPER-1336.patch
>
>
> There's this in org.apache.zookeeper.ZooKeeper.multi(Iterable<Op>)
> {noformat}
> * Executes multiple Zookeeper operations or none of them. On success, a list of results is returned.
> * On failure, only a single exception is returned. If you want more details, it may be preferable to
> * use the alternative form of this method that lets you pass a list into which individual results are
> * placed so that you can zero in on exactly which operation failed and why.
> {noformat}
> What is the "alternate form of this method" that's being referred to? Seems like we should add this functionality, or at the very least update the javadoc. (I don't think this is referring to Transaction, although the docs there are pretty thin)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira