1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 | /* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package Apache.CLI; import static Apache.CLI.Util.EMPTY_STRING_ARRAY; import java.io.Serializable; import java.util.ArrayList; import java.util.List; import java.util.Objects; /** * Describes a single command-line option. It maintains information regarding the short-name of the * option, the long-name, if any exists, a flag indicating if an argument is required for this * option, and a self-documenting description of the option. * * <BR /><BR />An Option is not created independently, but is created through an instance of * {@link Options}. An Option is required to have at least a short or a long-name. * * <BR /><BR /><B CLASS=JDDescLabel>Note:</B> * * <BR />Once an {@link Option} has been added to an instance of {@link Options}, its required flag * cannot be changed. * * @see Apache.CLI.Options * @see Apache.CLI.CommandLine */ @Torello.JavaDoc.JDHeaderBackgroundImg(EmbedTagFileID="LICENSE") public class Option implements Cloneable, Serializable { /** * A nested builder class to create {@code Option} instances using descriptive methods. * * <BR /><BR />Example usage: * * <DIV CLASS=EXAMPLE>{@code * Option option = Option.builder("a").required(true).longOpt("arg-name").build(); * }</DIV> */ @Torello.JavaDoc.JDHeaderBackgroundImg(EmbedTagFileID="LICENSE") public static final class Builder { // The name of the option private String option; // Description of the option private String description; // The long representation of the option private String longOption; // The name of the argument for this option private String argName; // Specifies whether this option is required to be present private boolean required; // Specifies whether the argument value of this Option is optional private boolean optionalArg; // The number of argument values this option can have private int argCount = UNINITIALIZED; // The type of this Option private Class<?> type = String.class; // The character that is the value separator private char valueSeparator; /** * Constructs a new {@code Builder} with the minimum required parameters for an * {@code Option} instance. * * @param option short representation of the option * * @throws IllegalArgumentException if there are any non valid Option characters in * {@code opt} */ private Builder(final String option) throws IllegalArgumentException { option(option); } /** * Sets the display name for the argument value. * @param argName the display name for the argument value. * @return this builder, to allow method chaining */ public Builder argName(final String argName) { this.argName = argName; return this; } /** * Constructs an Option with the values declared by this {@link Builder}. * @return the new {@link Option} * @throws IllegalArgumentException if neither {@code opt} or {@code longOpt} has been set */ public Option build() { if (option == null && longOption == null) throw new IllegalArgumentException("Either opt or longOpt must be specified"); return new Option(this); } /** * Sets the description for this option. * @param description the description of the option. * @return this builder, to allow method chaining */ public Builder desc(final String description) { this.description = description; return this; } /** * Indicates that the Option will require an argument. * @return this builder, to allow method chaining */ public Builder hasArg() { return hasArg(true); } /** * Indicates if the Option has an argument or not. * @param hasArg specifies whether the Option takes an argument or not * @return this builder, to allow method chaining */ public Builder hasArg(final boolean hasArg) { // set to UNINITIALIZED when no arg is specified to be compatible with OptionBuilder argCount = hasArg ? 1 : Option.UNINITIALIZED; return this; } /** * Indicates that the Option can have unlimited argument values. * @return this builder, to allow method chaining */ public Builder hasArgs() { argCount = Option.UNLIMITED_VALUES; return this; } /** * Sets the long name of the Option. * @param longOpt the long name of the Option * @return this builder, to allow method chaining */ public Builder longOpt(final String longOpt) { this.longOption = longOpt; return this; } /** * Sets the number of argument values the Option can take. * @param argCount the number of argument values * @return this builder, to allow method chaining */ public Builder numberOfArgs(final int argCount) { this.argCount = argCount; return this; } /** * Sets the name of the Option. * @param option the name of the Option * @return this builder, to allow method chaining * * @throws IllegalArgumentException if there are any non valid Option characters in * {@code opt} */ public Builder option(final String option) throws IllegalArgumentException { this.option = OptionValidator.validate(option); return this; } /** * Sets whether the Option can have an optional argument. * * @param optionalArg specifies whether the Option can have an optional argument. * @return this builder, to allow method chaining */ public Builder optionalArg(final boolean optionalArg) { this.argCount = optionalArg ? 1 : UNINITIALIZED; this.optionalArg = optionalArg; return this; } /** * Marks this Option as required. * @return this builder, to allow method chaining */ public Builder required() { return required(true); } /** * Sets whether the Option is mandatory. * @param required specifies whether the Option is mandatory * @return this builder, to allow method chaining */ public Builder required(final boolean required) { this.required = required; return this; } /** * Sets the type of the Option. * @param type the type of the Option * @return this builder, to allow method chaining */ public Builder type(final Class<?> type) { this.type = type; return this; } /** * The Option will use {@code '='} as a means to separate argument value. * @return this builder, to allow method chaining */ public Builder valueSeparator() { return valueSeparator('='); } /** * The Option will use {@code sep} as a means to separate argument values. See the example * below: * * <DIV CLASS=EXAMPLE>{@code * Option opt = Option.builder("D").hasArgs().valueSeparator('=').build(); * Options options = new Options(); * * options.addOption(opt); * * String[] args = {"-Dkey=value"}; * CommandLineParser parser = new DefaultParser(); * CommandLine line = parser.parse(options, args); * * // will be "key" * String propertyName = line.getOptionValues("D")[0]; * * // will be "value" * String propertyValue = line.getOptionValues("D")[1]; * }</DIV> * * @param valueSeparator The value separator. * @return this builder, to allow method chaining */ public Builder valueSeparator(final char valueSeparator) { this.valueSeparator = valueSeparator; return this; } } /** Specifies the number of argument values has not been specified */ public static final int UNINITIALIZED = -1; /** Specifies the number of argument values is infinite */ public static final int UNLIMITED_VALUES = -2; // The serial version UID. private static final long serialVersionUID = 1L; // Empty array. static final Option[] EMPTY_ARRAY = {}; /** * Returns a {@link Builder} to create an {@link Option} using descriptive methods. * @return a new {@link Builder} instance */ public static Builder builder() { return builder(null); } /** * Returns a {@link Builder} to create an {@link Option} using descriptive methods. * @param option short representation of the option * @return a new {@link Builder} instance * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt} */ public static Builder builder(final String option) { return new Builder(option); } // The name of the option. */ private final String option; // The long representation of the option. */ private String longOption; // The name of the argument for this option private String argName; // Description of the option private String description; // Specifies whether this option is required to be present private boolean required; // Specifies whether the argument value of this Option is optional private boolean optionalArg; // The number of argument values this option can have private int argCount = UNINITIALIZED; // The type of this Option private Class<?> type = String.class; // The list of argument values private List<String> values = new ArrayList<>(); // The character that is the value separator. private char valuesep; /** * Private constructor used by the nested Builder class. * @param builder builder used to create this option */ private Option(final Builder builder) { this.argName = builder.argName; this.description = builder.description; this.longOption = builder.longOption; this.argCount = builder.argCount; this.option = builder.option; this.optionalArg = builder.optionalArg; this.required = builder.required; this.type = builder.type; this.valuesep = builder.valueSeparator; } /** * Creates an Option using the specified parameters. * @param option short representation of the option * @param hasArg specifies whether the Option takes an argument or not * @param description describes the function of the option * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt} */ public Option(final String option, final boolean hasArg, final String description) throws IllegalArgumentException { this(option, null, hasArg, description); } /** * Creates an Option using the specified parameters. The option does not take an argument. * @param option short representation of the option * @param description describes the function of the option * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt} */ public Option(final String option, final String description) throws IllegalArgumentException { this(option, null, false, description); } /** * Creates an Option using the specified parameters. * @param option short representation of the option * @param longOption the long representation of the option * @param hasArg specifies whether the Option takes an argument or not * @param description describes the function of the option * @throws IllegalArgumentException if there are any non valid Option characters in {@code opt} */ public Option( final String option, final String longOption, final boolean hasArg, final String description ) throws IllegalArgumentException { // ensure that the option is valid this.option = OptionValidator.validate(option); this.longOption = longOption; // if hasArg is set then the number of arguments is 1 if (hasArg) this.argCount = 1; this.description = description; } /** * Tells if the option can accept more arguments. * @return false if the maximum number of arguments is reached */ boolean acceptsArg() { return (hasArg() || hasArgs() || hasOptionalArg()) && (argCount <= 0 || values.size() < argCount); } /** * Add the value to this Option. If the number of arguments is greater than zero and there is * enough space in the list then add the value. Otherwise, throw a runtime exception. * * @param value The value to be added to this Option */ private void add(final String value) { if (!acceptsArg()) throw new IllegalArgumentException("Cannot add value, list full."); // store value values.add(value); } /** * Adds the specified value to this Option. * @param value is a/the value of this Option */ void addValueForProcessing(final String value) { if (argCount == UNINITIALIZED) throw new IllegalArgumentException("NO_ARGS_ALLOWED"); processValue(value); } /** * Clear the Option values. After a parse is complete, these are left with data in them and they need clearing if * another parse is done. * * See: <a href="https://issues.apache.org/jira/browse/CLI-71">CLI-71</a> */ void clearValues() { values.clear(); } /** * A rather odd clone method - due to incorrect code in 1.0 it is public and in 1.1 rather than throwing a * CloneNotSupportedException it throws a RuntimeException so as to maintain backwards compat at the API level. * * After calling this method, it is very likely you will want to call clearValues(). * * @return a clone of this Option instance * @throws RuntimeException if a {@link CloneNotSupportedException} has been thrown by {@code super.clone()} */ @Override public Object clone() { try { final Option option = (Option) super.clone(); option.values = new ArrayList<>(values); return option; } catch (final CloneNotSupportedException e) { throw new UnsupportedOperationException(e.getMessage(), e); } } @Override public boolean equals(final Object obj) { if (this == obj) return true; if (!(obj instanceof Option)) return false; final Option other = (Option) obj; return Objects.equals(longOption, other.longOption) && Objects.equals(option, other.option); } /** * Gets the display name for the argument value. * @return the display name for the argument value. */ public String getArgName() { return argName; } /** * Gets the number of argument values this Option can take. * * <BR /><BR /> * A value equal to the constant {@link #UNINITIALIZED} (= -1) indicates the number of * arguments has not been specified. * * <BR /><BR /> * A value equal to the constant {@link #UNLIMITED_VALUES} (= -2) indicates that this options * takes an unlimited amount of values. * * @return num the number of argument values * @see #UNINITIALIZED * @see #UNLIMITED_VALUES */ public int getArgs() { return argCount; } /** * Gets the self-documenting description of this Option * @return The string description of this option */ public String getDescription() { return description; } /** * Gets the id of this Option. This is only set when the Option shortOpt is a single character. This is used for * switch statements. * * @return the id of this Option */ public int getId() { return getKey().charAt(0); } /** * Gets the 'unique' Option identifier. * @return the 'unique' Option identifier */ String getKey() { // if 'opt' is null, then it is a 'long' option return option == null ? longOption : option; } /** * Gets the long name of this Option. * @return Long name of this option, or null, if there is no long name */ public String getLongOpt() { return longOption; } /** * Gets the name of this Option. * * <BR /><BR />It is this {@code String} which can be used with * {@link CommandLine#hasOption(String opt)} and * {@link CommandLine#getOptionValue(String opt)} to check for existence and argument. * * @return The name of this option */ public String getOpt() { return option; } /** * Gets the type of this Option. * @return The type of this option */ public Object getType() { return type; } /** * Gets the specified value of this Option or {@code null} if there is no value. * @return the value/first value of this Option or {@code null} if there is no value. */ public String getValue() { return hasNoValues() ? null : values.get(0); } /** * Gets the specified value of this Option or {@code null} if there is no value. * @param index The index of the value to be returned. * @return the specified value of this Option or {@code null} if there is no value. * * @throws IndexOutOfBoundsException if index is less than 1 or greater than the number of the * values for this Option. */ public String getValue(final int index) throws IndexOutOfBoundsException { return hasNoValues() ? null : values.get(index); } /** * Gets the value/first value of this Option or the {@code defaultValue} if there is no value. * @param defaultValue The value to be returned if there is no value. * * @return the value/first value of this Option or the {@code defaultValue} if there are no * values. */ public String getValue(final String defaultValue) { final String value = getValue(); return value != null ? value : defaultValue; } /** * Gets the values of this Option as a String array or null if there are no values * @return the values of this Option as a String array or null if there are no values */ public String[] getValues() { return hasNoValues() ? null : values.toArray(EMPTY_STRING_ARRAY); } /** * Gets the value separator character. * @return the value separator character. */ public char getValueSeparator() { return valuesep; } /** * Gets the values of this Option as a List or null if there are no values. * @return the values of this Option as a List or null if there are no values */ public List<String> getValuesList() { return values; } /** * Query to see if this Option requires an argument * @return boolean flag indicating if an argument is required */ public boolean hasArg() { return argCount > 0 || argCount == UNLIMITED_VALUES; } /** * Returns whether the display name for the argument value has been set. * @return if the display name for the argument value has been set. */ public boolean hasArgName() { return argName != null && !argName.isEmpty(); } /** * Query to see if this Option can take many values. * @return boolean flag indicating if multiple values are allowed */ public boolean hasArgs() { return argCount > 1 || argCount == UNLIMITED_VALUES; } @Override public int hashCode() { return Objects.hash(longOption, option); } /** * Query to see if this Option has a long name * @return boolean flag indicating existence of a long name */ public boolean hasLongOpt() { return longOption != null; } /** * Returns whether this Option has any values. * @return whether this Option has any values. */ private boolean hasNoValues() { return values.isEmpty(); } /** @return whether this Option can have an optional argument */ public boolean hasOptionalArg() { return optionalArg; } /** * Return whether this Option has specified a value separator. * @return whether this Option has specified a value separator. */ public boolean hasValueSeparator() { return valuesep > 0; } /** * Query to see if this Option is mandatory * @return boolean flag indicating whether this Option is mandatory */ public boolean isRequired() { return required; } /** * Processes the value. If this Option has a value separator the value will have to be parsed * into individual tokens. When n-1 tokens have been processed and there are more value * separators in the value, parsing is ceased and the remaining characters are added as a * single token. * * @param value The String to be processed. */ private void processValue(String value) { // this Option has a separator character if (hasValueSeparator()) { // get the separator character final char sep = getValueSeparator(); // store the index for the value separator int index = value.indexOf(sep); // while there are more value separators while (index != -1) { // next value to be added if (values.size() == argCount - 1) break; // store add(value.substring(0, index)); // parse value = value.substring(index + 1); // get new index index = value.indexOf(sep); } } // store the actual value or the last value that has been parsed add(value); } /** * Tells if the option requires more arguments to be valid. * @return false if the option doesn't require more arguments */ boolean requiresArg() { if (optionalArg) return false; if (argCount == UNLIMITED_VALUES) return values.isEmpty(); return acceptsArg(); } /** * Sets the display name for the argument value. * @param argName the display name for the argument value. */ public void setArgName(final String argName) { this.argName = argName; } /** * Sets the number of argument values this Option can take. * @param num the number of argument values */ public void setArgs(final int num) { this.argCount = num; } /** * Sets the self-documenting description of this Option * @param description The description of this option */ public void setDescription(final String description) { this.description = description; } /** * Sets the long name of this Option. * @param longOpt the long name of this Option */ public void setLongOpt(final String longOpt) { this.longOption = longOpt; } /** * Sets whether this Option can have an optional argument. * @param optionalArg specifies whether the Option can have an optional argument. */ public void setOptionalArg(final boolean optionalArg) { this.optionalArg = optionalArg; } /** * Sets whether this Option is mandatory. * @param required specifies whether this Option is mandatory */ public void setRequired(final boolean required) { this.required = required; } /** * Sets the type of this Option. * @param type the type of this Option */ public void setType(final Class<?> type) { this.type = type; } /** * Sets the value separator. For example if the argument value was a Java property, the value * separator would be '='. * * @param sep The value separator. */ public void setValueSeparator(final char sep) { this.valuesep = sep; } /** * Dump state, suitable for debugging. * @return Stringified form of this object */ @Override public String toString() { final StringBuilder buf = new StringBuilder().append("[ option: "); buf.append(option); if (longOption != null) buf.append(" ").append(longOption); buf.append(" "); if (hasArgs()) buf.append("[ARG...]"); else if (hasArg()) buf.append(" [ARG]"); buf.append(" :: ").append(description); if (type != null) buf.append(" :: ").append(type); buf.append(" ]"); return buf.toString(); } } |