Skip to content

MINOR: Fix Javadoc of KafkaConsumer#6155

Merged
vahidhashemian merged 1 commit intoapache:trunkfrom
lfrancke:javadoc-fixes
Jan 19, 2019
Merged

MINOR: Fix Javadoc of KafkaConsumer#6155
vahidhashemian merged 1 commit intoapache:trunkfrom
lfrancke:javadoc-fixes

Conversation

@lfrancke
Copy link
Copy Markdown
Member

The Javadoc is using Properties.put which should never be used because it allows putting non-strings into a Properties object which is designed to only handle strings. This method (as well as get) are used internally a lot but this just changes the Javadoc as to not encourage bad usage for users of the API.

Two other minor fixes so the examples actually work

No JIRA issue because it's a trivial javadoc fix, no tests because javadoc only patch.

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

The Javadoc is using Properties.put which should never be used because it allows putting non-strings into a Properties object which is designed to only handle strings.
Two other minor fixes so the examples actually work
Copy link
Copy Markdown
Contributor

@vahidhashemian vahidhashemian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for improving the Javadoc.

@vahidhashemian vahidhashemian merged commit 6cae257 into apache:trunk Jan 19, 2019
@lfrancke
Copy link
Copy Markdown
Member Author

Thank you for reviewing and merging!

@lfrancke lfrancke deleted the javadoc-fixes branch January 20, 2019 14:20
abbccdda pushed a commit to abbccdda/kafka that referenced this pull request Jan 24, 2019
The Javadoc is using Properties.put which should never be used because it allows putting non-strings into a Properties object which is designed to only handle strings.
Two other minor fixes so the examples actually work
jarekr pushed a commit to confluentinc/kafka that referenced this pull request Apr 18, 2019
* ak/trunk:
  MINOR: fix race condition in KafkaStreamsTest (apache#6185)
  KAFKA-4850: Enable bloomfilters (apache#6012)
  MINOR: ducker-ak: add down -f, avoid using a terminal in ducker test
  KAFKA-5117: Stop resolving externalized configs in Connect REST API
  MINOR: Cleanup handling of mixed transactional/idempotent records (apache#6172)
  KAFKA-7844: Use regular subproject for generator to fix *All targets (apache#6182)
  Fix Documentation for cleanup.policy is out of date (apache#6181)
  MINOR: increase timeouts for KafkaStreamsTest (apache#6178)
  MINOR: Rejoin split ssl principal mapping rules (apache#6099)
  MINOR: Handle case where connector status endpoints returns 404 (apache#6176)
  MINOR: Remove unused imports, exceptions, and values (apache#6117)
  KAFKA-3522: Add internal RecordConverter interface (apache#6150)
  Fix Javadoc of KafkaConsumer (apache#6155)
  KAFKA-6455: Extend CacheFlushListener to forward timestamp (apache#6147)
  MINOR: Log partition info when creating new request batch in controller (apache#6145)
  KAFKA-7652: Part I; Fix SessionStore's findSession(single-key) (apache#6134)
  MINOR: Remove the InvalidTopicException handling in InternalTopicManager (apache#6167)
  [KAFKA-7024] Rocksdb state directory should be created before opening the DB (apache#6138)
  MINOR:: Fix typos (apache#6079)
pengxiaolong pushed a commit to pengxiaolong/kafka that referenced this pull request Jun 14, 2019
The Javadoc is using Properties.put which should never be used because it allows putting non-strings into a Properties object which is designed to only handle strings.
Two other minor fixes so the examples actually work
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants