com.github.punch.api.printer

Class PunchPrinter

java.lang.Object

com.github.punch.api.printer.PunchPrinter

public class PunchPrinter
extends Object

This class is a console printer helper:

 
 <leftMessage>...................................<rightMessage>
 <subMessage>
 <subPrinter[0].leftMessage>.................<subPrinter[0].rightMessage>
 <subPrinter[0].subMessage>
 <subPrinter[1].leftMessage>.................<subPrinter[1].rightMessage>
 <subPrinter[1].subMessage>
 
 

Author:

david, cedric

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PunchPrinter.Color Ansi color code

Constructor Summary

Constructors

Constructor and Description
PunchPrinter() Constructor

Method Summary

Modifier and Type	Method and Description
PunchPrinter	addSubPrinter(PunchPrinter printer) Add a sub printer.
static PunchPrinter	create() Instance provider
void	print() Print this printer with 0 offset and colors and sub printers
void	print(boolean noCol) Print this printer with 0 offset and sub printers
void	print(int offset) Print this printer with colors and sub printers
void	print(int offset, boolean noCol) Print this printer and sub printers
void	print(int offset, boolean noCol, boolean detail) Print this printer to stdout (or stderr if errorOutput was set to true)
static void	printException(int offset, Exception e) Default printing for exception
PunchPrinter	setErrorOutput(boolean isAnErrorOrWarning)
PunchPrinter	setLeftColor(PunchPrinter.Color leftColor) Set left message color
PunchPrinter	setLeftMessage(String leftMessage) Set left message
PunchPrinter	setRightColor(PunchPrinter.Color rightColor) Set right message color
PunchPrinter	setRightMessage(String rightMessage) Set right message
PunchPrinter	setSubMessage(String subMessage) Set sub message
PunchPrinter	setSubMessageColor(PunchPrinter.Color subMessageColor) Set sub message color

Methods inherited from class java.lang.Object

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

Constructor Detail

PunchPrinter

public PunchPrinter()

Constructor

Method Detail

create

public static PunchPrinter create()

Instance provider

Returns:

a Printer instance

setLeftMessage

public PunchPrinter setLeftMessage(String leftMessage)

Set left message

Parameters:

leftMessage - left message

Returns:

this printer

setLeftColor

public PunchPrinter setLeftColor(PunchPrinter.Color leftColor)

Set left message color

Parameters:

leftColor - left color

Returns:

this printer

setRightMessage

public PunchPrinter setRightMessage(String rightMessage)

Set right message

Parameters:

rightMessage - right message

Returns:

this printer

setErrorOutput

public PunchPrinter setErrorOutput(boolean isAnErrorOrWarning)

setRightColor

public PunchPrinter setRightColor(PunchPrinter.Color rightColor)

Set right message color

Parameters:

rightColor - right color

Returns:

this printer

setSubMessage

public PunchPrinter setSubMessage(String subMessage)

Set sub message

Parameters:

subMessage - sub message

Returns:

this printer

setSubMessageColor

public PunchPrinter setSubMessageColor(PunchPrinter.Color subMessageColor)

Set sub message color

Parameters:

subMessageColor - sub message

Returns:

this printer

addSubPrinter

public PunchPrinter addSubPrinter(PunchPrinter printer)

Add a sub printer.

Parameters:

printer - a printer

Returns:

this printer

print

public void print(int offset,
                  boolean noCol,
                  boolean detail)

Print this printer to stdout (or stderr if errorOutput was set to true)

Parameters:

offset - print offset

noCol - no output color if true

detail - print details

print

public void print(boolean noCol)

Print this printer with 0 offset and sub printers

Parameters:

noCol - no output color if true

print

public void print()

Print this printer with 0 offset and colors and sub printers

print

public void print(int offset,
                  boolean noCol)

Print this printer and sub printers

Parameters:

offset - print offset

noCol - no output color if true

print

public void print(int offset)

Print this printer with colors and sub printers

Parameters:

offset - print offset

printException

public static void printException(int offset,
                                  Exception e)

Default printing for exception

Parameters:

offset - number of char to shift

e - Excpetion to print