Class OptionBuilder

    • Method Detail

      • withLongOpt

        public static OptionBuilder withLongOpt​(String newLongopt)
        Deprecated.
        The next Option created will have the following long option value.
        Parameters:
        newLongopt - the long option value
        Returns:
        the OptionBuilder instance
      • hasArg

        public static OptionBuilder hasArg()
        Deprecated.
        The next Option created will require an argument value.
        Returns:
        the OptionBuilder instance
      • hasArg

        public static OptionBuilder hasArg​(boolean hasArg)
        Deprecated.
        The next Option created will require an argument value if hasArg is true.
        Parameters:
        hasArg - if true then the Option has an argument value
        Returns:
        the OptionBuilder instance
      • withArgName

        public static OptionBuilder withArgName​(String name)
        Deprecated.
        The next Option created will have the specified argument value name.
        Parameters:
        name - the name for the argument value
        Returns:
        the OptionBuilder instance
      • isRequired

        public static OptionBuilder isRequired()
        Deprecated.
        The next Option created will be required.
        Returns:
        the OptionBuilder instance
      • withValueSeparator

        public static OptionBuilder withValueSeparator​(char sep)
        Deprecated.
        The next Option created uses sep as a means to separate argument values.

        Example:

         Option opt = OptionBuilder.withValueSeparator('=')
                                   .create('D');
        
         String args = "-Dkey=value";
         CommandLine line = parser.parse(args);
         String propertyName = opt.getValue(0);  // will be "key"
         String propertyValue = opt.getValue(1); // will be "value"
         
        Parameters:
        sep - The value separator to be used for the argument values.
        Returns:
        the OptionBuilder instance
      • withValueSeparator

        public static OptionBuilder withValueSeparator()
        Deprecated.
        The next Option created uses '=' as a means to separate argument values. Example:
         Option opt = OptionBuilder.withValueSeparator()
                                   .create('D');
        
         CommandLine line = parser.parse(args);
         String propertyName = opt.getValue(0);
         String propertyValue = opt.getValue(1);
         
        Returns:
        the OptionBuilder instance
      • isRequired

        public static OptionBuilder isRequired​(boolean newRequired)
        Deprecated.
        The next Option created will be required if required is true.
        Parameters:
        newRequired - if true then the Option is required
        Returns:
        the OptionBuilder instance
      • hasArgs

        public static OptionBuilder hasArgs()
        Deprecated.
        The next Option created can have unlimited argument values.
        Returns:
        the OptionBuilder instance
      • hasArgs

        public static OptionBuilder hasArgs​(int num)
        Deprecated.
        The next Option created can have num argument values.
        Parameters:
        num - the number of args that the option can have
        Returns:
        the OptionBuilder instance
      • hasOptionalArg

        public static OptionBuilder hasOptionalArg()
        Deprecated.
        The next Option can have an optional argument.
        Returns:
        the OptionBuilder instance
      • hasOptionalArgs

        public static OptionBuilder hasOptionalArgs()
        Deprecated.
        The next Option can have an unlimited number of optional arguments.
        Returns:
        the OptionBuilder instance
      • hasOptionalArgs

        public static OptionBuilder hasOptionalArgs​(int numArgs)
        Deprecated.
        The next Option can have the specified number of optional arguments.
        Parameters:
        numArgs - - the maximum number of optional arguments the next Option created can have.
        Returns:
        the OptionBuilder instance
      • withType

        @Deprecated
        public static OptionBuilder withType​(Object newType)
        Deprecated.
        since 1.3, use withType(Class) instead
        The next Option created will have a value that will be an instance of type.

        Note: this method is kept for binary compatibility and the input type is supposed to be a Class object.

        Parameters:
        newType - the type of the Options argument value
        Returns:
        the OptionBuilder instance
      • withType

        public static OptionBuilder withType​(Class<?> newType)
        Deprecated.
        The next Option created will have a value that will be an instance of type.
        Parameters:
        newType - the type of the Options argument value
        Returns:
        the OptionBuilder instance
        Since:
        1.3
      • withDescription

        public static OptionBuilder withDescription​(String newDescription)
        Deprecated.
        The next Option created will have the specified description
        Parameters:
        newDescription - a description of the Option's purpose
        Returns:
        the OptionBuilder instance
      • create

        public static Option create​(char opt)
                             throws IllegalArgumentException
        Deprecated.
        Create an Option using the current settings and with the specified Option char.
        Parameters:
        opt - the character representation of the Option
        Returns:
        the Option instance
        Throws:
        IllegalArgumentException - if opt is not a valid character. See Option.
      • create

        public static Option create​(String opt)
                             throws IllegalArgumentException
        Deprecated.
        Create an Option using the current settings and with the specified Option char.
        Parameters:
        opt - the java.lang.String representation of the Option
        Returns:
        the Option instance
        Throws:
        IllegalArgumentException - if opt is not a valid character. See Option.