org.perfcake.reporting.destination

Class ConsoleDestination

java.lang.Object

org.perfcake.reporting.destination.AbstractDestination

org.perfcake.reporting.destination.ConsoleDestination

All Implemented Interfaces:

Closeable, AutoCloseable, Destination

public class ConsoleDestination
extends AbstractDestination

Appends a Measurement to standard output.

Author:

Pavel Macík, Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
ConsoleDestination()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the destination.
String	getBackground() Gets the background color code.
String	getForeground() Gets the foreground color code.
String	getPrefix() Gets the prefix of the console output.
void	open() Opens the destination for reporting.
void	report(Measurement measurement) Reports a new Measurement to the destination.
ConsoleDestination	setBackground(String background) Sets the background color code.
ConsoleDestination	setForeground(String foreground) Sets the foreground color code.
ConsoleDestination	setPrefix(String prefix) Sets the prefix of the console output.

Methods inherited from class org.perfcake.reporting.destination.AbstractDestination

getParentReporter, open

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleDestination

public ConsoleDestination()

Method Detail

open

public void open()

Description copied from class: AbstractDestination

Opens the destination for reporting.

Specified by:

open in class AbstractDestination

close

public void close()

Description copied from interface: Destination

Closes the destination. No other value should be reported after that.

report

public void report(Measurement measurement)
            throws ReportingException

Description copied from interface: Destination

Reports a new Measurement to the destination.

Parameters:

measurement - A measurement to be reported.

Throws:

ReportingException - When an error occurred during reporting the measurement like no space left on device. The root cause should be encapsulated.

getForeground

public String getForeground()

Gets the foreground color code.

Returns:

The foreground color code.

setForeground

public ConsoleDestination setForeground(String foreground)

Sets the foreground color code. Can be an empty string to turn this feature off, or a single number 0-15 (0 - 7 for basic colors, 8 - 15 for brighter/bold colors).

Parameters:

foreground - The foreground color code.

Returns:

Instance of this to support fluent API.

getBackground

public String getBackground()

Gets the background color code.

Returns:

The background color code.

setBackground

public ConsoleDestination setBackground(String background)

Sets the background color code. Can be an empty string to turn this feature off, or a single number 0-7.

Parameters:

background - The background color code.

Returns:

Instance of this to support fluent API.

getPrefix

public String getPrefix()

Gets the prefix of the console output.

Returns:

The prefix of the console output.

setPrefix

public ConsoleDestination setPrefix(String prefix)

Sets the prefix of the console output.

Parameters:

prefix - The prefix of the console output.

Returns:

Instance of this to support fluent API.