org.jline.builtins

Class Options.HelpException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.jline.builtins.Options.HelpException

All Implemented Interfaces:

Serializable

Enclosing class:

Options

public static class Options.HelpException
extends 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

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_COLORS

Constructor Summary

Constructors

Constructor and Description
HelpException(String message)

Method Summary

Modifier and Type	Method and Description
static org.jline.utils.StyleResolver	defaultStyle()
static org.jline.utils.AttributedString	highlight(String msg, org.jline.utils.StyleResolver resolver)
static org.jline.utils.AttributedString	highlightComment(String comment, org.jline.utils.StyleResolver resolver)
static org.jline.utils.AttributedString	highlightSyntax(String syntax, org.jline.utils.StyleResolver resolver)
static org.jline.utils.AttributedString	highlightSyntax(String syntax, org.jline.utils.StyleResolver resolver, boolean subcommands)
static org.jline.utils.StyleResolver	style(String str)

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

Field Detail

DEFAULT_COLORS

public static final String DEFAULT_COLORS

See Also:

Constant Field Values

Constructor Detail

HelpException

public HelpException(String message)

Method Detail

defaultStyle

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

style

public static org.jline.utils.StyleResolver style(String str)

highlight

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

highlightSyntax

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

highlightSyntax

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

highlightComment

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