commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CLI-284) Inconsistency in constraints for creating an instance of class Option using builder pattern or constructor
Date Sat, 09 Jun 2018 12:26:00 GMT

    [ https://issues.apache.org/jira/browse/CLI-284?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16506950#comment-16506950
] 

ASF GitHub Bot commented on CLI-284:
------------------------------------

GitHub user sfuhrm opened a pull request:

    https://github.com/apache/commons-cli/pull/25

    CLI-284: Fix inconsistent behaviour for short and long name == null

    Fix for https://issues.apache.org/jira/browse/CLI-284


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/sfuhrm/commons-cli master

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/commons-cli/pull/25.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #25
    
----
commit 4a2e95d01e39d89ffb2711f0b13f0020fef0d561
Author: Stephan Fuhrmann <s@...>
Date:   2018-06-09T11:24:13Z

    CLI-284: Fix inconsistent behaviour for short and long name == null

----


> Inconsistency in constraints for creating an instance of class Option using builder pattern
or constructor
> ----------------------------------------------------------------------------------------------------------
>
>                 Key: CLI-284
>                 URL: https://issues.apache.org/jira/browse/CLI-284
>             Project: Commons CLI
>          Issue Type: Bug
>            Reporter: Dilraj Singh
>            Priority: Major
>         Attachments: CLI284.patch
>
>
> Builder pattern for creating an instance of class *Option* ensures that at least one
of the representation (short and long representation) for the option is not null. It throws
an *IllegalArgumentException* in-case program tries to build an instance with both the representations
as null. Consider the following code snippet for reference.
> {code:java}
> public static void main(String[] args) {
>   Option.Builder builder = Option.builder();
>   Option op = builder.build();
> } 
> {code}
> This piece of code fails with the following exception
> {noformat}
> Exception in thread "main" java.lang.IllegalArgumentException: Either opt or longOpt
must be specified
> {noformat}
> But if we try to create an instance of Option by calling its constructor, It allows the
creation with both opt and longOpt for Option as null. Consider the following code snippet
for reference
> {code:java}
> public static void main(String[] args) {
>   Option op = new Option(null, null);
>   System.out.format("Short Representation: %s\n" +
>   "Long Representation: %s", op.getOpt(), 
>   op.getLongOpt());
> }
> {code}
> Output:
> {noformat}
> Short Representation: null
> Long Representation: null
> {noformat}
> Calling a method on an instance with both opt and longOpt as null will lead to undesired
null pointer exception. For example, calling
> {code:java}
>  op.getId() {code}
> will throw a null pointer exception, thus violating the method contract.
> So as to fix this we need to make sure that whenever a constructor is invoked it has
a non-null argument value for at least one of the Option representation. 



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message