org.apache.river.tool.envcheck

Class Reporter

java.lang.Object

org.apache.river.tool.envcheck.Reporter

public abstract class Reporter
extends Object

A class which provides a standard way to report the results of a test.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Reporter.Message A container of message information to be processed by Reporter.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR the level at which error messages are generated
static int	INFO the level at which information messages are generated
static int	WARNING the level at which warning messages are generated

Method Summary

Modifier and Type	Method and Description
static int	getErrorCount() Get the total number of error records that were generated.
static int	getWarningCount() Get the total number of warning records that were generated.
static void	print(Reporter.Message message) Generate the output for message .
static void	print(Reporter.Message message, String source) Generate the output for message.
static void	setExplanation(boolean explain) Set the explanation generation flag;
static void	setLevel(int level) Set the reporting level.
static void	setPrintTraces(boolean traces) Set the flag controlling printing of stack traces.

Methods inherited from class java.lang.Object

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

Field Detail

INFO

public static final int INFO

the level at which information messages are generated

See Also:

Constant Field Values

WARNING

public static final int WARNING

the level at which warning messages are generated

See Also:

Constant Field Values

ERROR

public static final int ERROR

the level at which error messages are generated

See Also:

Constant Field Values

Method Detail

setLevel

public static void setLevel(int level)

Set the reporting level. No validity checks are done.

Parameters:

level - the max level to generate output

setExplanation

public static void setExplanation(boolean explain)

Set the explanation generation flag;

Parameters:

explain - the value to set the flag to

setPrintTraces

public static void setPrintTraces(boolean traces)

Set the flag controlling printing of stack traces.

Parameters:

traces - if true, print stack traces

print

public static void print(Reporter.Message message)

Generate the output for message . This method is silent if the message level is less than reportLevel. If explain is true, the explanation text will be output only the first time it is encountered.

Parameters:

message - the Message to print

print

public static void print(Reporter.Message message,
                         String source)

Generate the output for message. This method is silent if the message level is less than Reporter.level. If Reporter.explain is true, the explanation text will be output only the first time it is encountered. If source is null, the source record is not output. If the message level is error or warning, the appropriate counter is updated.

Parameters:

message - the Message to print

source - additional information identifying the component under test

getWarningCount

public static int getWarningCount()

Get the total number of warning records that were generated.

Returns:

the warning count

getErrorCount

public static int getErrorCount()

Get the total number of error records that were generated.

Returns:

the error count