Skip to content

Add generic Pair utility class with full test coverage for DSA convenience. #25020

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

adi1103sh
Copy link

@adi1103sh adi1103sh commented May 3, 2025

While solving DSA problems on LeetCode (especially under time constraints), it's common to require a Pair structure for representing coordinates, graph edges, mapping logic, etc.

In the absence of a native Pair class in Java (unlike C++ STL's std::pair), this often leads to redundant and repeated creation of custom Pair classes during contests or interviews.

This PR introduces a reusable, generic Pair<F, S> utility class to address that gap. Key highlights:

✅ Supports Comparable

🔁 Includes common utilities like swap() and makePair()

✅ Covers equals(), hashCode(), compareTo(), toString()

🧪 Comes with comprehensive TestNG test suite with full coverage


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Error

 ⚠️ OCA signatory status must be verified

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/25020/head:pull/25020
$ git checkout pull/25020

Update a local copy of the PR:
$ git checkout pull/25020
$ git pull https://git.openjdk.org/jdk.git pull/25020/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25020

View PR using the GUI difftool:
$ git pr show -t 25020

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/25020.diff

@bridgekeeper bridgekeeper bot added the oca Needs verification of OCA signatory status label May 3, 2025
@bridgekeeper
Copy link

bridgekeeper bot commented May 3, 2025

Hi @adi1103sh, welcome to this OpenJDK project and thanks for contributing!

We do not recognize you as Contributor and need to ensure you have signed the Oracle Contributor Agreement (OCA). If you have not signed the OCA, please follow the instructions. Please fill in your GitHub username in the "Username" field of the application. Once you have signed the OCA, please let us know by writing /signed in a comment in this pull request.

If you already are an OpenJDK Author, Committer or Reviewer, please click here to open a new issue so that we can record that fact. Please use "Add GitHub user adi1103sh" as summary for the issue.

If you are contributing this work on behalf of your employer and your employer has signed the OCA, please let us know by writing /covered in a comment in this pull request.

@openjdk
Copy link

openjdk bot commented May 3, 2025

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

@openjdk
Copy link

openjdk bot commented May 3, 2025

@adi1103sh The following label will be automatically applied to this pull request:

  • core-libs

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added the core-libs core-libs-dev@openjdk.org label May 3, 2025
@adi1103sh
Copy link
Author

/signed

@bridgekeeper bridgekeeper bot added the oca-verify Needs verification of OCA signatory status label May 3, 2025
@bridgekeeper
Copy link

bridgekeeper bot commented May 3, 2025

Thank you! Please allow for up to two weeks to process your OCA, although it is usually done within one to two business days. Also, please note that pull requests that are pending an OCA check will not usually be evaluated, so your patience is appreciated!

@openjdk
Copy link

openjdk bot commented May 6, 2025

@adi1103sh Please do not rebase or force-push to an active PR as it invalidates existing review comments. Note for future reference, the bots always squash all changes into a single commit automatically as part of the integration. See OpenJDK Developers’ Guide for more information.

*/
@Override
public String toString() {
return "(" + String.valueOf(first) + ", " + String.valueOf(second) + ")";
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
return "(" + String.valueOf(first) + ", " + String.valueOf(second) + ")";
return "(" + first + ", " + second + ")";

StringConcation will handle null, no need to call String.valueOf here

Copy link
Author

@adi1103sh adi1103sh May 6, 2025

Choose a reason for hiding this comment

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

THANKS for pointing out, pushed a new patch with your suggested change.

Copy link
Author

@adi1103sh adi1103sh May 6, 2025

Choose a reason for hiding this comment

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

Hey @wenshao
It would be so nice of you, if you could review #25059

@adi1103sh
Copy link
Author

adi1103sh commented May 6, 2025

After using record for couple of days, I believe making Pair class is re-inventing the wheel, just for the sake of mutability.
If someone has any suggestion will collaborate.

@adi1103sh adi1103sh closed this May 6, 2025
@adi1103sh adi1103sh reopened this May 6, 2025
@openjdk
Copy link

openjdk bot commented May 6, 2025

@adi1103sh Please do not rebase or force-push to an active PR as it invalidates existing review comments. Note for future reference, the bots always squash all changes into a single commit automatically as part of the integration. See OpenJDK Developers’ Guide for more information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-libs core-libs-dev@openjdk.org oca Needs verification of OCA signatory status oca-verify Needs verification of OCA signatory status
Development

Successfully merging this pull request may close these issues.

2 participants