Skip to content

[CLI-326] Make Option.getKey() public #239

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.

Sign up for GitHub

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

Merged
garydgregory merged 3 commits into from
Feb 29, 2024
Merged

[CLI-326] Make Option.getKey() public #239

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d3a348
Made option.getKey public
Claudenw Feb 27, 2024
761bd4b
added 'since' and javadoc
Claudenw Feb 29, 2024
be58c4f
Removed extraneous space.
Claudenw Feb 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/main/java/org/apache/commons/cli/Option.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,11 +573,13 @@ public int getId() {
}

/**
* Gets the 'unique' Option identifier.
* Gets the 'unique' Option identifier. This is the option value if set or the long value
* if the options value is not set.
*
* @return the 'unique' Option identifier
* @since 1.7.0
*/
String getKey() {
public String getKey() {
Copy link
Member

@garydgregory garydgregory Feb 27, 2024

Choose a reason for hiding this comment

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

Hello @Claudenw
If you make an element public or protected, you need a @since Javadoc tag.

Copy link
Contributor

@sebbASF sebbASF Feb 27, 2024

Choose a reason for hiding this comment

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

It also needs more Javadoc to explain what the key means

// if 'opt' is null, then it is a 'long' option
return option == null ? longOption : option;
}
Expand Down