Repository: kafka Updated Branches: refs/heads/trunk b7bd2978d -> 1162cc1dd
MINOR: Fixed ConsumerRecord constructor javadoc Refactoring of ConsumerRecord made in https://github.com/apache/kafka/commit/0699ff2ce60abb466cab5315977a224f1a70a4da#diff-fafe8d3a3942f3c6394927881a9389b2 left ConsumerRecord constructor javadoc inconsistent with implementation. This patch fixes ConsumerRecord constructor javadoc to be inline with implementation. Author: Stevo SlaviÄ <[email protected]> Reviewers: Ismael, Guozhang Closes #85 from sslavic/patch-3 and squashes the following commits: c289c4f [Stevo SlaviÄ] MINOR: Fixed ConsumerRecord constructor javadoc Project: http://git-wip-us.apache.org/repos/asf/kafka/repo Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/1162cc1d Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/1162cc1d Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/1162cc1d Branch: refs/heads/trunk Commit: 1162cc1dd30e896e8c7a03f960b7d7bcbf883624 Parents: b7bd297 Author: Stevo SlaviÄ <[email protected]> Authored: Wed Jul 29 18:23:54 2015 -0700 Committer: Guozhang Wang <[email protected]> Committed: Wed Jul 29 18:23:54 2015 -0700 ---------------------------------------------------------------------- .../java/org/apache/kafka/clients/consumer/ConsumerRecord.java | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kafka/blob/1162cc1d/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerRecord.java ---------------------------------------------------------------------- diff --git a/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerRecord.java b/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerRecord.java index 49d9527..d4668c2 100644 --- a/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerRecord.java +++ b/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerRecord.java @@ -24,11 +24,12 @@ public final class ConsumerRecord<K, V> { private final V value; /** - * Create a record with no key - * + * Creates a record to be received from a specified topic and partition + * * @param topic The topic this record is received from * @param partition The partition of the topic this record is received from * @param offset The offset of this record in the corresponding Kafka partition + * @param key The key of the record, if one exists (null is allowed) * @param value The record contents */ public ConsumerRecord(String topic, int partition, long offset, K key, V value) {
