Skip to content

Commit aede31b

Browse files
garydgregorygarydgregory
committed
Javadoc
1 parent d244231 commit aede31b

1 file changed

Lines changed: 30 additions & 30 deletions

File tree

‎src/main/java/org/apache/commons/cli/CommandLine.java‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ private <T> T get(final Supplier<T> supplier) {
204204
}
205205

206206
/**
207-
* Gets any left-over non-recognized options and arguments
207+
* Gets any left-over non-recognized options and arguments.
208208
*
209209
* @return remaining items passed in but not parsed as a {@code List}.
210210
*/
@@ -213,7 +213,7 @@ public List<String> getArgList() {
213213
}
214214

215215
/**
216-
* Gets any left-over non-recognized options and arguments
216+
* Gets any left-over non-recognized options and arguments.
217217
*
218218
* @return remaining items passed in but not parsed as an array.
219219
*/
@@ -225,7 +225,7 @@ public String[] getArgs() {
225225
* Gets the number of times this option appears in the command line
226226
*
227227
* @param optionChar the character name of the option.
228-
* @return Number of times the option is present
228+
* @return Number of times the option is present.
229229
* @since 1.11.0
230230
*/
231231
public int getOptionCount(final char optionChar) {
@@ -236,7 +236,7 @@ public int getOptionCount(final char optionChar) {
236236
* Gets the number of times this option appears in the command line.
237237
*
238238
* @param option the option.
239-
* @return Number of times the option is present
239+
* @return Number of times the option is present.
240240
* @since 1.11.0
241241
*/
242242
public int getOptionCount(final Option option) {
@@ -247,7 +247,7 @@ public int getOptionCount(final Option option) {
247247
* Gets the number of times this option appears in the command line
248248
*
249249
* @param optionName the name of the option.
250-
* @return Number of times the option is present
250+
* @return Number of times the option is present.
251251
* @since 1.11.0
252252
*/
253253
public int getOptionCount(final String optionName) {
@@ -357,7 +357,7 @@ public String getOptionValue(final char optionChar, final String defaultValue) {
357357
/**
358358
* Gets the argument, if any, of an option.
359359
*
360-
* @param optionChar character name of the option
360+
* @param optionChar character name of the option.
361361
* @param defaultValue is a supplier for the default value to be returned if the option is not specified.
362362
* @return Value of the argument if option is set, and has an argument, otherwise {@code defaultValue}.
363363
* @since 1.7.0
@@ -536,7 +536,7 @@ public String[] getOptionValues(final String optionName) {
536536
* @param optionChar the name of the option.
537537
* @param <T> The return type for the method.
538538
* @return the value parsed into a particular object or null if the option is not set.
539-
* @throws ParseException if there are problems turning the option value into the desired type
539+
* @throws ParseException if there are problems turning the option value into the desired type.
540540
* @see PatternOptionBuilder
541541
* @since 1.5.0
542542
*/
@@ -551,7 +551,7 @@ public <T> T getParsedOptionValue(final char optionChar) throws ParseException {
551551
* @param defaultValue the default value to return if opt is not set.
552552
* @param <T> The return type for the method.
553553
* @return the value parsed into a particular object or the defaultValue if the option is not set.
554-
* @throws ParseException if there are problems turning the option value into the desired type
554+
* @throws ParseException if there are problems turning the option value into the desired type.
555555
* @see PatternOptionBuilder
556556
* @since 1.7.0
557557
*/
@@ -566,7 +566,7 @@ public <T> T getParsedOptionValue(final char optionChar, final Supplier<T> defau
566566
* @param defaultValue the default value to return if opt is not set.
567567
* @param <T> The return type for the method.
568568
* @return the value parsed into a particular object or the defaultValue if the option is not set.
569-
* @throws ParseException if there are problems turning the option value into the desired type
569+
* @throws ParseException if there are problems turning the option value into the desired type.
570570
* @see PatternOptionBuilder
571571
* @since 1.7.0
572572
*/
@@ -580,7 +580,7 @@ public <T> T getParsedOptionValue(final char optionChar, final T defaultValue) t
580580
* @param option the option.
581581
* @param <T> The return type for the method.
582582
* @return the value parsed into a particular object or null if the option is not set.
583-
* @throws ParseException if there are problems turning the option value into the desired type
583+
* @throws ParseException if there are problems turning the option value into the desired type.
584584
* @see PatternOptionBuilder
585585
* @since 1.5.0
586586
*/
@@ -595,7 +595,7 @@ public <T> T getParsedOptionValue(final Option option) throws ParseException {
595595
* @param defaultValue the default value to return if opt is not set.
596596
* @param <T> The return type for the method.
597597
* @return the value parsed into a particular object or the defaultValue if the option is not set.
598-
* @throws ParseException if there are problems turning the option value into the desired type
598+
* @throws ParseException if there are problems turning the option value into the desired type.
599599
* @see PatternOptionBuilder
600600
* @since 1.7.0
601601
*/
@@ -622,7 +622,7 @@ public <T> T getParsedOptionValue(final Option option, final Supplier<T> default
622622
* @param defaultValue the default value to return if opt is not set.
623623
* @param <T> The return type for the method.
624624
* @return the value parsed into a particular object or the defaultValue if the option is not set.
625-
* @throws ParseException if there are problems turning the option value into the desired type
625+
* @throws ParseException if there are problems turning the option value into the desired type.
626626
* @see PatternOptionBuilder
627627
* @since 1.7.0
628628
*/
@@ -636,7 +636,7 @@ public <T> T getParsedOptionValue(final Option option, final T defaultValue) thr
636636
* @param optionGroup the option group.
637637
* @param <T> The return type for the method.
638638
* @return the value parsed into a particular object or null if no option in the OptionGroup is set.
639-
* @throws ParseException if there are problems turning the selected option value into the desired type
639+
* @throws ParseException if there are problems turning the selected option value into the desired type.
640640
* @see PatternOptionBuilder
641641
* @since 1.9.0
642642
*/
@@ -651,7 +651,7 @@ public <T> T getParsedOptionValue(final OptionGroup optionGroup) throws ParseExc
651651
* @param defaultValue the default value to return if opt is not set.
652652
* @param <T> The return type for the method.
653653
* @return the value parsed into a particular object or the defaultValue if no option in the OptionGroup is set.
654-
* @throws ParseException if there are problems turning the selected option value into the desired type
654+
* @throws ParseException if there are problems turning the selected option value into the desired type.
655655
* @see PatternOptionBuilder
656656
* @since 1.9.0
657657
*/
@@ -669,7 +669,7 @@ public <T> T getParsedOptionValue(final OptionGroup optionGroup, final Supplier<
669669
* @param defaultValue the default value to return if an option is not selected.
670670
* @param <T> The return type for the method.
671671
* @return the value parsed into a particular object or the defaultValue if no option in the OptionGroup is set.
672-
* @throws ParseException if there are problems turning the option value into the desired type
672+
* @throws ParseException if there are problems turning the option value into the desired type.
673673
* @see PatternOptionBuilder
674674
* @since 1.9.0
675675
*/
@@ -683,7 +683,7 @@ public <T> T getParsedOptionValue(final OptionGroup optionGroup, final T default
683683
* @param optionName the name of the option.
684684
* @param <T> The return type for the method.
685685
* @return the value parsed into a particular object or null if the option is not set.
686-
* @throws ParseException if there are problems turning the option value into the desired type
686+
* @throws ParseException if there are problems turning the option value into the desired type.
687687
* @see PatternOptionBuilder
688688
* @since 1.2
689689
*/
@@ -698,7 +698,7 @@ public <T> T getParsedOptionValue(final String optionName) throws ParseException
698698
* @param defaultValue the default value to return if opt is not set.
699699
* @param <T> The return type for the method.
700700
* @return the value parsed into a particular object or the defaultValue if the option is not set.
701-
* @throws ParseException if there are problems turning the option value into the desired type
701+
* @throws ParseException if there are problems turning the option value into the desired type.
702702
* @see PatternOptionBuilder
703703
* @since 1.7.0
704704
*/
@@ -713,7 +713,7 @@ public <T> T getParsedOptionValue(final String optionName, final Supplier<T> def
713713
* @param defaultValue the default value to return if opt is not set.
714714
* @param <T> The return type for the method.
715715
* @return the value parsed into a particular object or the defaultValue if the option is not set.
716-
* @throws ParseException if there are problems turning the option value into the desired type
716+
* @throws ParseException if there are problems turning the option value into the desired type.
717717
* @see PatternOptionBuilder
718718
* @since 1.7.0
719719
*/
@@ -727,7 +727,7 @@ public <T> T getParsedOptionValue(final String optionName, final T defaultValue)
727727
* @param optionChar the name of the option.
728728
* @param <T> The array type for the return value.
729729
* @return the values parsed into an array of objects or null if the option is not set.
730-
* @throws ParseException if there are problems turning the option value into the desired type
730+
* @throws ParseException if there are problems turning the option value into the desired type.
731731
* @see PatternOptionBuilder
732732
* @since 1.10.0
733733
*/
@@ -742,7 +742,7 @@ public <T> T[] getParsedOptionValues(final char optionChar) throws ParseExceptio
742742
* @param defaultValue the default value to return if opt is not set.
743743
* @param <T> The array type for the return value.
744744
* @return the values parsed into an array of objects or the defaultValue if the option is not set.
745-
* @throws ParseException if there are problems turning the option value into the desired type
745+
* @throws ParseException if there are problems turning the option value into the desired type.
746746
* @see PatternOptionBuilder
747747
* @since 1.10.0
748748
*/
@@ -757,7 +757,7 @@ public <T> T[] getParsedOptionValues(final char optionChar, final Supplier<T[]>
757757
* @param defaultValue the default value to return if opt is not set.
758758
* @param <T> The array type for the return value.
759759
* @return the values parsed into an array of objects or the defaultValue if the option is not set.
760-
* @throws ParseException if there are problems turning the option value into the desired type
760+
* @throws ParseException if there are problems turning the option value into the desired type.
761761
* @see PatternOptionBuilder
762762
* @since 1.10.0
763763
*/
@@ -771,7 +771,7 @@ public <T> T[] getParsedOptionValues(final char optionChar, final T[] defaultVal
771771
* @param option the option.
772772
* @param <T> The array type for the return value.
773773
* @return the values parsed into an array of objects or null if the option is not set.
774-
* @throws ParseException if there are problems turning the option value into the desired type
774+
* @throws ParseException if there are problems turning the option value into the desired type.
775775
* @see PatternOptionBuilder
776776
* @since 1.10.0
777777
*/
@@ -786,7 +786,7 @@ public <T> T[] getParsedOptionValues(final Option option) throws ParseException
786786
* @param defaultValue the default value to return if opt is not set.
787787
* @param <T> The array type for the return value.
788788
* @return the values parsed into an array of objects or the defaultValue if the option is not set.
789-
* @throws ParseException if there are problems turning the option value into the desired type
789+
* @throws ParseException if there are problems turning the option value into the desired type.
790790
* @see PatternOptionBuilder
791791
* @since 1.10.0
792792
*/
@@ -818,7 +818,7 @@ public <T> T[] getParsedOptionValues(final Option option, final Supplier<T[]> de
818818
* @param defaultValue the default value to return if opt is not set.
819819
* @param <T> The array type for the return value.
820820
* @return the values parsed into an array of objects or the defaultValue if the option is not set.
821-
* @throws ParseException if there are problems turning the option value into the desired type
821+
* @throws ParseException if there are problems turning the option value into the desired type.
822822
* @see PatternOptionBuilder
823823
* @since 1.10.0
824824
*/
@@ -832,7 +832,7 @@ public <T> T[] getParsedOptionValues(final Option option, final T[] defaultValue
832832
* @param optionGroup the option group.
833833
* @param <T> The array type for the return value.
834834
* @return the values parsed into an array of objects or null if no option in the OptionGroup is set.
835-
* @throws ParseException if there are problems turning the selected option value into the desired type
835+
* @throws ParseException if there are problems turning the selected option value into the desired type.
836836
* @see PatternOptionBuilder
837837
* @since 1.10.0
838838
*/
@@ -847,7 +847,7 @@ public <T> T[] getParsedOptionValues(final OptionGroup optionGroup) throws Parse
847847
* @param defaultValue the default value to return if opt is not set.
848848
* @param <T> The array type for the return value.
849849
* @return the values parsed into an array of objects or null if no option in the OptionGroup is set.
850-
* @throws ParseException if there are problems turning the selected option value into the desired type
850+
* @throws ParseException if there are problems turning the selected option value into the desired type.
851851
* @see PatternOptionBuilder
852852
* @since 1.10.0
853853
*/
@@ -865,7 +865,7 @@ public <T> T[] getParsedOptionValues(final OptionGroup optionGroup, final Suppli
865865
* @param defaultValue the default value to return if an option is not selected.
866866
* @param <T> The array type for the return value.
867867
* @return the values parsed into an array of objects or null if no option in the OptionGroup is set.
868-
* @throws ParseException if there are problems turning the option value into the desired type
868+
* @throws ParseException if there are problems turning the option value into the desired type.
869869
* @see PatternOptionBuilder
870870
* @since 1.10.0
871871
*/
@@ -879,7 +879,7 @@ public <T> T[] getParsedOptionValues(final OptionGroup optionGroup, final T[] de
879879
* @param optionName the name of the option.
880880
* @param <T> The array type for the return value.
881881
* @return the values parsed into an array of objects or null if the option is not set.
882-
* @throws ParseException if there are problems turning the option value into the desired type
882+
* @throws ParseException if there are problems turning the option value into the desired type.
883883
* @see PatternOptionBuilder
884884
* @since 1.10.0
885885
*/
@@ -894,7 +894,7 @@ public <T> T[] getParsedOptionValues(final String optionName) throws ParseExcept
894894
* @param defaultValue the default value to return if opt is not set.
895895
* @param <T> The array type for the return value.
896896
* @return the values parsed into an array of objects or defaultValues if the option is not set.
897-
* @throws ParseException if there are problems turning the option value into the desired type
897+
* @throws ParseException if there are problems turning the option value into the desired type.
898898
* @see PatternOptionBuilder
899899
* @since 1.10.0
900900
*/
@@ -909,7 +909,7 @@ public <T> T[] getParsedOptionValues(final String optionName, final Supplier<T[]
909909
* @param defaultValue the default value to return if opt is not set.
910910
* @param <T> The array type for the return value.
911911
* @return the values parsed into an array of objects or defaultValues if the option is not set.
912-
* @throws ParseException if there are problems turning the option value into the desired type
912+
* @throws ParseException if there are problems turning the option value into the desired type.
913913
* @see PatternOptionBuilder
914914
* @since 1.10.0
915915
*/

0 commit comments

Comments
 (0)