org.apache.river.tool.envcheck

Class Reporter.Message

java.lang.Object

org.apache.river.tool.envcheck.Reporter.Message

Enclosing class:

Reporter

public static class Reporter.Message
extends Object

A container of message information to be processed by Reporter.

Constructor Summary

Constructors

Constructor and Description
Message(int level, String message, String explanation) Construct a Message having the given level and text.
Message(int level, String message, Throwable thrownException, String explanation) Construct a Message having the given level, text, and exception data.

Method Summary

Modifier and Type	Method and Description
protected boolean	formatExplanation() Returns the flag indicating whether to format the explanation text.
protected String	getExplanation() Returns the explanation text.
protected int	getLevel() Returns the message level.
protected String	getMessage() Returns the short message text.
protected void	printStackTrace() Prints a stack trace for the exception associated with this message.
protected void	setFormatExplanation(boolean b) Set the flag indicating whether to format the explanation text.

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message(int level,
               String message,
               String explanation)

Construct a Message having the given level and text.

Parameters:

level - the message level

message - the short message text

explanation - the explanation text

Message

public Message(int level,
               String message,
               Throwable thrownException,
               String explanation)

Construct a Message having the given level, text, and exception data.

Parameters:

level - the message level

message - the short message text

thrownException - the exception associated with the message

explanation - the explanation text

Method Detail

getLevel

protected int getLevel()

Returns the message level.

Returns:

the level

getMessage

protected String getMessage()

Returns the short message text. If a non-null exception is associated with this message, the exception message is appended to the short message.

Returns:

the short message

getExplanation

protected String getExplanation()

Returns the explanation text.

Returns:

the explanation text

printStackTrace

protected void printStackTrace()

Prints a stack trace for the exception associated with this message. If there is no such exception this method returns silently.

setFormatExplanation

protected void setFormatExplanation(boolean b)

Set the flag indicating whether to format the explanation text.

Parameters:

b - if true, format the text

formatExplanation

protected boolean formatExplanation()

Returns the flag indicating whether to format the explanation text.

Returns:

true if the text is to be formatted.