org.thales.punch.platform.api

Interface IConsolePrinter

public interface IConsolePrinter

Whenever a pojo must be printed out the the terminal, it can rely on these methods to produce a colored and rightly aligned information.

Author:

dimi

Method Summary

Modifier and Type	Method and Description
String	getColoredError(String error)
String	getColoredKey(String key)
String	getColoredValue(String value) Some values are special : ACTIVE STOPPED VALID RED etc ..
String	getColoredWarning(String warning)
void	print(IPrinterPojo pojo) print a pojo
void	print(List<IPrinterPojo> pojos) Print a list of pojos.
void	println(String... input) Simply print out the strings
void	printWithPadding(String left, String right) Print with padding.
String	right()

Method Detail

right

String right()

Returns:

a four character white space

getColoredKey

String getColoredKey(String key)

Parameters:

key - a key for some value

Returns:

a coloured key

getColoredWarning

String getColoredWarning(String warning)

Parameters:

warning - an input string

Returns:

a coloured (yellow) string

getColoredError

String getColoredError(String error)

Parameters:

error - an input string

Returns:

a coloured (red) string

getColoredValue

String getColoredValue(String value)

Some values are special : ACTIVE STOPPED VALID RED etc .. This method returns it using the adequate color.

Parameters:

value - an input string that is known to the punch.

Returns:

a coloured (green yello or red) string

print

void print(List<IPrinterPojo> pojos)

Print a list of pojos.

Parameters:

pojos -

print

void print(IPrinterPojo pojo)

print a pojo

Parameters:

pojo -

printWithPadding

void printWithPadding(String left,
                      String right)

Print with padding. That produce : left .... right.

Parameters:

left -

right -

println

void println(String... input)

Simply print out the strings

Parameters:

input -