Repository: kafka
Updated Branches:
  refs/heads/0.11.0 1c9581e2e -> 1df108421


MINOR: Fix KafkaConsumer.commitSync() javadoc @throws declarations

Throws IllegalArgumentException is the offset is negative

Author: Mickael Maison <mickael.mai...@gmail.com>

Reviewers: Ismael Juma <ism...@juma.me.uk>, Jason Gustafson <ja...@confluent.io>

Closes #3780 from mimaison/commitSync_javadoc

(cherry picked from commit 4ac7c48e91f37471e83cc82d26b26e5b715e8e80)
Signed-off-by: Jason Gustafson <ja...@confluent.io>


Project: http://git-wip-us.apache.org/repos/asf/kafka/repo
Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/1df10842
Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/1df10842
Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/1df10842

Branch: refs/heads/0.11.0
Commit: 1df1084214febcfeef89372292983cf1b0ba6358
Parents: 1c9581e
Author: Mickael Maison <mickael.mai...@gmail.com>
Authored: Mon Sep 18 12:58:03 2017 -0700
Committer: Jason Gustafson <ja...@confluent.io>
Committed: Mon Sep 18 12:58:59 2017 -0700

----------------------------------------------------------------------
 .../java/org/apache/kafka/clients/consumer/KafkaConsumer.java   | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kafka/blob/1df10842/clients/src/main/java/org/apache/kafka/clients/consumer/KafkaConsumer.java
----------------------------------------------------------------------
diff --git 
a/clients/src/main/java/org/apache/kafka/clients/consumer/KafkaConsumer.java 
b/clients/src/main/java/org/apache/kafka/clients/consumer/KafkaConsumer.java
index 3e60488..970a5a2 100644
--- a/clients/src/main/java/org/apache/kafka/clients/consumer/KafkaConsumer.java
+++ b/clients/src/main/java/org/apache/kafka/clients/consumer/KafkaConsumer.java
@@ -1130,7 +1130,7 @@ public class KafkaConsumer<K, V> implements Consumer<K, 
V> {
      * @throws org.apache.kafka.common.errors.AuthorizationException if not 
authorized to the topic or to the
      *             configured groupId
      * @throws org.apache.kafka.common.KafkaException for any other 
unrecoverable errors (e.g. if offset metadata
-     *             is too large or if the committed offset is invalid).
+     *             is too large or if the topic does not exist).
      */
     @Override
     public void commitSync() {
@@ -1163,8 +1163,9 @@ public class KafkaConsumer<K, V> implements Consumer<K, 
V> {
      *             this function is called
      * @throws org.apache.kafka.common.errors.AuthorizationException if not 
authorized to the topic or to the
      *             configured groupId
+     * @throws java.lang.IllegalArgumentException if the committed offset is 
negative
      * @throws org.apache.kafka.common.KafkaException for any other 
unrecoverable errors (e.g. if offset metadata
-     *             is too large or if the committed offset is invalid).
+     *             is too large or if the topic does not exist).
      */
     @Override
     public void commitSync(final Map<TopicPartition, OffsetAndMetadata> 
offsets) {

Reply via email to