com.github.misberner.apcommons.reporting

Class AbstractReporter

java.lang.Object

com.github.misberner.apcommons.reporting.AbstractReporter

All Implemented Interfaces:

Reporter

Direct Known Subclasses:

RootReporter

public abstract class AbstractReporter
extends Object
implements Reporter

Constructor Summary

Constructors

Constructor and Description
AbstractReporter()

Method Summary

Methods

Modifier and Type	Method and Description
protected CharSequence	assembleMessage(Object... msgObjects) Concatenates the string representations of the given objects.
void	error(Object... msgObjects) Prints an error message.
void	mandatoryWarning(Object... msgObjects) Prints a warning message that is mandated by a specification.
void	message(Diagnostic.Kind diagnosticKind, Object... msgObjects) Prints a message of the specified diagnostic kind.
void	note(Object... msgObjects) Prints an informational message.
void	other(Object... msgObjects) Prints some other type of message.
protected abstract void	printMessage(Diagnostic.Kind kind, CharSequence message) Actually print a message of the given diagnostic kind.
void	warning(Object... msgObjects) Prints a warning message.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractReporter

public AbstractReporter()

Method Detail

error

public void error(Object... msgObjects)

Description copied from interface: Reporter

Prints an error message.

Specified by:

error in interface Reporter

Parameters:

msgObjects - the components of the message, see above

See Also:

Diagnostic.Kind#ERROR

warning

public void warning(Object... msgObjects)

Description copied from interface: Reporter

Prints a warning message.

Specified by:

warning in interface Reporter

Parameters:

msgObjects - the components of the message, see above

See Also:

Diagnostic.Kind#WARNING

mandatoryWarning

public void mandatoryWarning(Object... msgObjects)

Description copied from interface: Reporter

Prints a warning message that is mandated by a specification.

Specified by:

mandatoryWarning in interface Reporter

Parameters:

msgObjects - the components of the message, see above

See Also:

Diagnostic.Kind#MANDATORY_WARNING

note

public void note(Object... msgObjects)

Description copied from interface: Reporter

Prints an informational message.

Specified by:

note in interface Reporter

Parameters:

msgObjects - the components of the message, see above

See Also:

Diagnostic.Kind#NOTE

other

public void other(Object... msgObjects)

Description copied from interface: Reporter

Prints some other type of message.

Specified by:

other in interface Reporter

Parameters:

msgObjects - the components of the message, see above

See Also:

Diagnostic.Kind#OTHER

message

public void message(Diagnostic.Kind diagnosticKind,
           Object... msgObjects)

Description copied from interface: Reporter

Prints a message of the specified diagnostic kind.

Specified by:

message in interface Reporter

Parameters:

diagnosticKind - the diagnostic kind of the message

msgObjects - the components of the message, see above

assembleMessage

protected CharSequence assembleMessage(Object... msgObjects)

Concatenates the string representations of the given objects.

Parameters:

msgObjects - the objects to display

Returns:

the concatenation of the object's string representations.

printMessage

protected abstract void printMessage(Diagnostic.Kind kind,
                CharSequence message)

Actually print a message of the given diagnostic kind.

Parameters:

kind - the diagnostic kind

message - the message to print