kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ewe...@apache.org
Subject kafka git commit: MINOR: Rephrase Javadoc summary for ConsumerRecord
Date Fri, 30 Dec 2016 05:12:46 GMT
Repository: kafka
Updated Branches:
  refs/heads/trunk 64bab8052 -> 3d7e88456


MINOR: Rephrase Javadoc summary for ConsumerRecord

The original Javadoc description for `ConsumerRecord` is slightly confusing in that it can
be read in a way such that an object is a key value pair received from Kafka, but (only) consists
of the metadata associated with the record. This PR makes it clearer that the metadata is
_included_ with the record, and moves the comma so that the phrase "topic name and partition
number" in the sentence is more closely associated with the phrase "from which the record
is being received".

Author: LoneRifle <LoneRifle@users.noreply.github.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #2290 from LoneRifle/patch-1


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

Branch: refs/heads/trunk
Commit: 3d7e88456f14fbac66309973f1334cb32c10e3ea
Parents: 64bab80
Author: LoneRifle <LoneRifle@users.noreply.github.com>
Authored: Thu Dec 29 21:14:26 2016 -0800
Committer: Ewen Cheslack-Postava <me@ewencp.org>
Committed: Thu Dec 29 21:14:26 2016 -0800

----------------------------------------------------------------------
 .../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/3d7e8845/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 c8aef53..5f10155 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
@@ -16,8 +16,9 @@ import org.apache.kafka.common.record.Record;
 import org.apache.kafka.common.record.TimestampType;
 
 /**
- * A key/value pair to be received from Kafka. This consists of a topic name and a partition
number, from which the
- * record is being received and an offset that points to the record in a Kafka partition.
+ * A key/value pair to be received from Kafka. This also consists of a topic name and 
+ * a partition number from which the record is being received, an offset that points 
+ * to the record in a Kafka partition, and a timestamp as marked by the corresponding ProducerRecord.
  */
 public class ConsumerRecord<K, V> {
     public static final long NO_TIMESTAMP = Record.NO_TIMESTAMP;


Mime
View raw message