com.github.misberner.apcommons.reporting

Interface Reporter

All Known Implementing Classes:

AbstractReporter, AnnotationReporter, ElementReporter, RootReporter, ValueReporter

public interface Reporter

An interface for easier reporting of diagnostic messages.

All reporting methods have an Object varargs parameter. The concrete message is built by concatenating the string representation of all elements of the respective Object array. Note that spaces are not inserted automatically to separate elements. For obtaining the string representation, String.valueOf(Object) is used, hence null values are allowed and have a String representation of "null".

Author:

Malte Isberner

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	warning(Object... msgObjects) Prints a warning message.

Method Detail

error

void error(Object... msgObjects)

Prints an error message.

Parameters:

msgObjects - the components of the message, see above

See Also:

Diagnostic.Kind#ERROR

warning

void warning(Object... msgObjects)

Prints a warning message.

Parameters:

msgObjects - the components of the message, see above

See Also:

Diagnostic.Kind#WARNING

mandatoryWarning

void mandatoryWarning(Object... msgObjects)

Prints a warning message that is mandated by a specification.

Parameters:

msgObjects - the components of the message, see above

See Also:

Diagnostic.Kind#MANDATORY_WARNING

note

void note(Object... msgObjects)

Prints an informational message.

Parameters:

msgObjects - the components of the message, see above

See Also:

Diagnostic.Kind#NOTE

other

void other(Object... msgObjects)

Prints some other type of message.

Parameters:

msgObjects - the components of the message, see above

See Also:

Diagnostic.Kind#OTHER

message

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

Prints a message of the specified diagnostic kind.

Parameters:

diagnosticKind - the diagnostic kind of the message

msgObjects - the components of the message, see above