Package org.jline.builtins

Class Options

  • public class Options
extends java.lang.Object
    A GNU-style long options parser that is configured by parsing its usage string.

    This class provides a flexible command-line option parser that supports both short options (-a) and long options (--option), with or without arguments. The parser is configured by parsing a usage string that describes the available options and their arguments.

    Features include:

    • Support for both short (-a) and long (--option) options
    • Required and optional option arguments
    • Automatic generation of help text
    • Support for subcommands
    • Type conversion for option arguments

    Code originally from Apache Felix Gogo Shell, adapted for JLine.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Options.HelpException
      Exception thrown when using the --help option on a built-in command.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String NL  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.Object> argObjects()  
      java.util.List<java.lang.String> args()  
      static Options compile​(java.lang.String optSpec)  
      static Options compile​(java.lang.String[] optSpec)  
      static Options compile​(java.lang.String[] optSpec, java.lang.String[] gspec)  
      static Options compile​(java.lang.String[] optSpec, java.util.function.Function<java.lang.String,​java.lang.String> env)  
      static Options compile​(java.lang.String[] optSpec, Options gopt)  
      static Options compile​(java.lang.String optSpec, java.util.function.Function<java.lang.String,​java.lang.String> env)  
      java.lang.String get​(java.lang.String name)  
      java.util.List<java.lang.String> getList​(java.lang.String name)  
      int getNumber​(java.lang.String name)  
      java.lang.Object getObject​(java.lang.String name)  
      java.util.List<java.lang.Object> getObjectList​(java.lang.String name)  
      boolean isSet​(java.lang.String name)  
      Options parse​(java.lang.Object[] argv)  
      Options parse​(java.lang.Object[] argv, boolean skipArg0)  
      Options parse​(java.util.List<?> argv)  
      Options parse​(java.util.List<?> argv, boolean skipArg0)  
      Options setOptionsFirst​(boolean optionsFirst)  
      Options setStopOnBadOption​(boolean stopOnBadOption)  
      java.lang.String toString()  
      java.lang.String usage()  
      void usage​(java.io.PrintStream err)  
      java.lang.IllegalArgumentException usageError​(java.lang.String s)
      Prints usage message and returns IllegalArgumentException, for you to throw.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • NL

        public static final java.lang.String NL

    • Method Detail

      • compile

        public static Options compile​(java.lang.String[] optSpec)

      • compile

        public static Options compile​(java.lang.String[] optSpec,
                              java.util.function.Function<java.lang.String,​java.lang.String> env)

      • compile

        public static Options compile​(java.lang.String optSpec)

      • compile

        public static Options compile​(java.lang.String optSpec,
                              java.util.function.Function<java.lang.String,​java.lang.String> env)

      • compile

        public static Options compile​(java.lang.String[] optSpec,
                              Options gopt)

      • compile

        public static Options compile​(java.lang.String[] optSpec,
                              java.lang.String[] gspec)

      • setStopOnBadOption

        public Options setStopOnBadOption​(boolean stopOnBadOption)

      • setOptionsFirst

        public Options setOptionsFirst​(boolean optionsFirst)

      • isSet

        public boolean isSet​(java.lang.String name)

      • getObject

        public java.lang.Object getObject​(java.lang.String name)

      • getObjectList

        public java.util.List<java.lang.Object> getObjectList​(java.lang.String name)

      • getList

        public java.util.List<java.lang.String> getList​(java.lang.String name)

      • get

        public java.lang.String get​(java.lang.String name)

      • getNumber

        public int getNumber​(java.lang.String name)

      • argObjects

        public java.util.List<java.lang.Object> argObjects()

      • args

        public java.util.List<java.lang.String> args()

      • usage

        public void usage​(java.io.PrintStream err)

      • usage

        public java.lang.String usage()

      • usageError

        public java.lang.IllegalArgumentException usageError​(java.lang.String s)
        Prints usage message and returns IllegalArgumentException, for you to throw.
        Parameters:
        s - the message to display
        Returns:
        an exception with the generated message

      • parse

        public Options parse​(java.lang.Object[] argv)

      • parse

        public Options parse​(java.util.List<?> argv)

      • parse

        public Options parse​(java.lang.Object[] argv,
                     boolean skipArg0)

      • parse

        public Options parse​(java.util.List<?> argv,
                     boolean skipArg0)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object