internal/joptsimple/OptionDeclarer.java

31  * Trains the option parser. This interface aids integration with other code which may expose declaration of options but
39      * Tells the parser to recognize the given option.
49      * <p>If no methods are invoked on the returned {@link OptionSpecBuilder}, then the parser treats the option as
52      * @param option the option to recognize
53      * @return an object that can be used to flesh out more detail about the option
54      * @throws OptionException if the option contains illegal characters
55      * @throws NullPointerException if the option is {@code null}
57     OptionSpecBuilder accepts( String option );
60      * Tells the parser to recognize the given option.
63      * @param option the option to recognize
64      * @param description a string that describes the purpose of the option. This is used when generating help
66      * @return an object that can be used to flesh out more detail about the option
67      * @throws OptionException if the option contains illegal characters
68      * @throws NullPointerException if the option is {@code null}
70     OptionSpecBuilder accepts( String option, String description );
79      * @throws NullPointerException if the option list or any of its elements are {@code null}
88      * @param description a string that describes the purpose of the option.  This is used when generating help
92      * @throws NullPointerException if the option list or any of its elements are {@code null}
93      * @throws IllegalArgumentException if the option list is empty
98      * Gives an object that represents an access point for non-option arguments on a command line.
100      * @return an object that can be used to flesh out more detail about the non-option arguments
105      * Gives an object that represents an access point for non-option arguments on a command line.
108      * @param description a string that describes the purpose of the non-option arguments. This is used when generating
110      * @return an object that can be used to flesh out more detail about the non-option arguments
122      * <p>Tells the parser to treat unrecognized options as non-option arguments.</p>
125      * option.</p>