Package org.jline.builtins

Class Options.HelpException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.jline.builtins.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

Modifier and Type	Method	Description
static StyleResolver	defaultStyle()
static AttributedString	highlight(java.lang.String msg, StyleResolver resolver)
static AttributedString	highlightComment(java.lang.String comment, StyleResolver resolver)
static AttributedString	highlightSyntax(java.lang.String syntax, StyleResolver resolver)
static AttributedString	highlightSyntax(java.lang.String syntax, 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 StyleResolver defaultStyle()

highlight

public static AttributedString highlight(java.lang.String msg,
                                         StyleResolver resolver)

highlightSyntax

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

highlightSyntax

public static AttributedString highlightSyntax(java.lang.String syntax,
                                               StyleResolver resolver)

highlightComment

public static AttributedString highlightComment(java.lang.String comment,
                                                StyleResolver resolver)