Package org.apache.commons.cli

Class CommandLine.Builder

  • All Implemented Interfaces:
    java.util.function.Supplier<CommandLine>
    Enclosing class:
    CommandLine
    public static final class CommandLine.Builder
extends java.lang.Object
implements java.util.function.Supplier<CommandLine>
    A nested builder class to create CommandLine instance using descriptive methods.
    Since:
    1.4

    • Field Detail

      • DEPRECATED_HANDLER

        static final java.util.function.Consumer<Option> DEPRECATED_HANDLER
        Prints an Option to System.out.

      • args

        private final java.util.List<java.lang.String> args
        The unrecognized options/arguments

      • options

        private final java.util.List<Option> options
        The processed options

      • deprecatedHandler

        private java.util.function.Consumer<Option> deprecatedHandler
        Deprecated Option handler.

    • Constructor Detail

      • Builder

        @Deprecated
public Builder()
        Deprecated.
        Use CommandLine.builder().
        Constructs a new instance.

    • Method Detail

      • addArg

        public CommandLine.Builder addArg​(java.lang.String arg)
        Adds left-over unrecognized option/argument.
        Parameters:
        arg - the unrecognized option/argument.
        Returns:
        this Builder instance for method chaining.

      • addOption

        public CommandLine.Builder addOption​(Option option)
        Adds an option to the command line. The values of the option are stored.
        Parameters:
        option - the processed option.
        Returns:
        this Builder instance for method chaining.

      • build

        @Deprecated
public CommandLine build()
        Deprecated.
        Use get().
        Creates a new instance.
        Returns:
        a new instance.

      • get

        public CommandLine get()
        Creates a new instance.
        Specified by:
        get in interface java.util.function.Supplier<CommandLine>
        Returns:
        a new instance.
        Since:
        1.10.0

      • setDeprecatedHandler

        public CommandLine.Builder setDeprecatedHandler​(java.util.function.Consumer<Option> deprecatedHandler)
        Sets the deprecated option handler.
        Parameters:
        deprecatedHandler - the deprecated option handler.
        Returns:
        this instance.
        Since:
        1.7.0