Package org.jline.builtins

Class Options.HelpException

  • All Implemented Interfaces:
    java.io.Serializable
    Enclosing class:
    Options
    public static class Options.HelpException
extends java.lang.Exception
    Exception thrown when using the --help option on a built-in command. It can be highlighted using the highlight(String, StyleResolver) method and then printed to the Terminal.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      HelpException​(java.lang.String message)  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static org.jline.utils.StyleResolver defaultStyle()  
      static org.jline.utils.AttributedString highlight​(java.lang.String msg, org.jline.utils.StyleResolver resolver)  
      static org.jline.utils.AttributedString highlightComment​(java.lang.String comment, org.jline.utils.StyleResolver resolver)  
      static org.jline.utils.AttributedString highlightSyntax​(java.lang.String syntax, org.jline.utils.StyleResolver resolver)  
      static org.jline.utils.AttributedString highlightSyntax​(java.lang.String syntax, org.jline.utils.StyleResolver resolver, boolean subcommands)  

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HelpException

        public HelpException​(java.lang.String message)

    • Method Detail

      • defaultStyle

        public static org.jline.utils.StyleResolver defaultStyle()

      • highlight

        public static org.jline.utils.AttributedString highlight​(java.lang.String msg,
                                                         org.jline.utils.StyleResolver resolver)

      • highlightSyntax

        public static org.jline.utils.AttributedString highlightSyntax​(java.lang.String syntax,
                                                               org.jline.utils.StyleResolver resolver,
                                                               boolean subcommands)

      • highlightSyntax

        public static org.jline.utils.AttributedString highlightSyntax​(java.lang.String syntax,
                                                               org.jline.utils.StyleResolver resolver)

      • highlightComment

        public static org.jline.utils.AttributedString highlightComment​(java.lang.String comment,
                                                                org.jline.utils.StyleResolver resolver)