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

public class DefaultPrinter
extends JlineCommandRegistry
implements 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

Fields

Modifier and Type	Field	Description
protected static final int	PRNT_INDENTION
protected static final int	PRNT_MAX_DEPTH
protected static final int	PRNT_MAX_ROWS
protected static final String	VAR_PRNT_OPTIONS

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

Constructors

Constructor	Description
DefaultPrinter(ConfigurationPath configPath)
DefaultPrinter(ScriptEngine engine, ConfigurationPath configPath)

Method Summary

Modifier and Type	Method	Description
String[]	appendUsage(String[] customUsage)
Map<String,Object>	compileOptions(Options opt)
protected Map<String,Object>	defaultPrntOptions(boolean skipDefault)	Set default and mandatory printing options.
protected void	highlightAndPrint(Map<String,Object> options, Throwable exception)	Highlight and print an exception
protected void	manageBooleanOptions(Map<String,Object> options)	Boolean printing options Printer checks only if key is present.
void	println(Object object)
void	println(Map<String,Object> optionsIn, Object object)
Exception	prntCommand(CommandInput input)
boolean	refresh()	Clear printer syntax highlighter cache
void	setHighlightValue(Map<String,Function<Object,AttributedString>> highlightValue)	Highlight column value
void	setObjectToMap(Map<Class<?>,Function<Object,Map<String,Object>>> objectToMap)	Override ScriptEngine toMap() method
void	setObjectToString(Map<Class<?>,Function<Object,String>> objectToString)	Override ScriptEngine toString() method
protected 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

protected static final String VAR_PRNT_OPTIONS

See Also:

• Constant Field Values

PRNT_MAX_ROWS

protected static final int PRNT_MAX_ROWS

See Also:

• Constant Field Values

PRNT_MAX_DEPTH

protected static final int PRNT_MAX_DEPTH

See Also:

• Constant Field Values

PRNT_INDENTION

protected static final int PRNT_INDENTION

See Also:

• Constant Field Values

Constructor Details

DefaultPrinter

public DefaultPrinter(ConfigurationPath configPath)

DefaultPrinter

public DefaultPrinter(ScriptEngine engine,
 ConfigurationPath configPath)

Method Details

println

public void println(Object object)

Specified by:

println in interface Printer

println

public void println(Map<String,Object> optionsIn,
 Object object)

Specified by:

println in interface Printer

refresh

public boolean refresh()

Description copied from interface: Printer

Clear printer syntax highlighter cache

Specified by:

refresh in interface Printer

appendUsage

public String[] appendUsage(String[] customUsage)

compileOptions

public Map<String,Object> compileOptions(Options opt)

prntCommand

public Exception prntCommand(CommandInput input)

Specified by:

prntCommand in interface Printer

setObjectToMap

public void setObjectToMap(Map<Class<?>,Function<Object,Map<String,Object>>> objectToMap)

Override ScriptEngine toMap() method

Parameters:

objectToMap - key: object class, value: toMap function

setObjectToString

public void setObjectToString(Map<Class<?>,Function<Object,String>> objectToString)

Override ScriptEngine toString() method

Parameters:

objectToString - key: object class, value: toString function

setHighlightValue

public void setHighlightValue(Map<String,Function<Object,AttributedString>> highlightValue)

Highlight column value

Parameters:

highlightValue - key: regex for column name, value: highlight function

terminal

protected Terminal terminal()

Returns:

terminal to which will be printed

manageBooleanOptions

protected void manageBooleanOptions(Map<String,Object> options)

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

protected Map<String,Object> defaultPrntOptions(boolean skipDefault)

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

protected void highlightAndPrint(Map<String,Object> options,
 Throwable exception)

Highlight and print an exception

Parameters:

options - Printing options

exception - Exception to be printed