net.sergeych.tools

Class Reporter

java.lang.Object

net.sergeych.tools.Reporter

public class Reporter
extends java.lang.Object

Tool to report messages, errors, progress notifications the same way in console applications, GUI applications and services. Create instance and call notice(String), progress(String) and error(String, String, String). Supports collecting and reporting collected data, setQuiet(boolean) mode, reportJson() and one level of verbisity: setVerboseMode(boolean).

Constructor Summary

Constructors

Constructor and Description
Reporter()

Method Summary

Modifier and Type	Method and Description
void	clear()
void	console(java.lang.String text) print to console only, does notthing ing queit mode.
void	error(java.lang.String code, java.lang.String object, java.lang.String text) Report error.
java.util.List<Binder>	getErrors()
java.lang.String	getMessage(int smartIndex)
boolean	isQuiet() See setQuiet(boolean)
boolean	isVerboseMode()
void	message(java.lang.String text) message will be shown immediately or buffered and returned later in json mode.
void	newLine() Outputs newline on the console only (does nothing in quiet more).
void	notice(java.lang.String text) Message to show in the console mode (non json mode).
void	progress(java.lang.String text)
Binder	report() Get collected report as a Binder object.
java.lang.String	reportJson() Get collected report as JSON string
void	setQuiet(boolean quiet) Set quiet mode: all information is only collected.
void	setVerboseMode(boolean verboseMode)
void	verbose(java.lang.String text)
void	warning(java.lang.String msg)

Methods inherited from class java.lang.Object

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

Constructor Detail

Reporter

public Reporter()

Method Detail

getErrors

public java.util.List<Binder> getErrors()

isQuiet

public boolean isQuiet()

See setQuiet(boolean)

Returns:

setQuiet

public void setQuiet(boolean quiet)

Set quiet mode: all information is only collected. To report it later at some poing, use report() or reportJson(). If the work is not finished, consider clear() before collecting more data.

By default, reporter collects data and print itout messages to the stdout.

Parameters:

quiet -

notice

public void notice(java.lang.String text)

Message to show in the console mode (non json mode). In json mode the message will be ignored.

Parameters:

text -

progress

public void progress(java.lang.String text)

verbose

public void verbose(java.lang.String text)

message

public void message(java.lang.String text)

message will be shown immediately or buffered and returned later in json mode.

Parameters:

text -

error

public void error(java.lang.String code,
                  java.lang.String object,
                  java.lang.String text)

Report error. Unless in JSON mode, will be printed immediately. Errors are 3-field objects with string fields "code", "object" and "text", which is usslay enough for most usages.

Parameters:

code -

object -

text -

warning

public void warning(java.lang.String msg)

report

public Binder report()

Get collected report as a Binder object.

Returns:

reportJson

public java.lang.String reportJson()

Get collected report as JSON string

Returns:

getMessage

public java.lang.String getMessage(int smartIndex)

clear

public void clear()

isVerboseMode

public boolean isVerboseMode()

setVerboseMode

public void setVerboseMode(boolean verboseMode)

newLine

public void newLine()

Outputs newline on the console only (does nothing in quiet more).

console

public void console(java.lang.String text)

print to console only, does notthing ing queit mode. To it to not to pollute json output with visual suff like newlines.

Parameters:

text -