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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	DefaultPrinter.BadOptionValueException
private static class	DefaultPrinter.TruncatedOutputException

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
private final ConfigurationPath	configPath
private final ScriptEngine	engine
private static final int	HIGHLIGHTER_CACHE_SIZE
private final LinkedHashMap<String,SyntaxHighlighter>	highlighters
private Map<String,Function<Object,AttributedString>>	highlightValue
private static final int	NANORC_MAX_STRING_LENGTH
private Map<Class<?>,Function<Object,Map<String,Object>>>	objectToMap
private Map<Class<?>,Function<Object,String>>	objectToString
protected static final int	PRNT_INDENTION
protected static final int	PRNT_MAX_DEPTH
protected static final int	PRNT_MAX_ROWS
private StyleResolver	prntStyle
private int	totLines
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
private String	addPadding(String str, int width)
private AttributedString	addPadding(AttributedString str, int width)
String[]	appendUsage(String[] customUsage)
private boolean	canConvert(Object obj)
private int	cellWidth(int pos, List<Integer> columns, boolean rownum, String columnSep)
private boolean	collectionObject(Object obj)
private String	columnName(String name, boolean shortName)
private String	columnValue(String value)
Map<String,Object>	compileOptions(Options opt)
protected Map<String,Object>	defaultPrntOptions(boolean skipDefault)	Set default and mandatory printing options.
private int	digits(int number)
private boolean	doRowHighlight(int row, Printer.TableRows tableRows)
private boolean	doValueHighlight(Map<String,Object> options, String value)
private boolean	hasMatch(List<String> regexes, String value)
private AttributedString	highlight(Integer width, SyntaxHighlighter highlighter, String object, boolean doValueHighlight)
private AttributedString	highlight(CmdDesc cmdDesc)
private void	highlightAndPrint(int width, SyntaxHighlighter highlighter, String object, boolean doValueHighlight)
private void	highlightAndPrint(Map<String,Object> options, Object obj)
protected void	highlightAndPrint(Map<String,Object> options, Throwable exception)	Highlight and print an exception
private void	highlightList(Map<String,Object> options, List<Object> collection, int width)
private void	highlightList(Map<String,Object> options, List<Object> collection, int width, int depth)
private void	highlightMap(Map<String,Object> options, Map<String,Object> map, int width)
private void	highlightMap(Map<String,Object> options, Map<String,Object> map, int width, int depth)
private AttributedString	highlightMapValue(Map<String,Object> options, String key, Map<String,Object> map)
private AttributedString	highlightValue(Map<String,Object> options, String column, Object obj)
private void	internalPrintln(Map<String,Object> options, Object object)
private boolean	isHighlighted(AttributedString value)
private boolean	isNumber(String str)
private Map<String,Object>	keysToString(Map<Object,Object> map)
protected void	manageBooleanOptions(Map<String,Object> options)	Boolean printing options Printer checks only if key is present.
private Object	mapValue(Map<String,Object> options, String key, Map<String,Object> map)
private List<Object>	objectToList(Object obj)
private Map<String,Object>	objectToMap(Map<String,Object> options, Object obj)
private String	objectToString(Map<String,Object> options, Object obj)
private List<String>	optionList(String key, Map<String,Object> options)
private Printer.TableRows	optionRowHighlight(Object value)
void	println(Object object)
void	println(Map<String,Object> optionsIn, Object object)
private void	println(AttributedString line, int maxrows)
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
private boolean	similarSets(List<String> ref, Set<String> c2, int matchLimit)
private boolean	simpleObject(Object obj)
protected Terminal	terminal()
private void	toTabStops(List<Integer> columns, int rows, boolean rownum, String columnSep)
private String	truncate4nanorc(String obj)
private String	truncateValue(int maxWidth, String value)
private AttributedString	truncateValue(Map<String,Object> options, AttributedString value)
private SyntaxHighlighter	valueHighlighter(String style)

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

NANORC_MAX_STRING_LENGTH

private static final int NANORC_MAX_STRING_LENGTH

See Also:

• Constant Field Values

HIGHLIGHTER_CACHE_SIZE

private static final int HIGHLIGHTER_CACHE_SIZE

See Also:

• Constant Field Values

objectToMap

private Map<Class<?>,Function<Object,Map<String,Object>>> objectToMap

objectToString

private Map<Class<?>,Function<Object,String>> objectToString

highlightValue

private Map<String,Function<Object,AttributedString>> highlightValue

totLines

private int totLines

engine

private final ScriptEngine engine

configPath

private final ConfigurationPath configPath

prntStyle

private StyleResolver prntStyle

highlighters

private final LinkedHashMap<String,SyntaxHighlighter> highlighters

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)

optionRowHighlight

private Printer.TableRows optionRowHighlight(Object value)

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

internalPrintln

private void internalPrintln(Map<String,Object> options,
 Object object)

highlightAndPrint

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

Highlight and print an exception

Parameters:

options - Printing options

exception - Exception to be printed

highlight

private AttributedString highlight(CmdDesc cmdDesc)

valueHighlighter

private SyntaxHighlighter valueHighlighter(String style)

truncate4nanorc

private String truncate4nanorc(String obj)

highlight

private AttributedString highlight(Integer width,
 SyntaxHighlighter highlighter,
 String object,
 boolean doValueHighlight)

doValueHighlight

private boolean doValueHighlight(Map<String,Object> options,
 String value)

highlightAndPrint

private void highlightAndPrint(int width,
 SyntaxHighlighter highlighter,
 String object,
 boolean doValueHighlight)

keysToString

private Map<String,Object> keysToString(Map<Object,Object> map)

mapValue

private Object mapValue(Map<String,Object> options,
 String key,
 Map<String,Object> map)

optionList

private List<String> optionList(String key,
 Map<String,Object> options)

hasMatch

private boolean hasMatch(List<String> regexes,
 String value)

addPadding

private AttributedString addPadding(AttributedString str,
 int width)

addPadding

private String addPadding(String str,
 int width)

columnValue

private String columnValue(String value)

objectToMap

private Map<String,Object> objectToMap(Map<String,Object> options,
 Object obj)

objectToString

private String objectToString(Map<String,Object> options,
 Object obj)

highlightMapValue

private AttributedString highlightMapValue(Map<String,Object> options,
 String key,
 Map<String,Object> map)

isHighlighted

private boolean isHighlighted(AttributedString value)

highlightValue

private AttributedString highlightValue(Map<String,Object> options,
 String column,
 Object obj)

truncateValue

private AttributedString truncateValue(Map<String,Object> options,
 AttributedString value)

truncateValue

private String truncateValue(int maxWidth,
 String value)

objectToList

private List<Object> objectToList(Object obj)

similarSets

private boolean similarSets(List<String> ref,
 Set<String> c2,
 int matchLimit)

println

private void println(AttributedString line,
 int maxrows)

columnName

private String columnName(String name,
 boolean shortName)

isNumber

private boolean isNumber(String str)

highlightAndPrint

private void highlightAndPrint(Map<String,Object> options,
 Object obj)

doRowHighlight

private boolean doRowHighlight(int row,
 Printer.TableRows tableRows)

highlightList

private void highlightList(Map<String,Object> options,
 List<Object> collection,
 int width)

highlightList

private void highlightList(Map<String,Object> options,
 List<Object> collection,
 int width,
 int depth)

collectionObject

private boolean collectionObject(Object obj)

simpleObject

private boolean simpleObject(Object obj)

canConvert

private boolean canConvert(Object obj)

digits

private int digits(int number)

cellWidth

private int cellWidth(int pos,
 List<Integer> columns,
 boolean rownum,
 String columnSep)

toTabStops

private void toTabStops(List<Integer> columns,
 int rows,
 boolean rownum,
 String columnSep)

highlightMap

private void highlightMap(Map<String,Object> options,
 Map<String,Object> map,
 int width)

highlightMap

private void highlightMap(Map<String,Object> options,
 Map<String,Object> map,
 int width,
 int depth)