public interface ProcessingReport extends Iterable<ProcessingMessage>
While you can implement this interface yourself, it is recommended that
you extend AbstractProcessingReport
instead.
Modifier and Type | Method and Description |
---|---|
void |
debug(ProcessingMessage message)
Log a message with a level of
LogLevel.DEBUG |
void |
error(ProcessingMessage message)
Log a message with a level of
LogLevel.ERROR |
void |
fatal(ProcessingMessage message)
Log a message with a level of
LogLevel.FATAL |
LogLevel |
getExceptionThreshold()
Get the exception threshold of this report
|
LogLevel |
getLogLevel()
Get the log level of this report
|
void |
info(ProcessingMessage message)
Log a message with a level of
LogLevel.INFO |
boolean |
isSuccess()
Tell whether the report is a success
|
void |
mergeWith(ProcessingReport other)
Merge another report into this report
|
void |
warn(ProcessingMessage message)
Log a message with a level of
LogLevel.WARNING |
forEach, iterator, spliterator
LogLevel getLogLevel()
Any message with a log level greater than, or equal to, the result of this method is logged.
LogLevel getExceptionThreshold()
Any message with a log level greater than, or equal to, the result of
this method raises a ProcessingException
or any subclass.
ProcessingMessage.asException()
void debug(ProcessingMessage message) throws ProcessingException
LogLevel.DEBUG
It is the responsibility of the implementation to set the log level of the message appropriately.
message
- the messageProcessingException
- the level of this message grants that an
exception is thrown insteadgetExceptionThreshold()
,
ProcessingMessage.setLogLevel(LogLevel)
void info(ProcessingMessage message) throws ProcessingException
LogLevel.INFO
It is the responsibility of the implementation to set the log level of the message appropriately.
message
- the messageProcessingException
- the level of this message grants that an
exception is thrown insteadgetExceptionThreshold()
,
ProcessingMessage.setLogLevel(LogLevel)
void warn(ProcessingMessage message) throws ProcessingException
LogLevel.WARNING
It is the responsibility of the implementation to set the log level of the message appropriately.
message
- the messageProcessingException
- the level of this message grants that an
exception is thrown insteadgetExceptionThreshold()
,
ProcessingMessage.setLogLevel(LogLevel)
void error(ProcessingMessage message) throws ProcessingException
LogLevel.ERROR
It is the responsibility of the implementation to set the log level of the message appropriately.
message
- the messageProcessingException
- the level of this message grants that an
exception is thrown insteadgetExceptionThreshold()
,
ProcessingMessage.setLogLevel(LogLevel)
void fatal(ProcessingMessage message) throws ProcessingException
LogLevel.FATAL
It is the responsibility of the implementation to set the log level of the message appropriately.
message
- the messageProcessingException
- the level of this message grants that an
exception is thrown insteadgetExceptionThreshold()
,
ProcessingMessage.setLogLevel(LogLevel)
boolean isSuccess()
A report is considered successful if no messages with a level of
LogLevel.ERROR
or higher have been logged.
void mergeWith(ProcessingReport other) throws ProcessingException
other
- the other reportProcessingException
- a message in the other report has a level
granting that an exception be thrownCopyright © 2016. All rights reserved.