org.springframework.xd.shell.util

Class UiUtils

java.lang.Object

org.springframework.xd.shell.util.UiUtils

public final class UiUtils
extends java.lang.Object

Contains utility methods for rendering data to a formatted console output. E.g. it provides helper methods for rendering ASCII-based data tables.

Since:

1.0

Author:

Gunnar Hillert, Thomas Risberg

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLUMN_1
static int	COLUMN_2
static int	COLUMN_3
static int	COLUMN_4
static int	COLUMN_5
static int	COLUMN_6
static java.lang.String	HORIZONTAL_LINE

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getHeaderBorder(java.util.Map<java.lang.Integer,TableHeader> headers) Renders the Table header border, based on the map of provided headers.
static java.lang.String	renderMapDataAsTable(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> data, java.util.List<java.lang.String> columns) Renders a textual representation of the list of provided Map data
static java.lang.String	renderParameterInfoDataAsTable(java.util.Map<java.lang.String,java.lang.String> parameters) Renders a textual representation of provided parameter map.
static java.lang.String	renderParameterInfoDataAsTable(java.util.Map<java.lang.String,java.lang.String> parameters, boolean withHeader, int lastColumnMaxWidth)
static java.lang.String	renderTextTable(Table table)
static java.lang.String	renderTextTable(Table table, boolean withHeader) Renders a textual representation of the provided Table

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HORIZONTAL_LINE

public static final java.lang.String HORIZONTAL_LINE

See Also:

Constant Field Values

COLUMN_1

public static final int COLUMN_1

See Also:

Constant Field Values

COLUMN_2

public static final int COLUMN_2

See Also:

Constant Field Values

COLUMN_3

public static final int COLUMN_3

See Also:

Constant Field Values

COLUMN_4

public static final int COLUMN_4

See Also:

Constant Field Values

COLUMN_5

public static final int COLUMN_5

See Also:

Constant Field Values

COLUMN_6

public static final int COLUMN_6

See Also:

Constant Field Values

Method Detail

renderMapDataAsTable

public static java.lang.String renderMapDataAsTable(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> data,
                                    java.util.List<java.lang.String> columns)

Renders a textual representation of the list of provided Map data

Parameters:

columns - List of Maps

Returns:

The rendered table representation as String

renderParameterInfoDataAsTable

public static java.lang.String renderParameterInfoDataAsTable(java.util.Map<java.lang.String,java.lang.String> parameters,
                                              boolean withHeader,
                                              int lastColumnMaxWidth)

renderParameterInfoDataAsTable

public static java.lang.String renderParameterInfoDataAsTable(java.util.Map<java.lang.String,java.lang.String> parameters)

Renders a textual representation of provided parameter map.

Parameters:

parameters - Map of parameters (key, value)

Returns:

The rendered table representation as String

renderTextTable

public static java.lang.String renderTextTable(Table table)

renderTextTable

public static java.lang.String renderTextTable(Table table,
                               boolean withHeader)

Renders a textual representation of the provided Table

Parameters:

table - Table data Table

Returns:

The rendered table representation as String

getHeaderBorder

public static java.lang.String getHeaderBorder(java.util.Map<java.lang.Integer,TableHeader> headers)

Renders the Table header border, based on the map of provided headers.

Parameters:

headers - Map of headers containing meta information e.g. name+width of header

Returns:

Returns the rendered header border as String