Package org.jline.console.impl
Class DefaultPrinter
java.lang.Object
org.jline.console.impl.AbstractCommandRegistry
org.jline.console.impl.JlineCommandRegistry
org.jline.console.impl.DefaultPrinter
- All Implemented Interfaces:
CommandRegistry
,Printer
Print highlighted objects to console.
- Author:
- Matti Rinta-Nikkola
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.jline.console.CommandRegistry
CommandRegistry.CommandSession
Nested classes/interfaces inherited from interface org.jline.console.Printer
Printer.TableRows
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final int
protected static final int
protected static final int
protected static final String
Fields inherited from interface org.jline.console.Printer
ALL, BOOLEAN_KEYS, BORDER, COLUMNS, COLUMNS_IN, COLUMNS_OUT, EXCLUDE, HIGHLIGHT_VALUE, INCLUDE, INDENTION, MAP_SIMILARITY, MAX_COLUMN_WIDTH, MAX_DEPTH, MAXROWS, MULTI_COLUMNS, OBJECT_TO_MAP, OBJECT_TO_STRING, ONE_ROW_TABLE, ROW_HIGHLIGHT, ROWNUM, SHORT_NAMES, SKIP_DEFAULT_OPTIONS, STRUCT_ON_TABLE, STYLE, TO_STRING, VALUE_STYLE, VALUE_STYLE_ALL, WIDTH
-
Constructor Summary
ConstructorDescriptionDefaultPrinter
(ConfigurationPath configPath) DefaultPrinter
(ScriptEngine engine, ConfigurationPath configPath) -
Method Summary
Modifier and TypeMethodDescriptionString[]
appendUsage
(String[] customUsage) compileOptions
(Options opt) defaultPrntOptions
(boolean skipDefault) Set default and mandatory printing options.protected void
highlightAndPrint
(Map<String, Object> options, Throwable exception) Highlight and print an exceptionprotected void
manageBooleanOptions
(Map<String, Object> options) Boolean printing options Printer checks only if key is present.void
void
prntCommand
(CommandInput input) boolean
refresh()
Clear printer syntax highlighter cachevoid
setHighlightValue
(Map<String, Function<Object, AttributedString>> highlightValue) Highlight column valuevoid
Override ScriptEngine toMap() methodvoid
Override ScriptEngine toString() methodprotected Terminal
terminal()
Methods inherited from class org.jline.console.impl.JlineCommandRegistry
commandDescription, commandInfo, commandOptions, compileCommandDescription, compileCommandInfo, compileCommandOptions, defaultCompleter, parseOptions
Methods inherited from class org.jline.console.impl.AbstractCommandRegistry
alias, commandAliases, commandNames, compileCompleters, doHelpDesc, getCommandMethods, hasCommand, invoke, registerCommands, registerCommands, registeredCommand, rename, saveException
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.jline.console.CommandRegistry
name
-
Field Details
-
VAR_PRNT_OPTIONS
- See Also:
-
PRNT_MAX_ROWS
protected static final int PRNT_MAX_ROWS- See Also:
-
PRNT_MAX_DEPTH
protected static final int PRNT_MAX_DEPTH- See Also:
-
PRNT_INDENTION
protected static final int PRNT_INDENTION- See Also:
-
-
Constructor Details
-
DefaultPrinter
-
DefaultPrinter
-
-
Method Details
-
println
-
println
-
refresh
public boolean refresh()Description copied from interface:Printer
Clear printer syntax highlighter cache -
appendUsage
-
compileOptions
-
prntCommand
- Specified by:
prntCommand
in interfacePrinter
-
setObjectToMap
Override ScriptEngine toMap() method- Parameters:
objectToMap
- key: object class, value: toMap function
-
setObjectToString
Override ScriptEngine toString() method- Parameters:
objectToString
- key: object class, value: toString function
-
setHighlightValue
Highlight column value- Parameters:
highlightValue
- key: regex for column name, value: highlight function
-
terminal
- Returns:
- terminal to which will be printed
-
manageBooleanOptions
Boolean printing options Printer checks only if key is present. Boolean options that have false value are removed from the options Map.- Parameters:
options
- printing options
-
defaultPrntOptions
Set default and mandatory printing options. Also unsupported options will be removed when Printer is used without scriptEngine- Parameters:
skipDefault
- when true does not set default options- Returns:
- default, mandatory and supported options
-
highlightAndPrint
Highlight and print an exception- Parameters:
options
- Printing optionsexception
- Exception to be printed
-