Package net.sourceforge.pmd.util.log

Interface MessageReporter

@InternalApi
public interface MessageReporter

Façade to report user-facing messages (info, warning and error). Note: messages are formatted using MessageFormat.

Internal API: this is a transitional API that will be significantly changed in PMD 7, with the transition to SLF4J. See https://github.com/pmd/pmd/issues/3816

Author:

Clément Fournier

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MessageReporter.Level	Deprecated. Will be replaced with SLF4J Level in PMD 7

Method Summary

Modifier and Type	Method	Description
void	error(String message, Object... formatArgs)
void	errorEx(String message, Object[] formatArgs, Throwable error)
void	errorEx(String message, Throwable error)
void	info(String message, Object... formatArgs)
boolean	isLoggable(MessageReporter.Level level)
void	log(MessageReporter.Level level, String message, Object... formatArgs)
void	logEx(MessageReporter.Level level, String message, Object[] formatArgs, Throwable error)
int	numErrors()	Returns the number of errors reported on this instance.
void	trace(String message, Object... formatArgs)	Deprecated. Trace messages should be reported on a Logger instance.
void	warn(String message, Object... formatArgs)
void	warnEx(String message, Object[] formatArgs, Throwable error)
void	warnEx(String message, Throwable error)

Method Detail

isLoggable

boolean isLoggable(MessageReporter.Level level)

log

void log(MessageReporter.Level level,
         String message,
         Object... formatArgs)

logEx

void logEx(MessageReporter.Level level,
           String message,
           Object[] formatArgs,
           Throwable error)

info

void info(String message,
          Object... formatArgs)

trace

@Deprecated
void trace(String message,
           Object... formatArgs)

Deprecated.

Trace messages should be reported on a Logger instance. This is kept because it's simpler to port calls to this method to SLF4J in PMD 7 than to do the same if these calls were calls to a java.util.logging.Logger in PMD 6.

warn

void warn(String message,
          Object... formatArgs)

warnEx

void warnEx(String message,
            Throwable error)

warnEx

void warnEx(String message,
            Object[] formatArgs,
            Throwable error)

error

void error(String message,
           Object... formatArgs)

errorEx

void errorEx(String message,
             Throwable error)

errorEx

void errorEx(String message,
             Object[] formatArgs,
             Throwable error)

numErrors

int numErrors()

Returns the number of errors reported on this instance. Any call to log(Level, String, Object...) or logEx(Level, String, Object[], Throwable) with a level of MessageReporter.Level.ERROR should increment this number.