Class Options

  • All Implemented Interfaces:
    Option

    public class Options
    extends Object
    implements Option
    Yet another GNU long options parser. This one is configured by parsing its Usage string.
    • Field Detail

      • NL

        public static final String NL
    • Method Detail

      • main

        public static void main​(String[] args)
      • compile

        public static Option compile​(String[] optSpec)
      • compile

        public static Option compile​(String optSpec)
      • setStopOnBadOption

        public Option setStopOnBadOption​(boolean stopOnBadOption)
        Description copied from interface: Option
        stop parsing on the first unknown option. This allows one parser to get its own options and then pass the remaining options to another parser.
        Specified by:
        setStopOnBadOption in interface Option
      • setOptionsFirst

        public Option setOptionsFirst​(boolean optionsFirst)
        Description copied from interface: Option
        require options to precede args. Default is false, so options can appear between or after args.
        Specified by:
        setOptionsFirst in interface Option
      • isSet

        public boolean isSet​(String name)
        Description copied from interface: Option
        test whether specified option has been explicitly set.
        Specified by:
        isSet in interface Option
        Returns:
      • getObject

        public Object getObject​(String name)
        Description copied from interface: Option
        get value of named option as an Object. If multiple options given, this method returns the last one. Use Option.getObjectList(String) to get all values.
        Specified by:
        getObject in interface Option
        Returns:
      • getObjectList

        public List<Object> getObjectList​(String name)
        Description copied from interface: Option
        get list of all Object values for named option.
        Specified by:
        getObjectList in interface Option
        Returns:
      • getList

        public List<String> getList​(String name)
        Description copied from interface: Option
        get list of all values for named option.
        Specified by:
        getList in interface Option
        Returns:
        empty list if option not given and no default specified.
      • get

        public String get​(String name)
        Description copied from interface: Option
        get value of named option. If multiple options given, this method returns the last one. Use Option.getList(String) to get all values.
        Specified by:
        get in interface Option
        Returns:
      • getNumber

        public int getNumber​(String name)
        Description copied from interface: Option
        get value of named option as a Number.
        Specified by:
        getNumber in interface Option
        Returns:
      • argObjects

        public List<Object> argObjects()
        Description copied from interface: Option
        get remaining non-options args as Objects.
        Specified by:
        argObjects in interface Option
        Returns:
      • args

        public List<String> args()
        Description copied from interface: Option
        get remaining non-options args as Strings.
        Specified by:
        args in interface Option
        Returns:
      • usage

        public void usage()
        Description copied from interface: Option
        print usage message to System.err.
        Specified by:
        usage in interface Option
      • parse

        public Option parse​(Object[] argv)
        Description copied from interface: Option
        parse arguments.
        Specified by:
        parse in interface Option
      • parse

        public Option parse​(List<?> argv)
        Description copied from interface: Option
        parse arguments.
        Specified by:
        parse in interface Option
      • parse

        public Option parse​(Object[] argv,
                            boolean skipArg0)
        Description copied from interface: Option
        parse arguments.
        Specified by:
        parse in interface Option
      • parse

        public Option parse​(List<?> argv,
                            boolean skipArg0)
        Description copied from interface: Option
        parse arguments. If skipArgv0 is true, then parsing begins at arg1. This allows for commands where argv0 is the command name rather than a real argument.
        Specified by:
        parse in interface Option
        Returns: