com.github.fge.jsonschema.report

Class ForwardingReport

java.lang.Object

com.github.fge.jsonschema.report.ForwardingReport

All Implemented Interfaces:

ProcessingReport, Iterable<ProcessingMessage>

@NotThreadSafe
public final class ForwardingReport
extends Object
implements ProcessingReport

A simple forwarding processing report with success/failure state

This report forwards all its logged messages to another report and only changes (and retains) its success status to false if a message is logged at the error level.

Constructor Summary

Constructors

Constructor and Description
ForwardingReport(ProcessingReport report) Constructor

Method Summary

Methods

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
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
Iterator<ProcessingMessage>	iterator()
void	mergeWith(ProcessingReport other) Merge another report into this report
void	warn(ProcessingMessage message) Log a message with a level of LogLevel.WARNING

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardingReport

public ForwardingReport(ProcessingReport report)

Constructor

Parameters:

report - the report to forward logged messages to

Method Detail

getLogLevel

public LogLevel getLogLevel()

Description copied from interface: ProcessingReport

Get the log level of this report

Any message with a log level greater than, or equal to, the result of this method is logged.

Specified by:

getLogLevel in interface ProcessingReport

Returns:

the log level

getExceptionThreshold

public LogLevel getExceptionThreshold()

Description copied from interface: ProcessingReport

Get the exception threshold of this report

Any message with a log level greater than, or equal to, the result of this method raises a ProcessingException or any subclass.

Specified by:

getExceptionThreshold in interface ProcessingReport

Returns:

the exception threshold

See Also:

ProcessingMessage.asException()

debug

public void debug(ProcessingMessage message)
           throws ProcessingException

Description copied from interface: ProcessingReport

Log a message with a level of LogLevel.DEBUG

It is the responsibility of the implementation to set the log level of the message appropriately.

Specified by:

debug in interface ProcessingReport

Parameters:

message - the message

Throws:

ProcessingException - the level of this message grants that an exception is thrown instead

See Also:

ProcessingReport.getExceptionThreshold(), ProcessingMessage.setLogLevel(LogLevel)

info

public void info(ProcessingMessage message)
          throws ProcessingException

Description copied from interface: ProcessingReport

Log a message with a level of LogLevel.INFO

It is the responsibility of the implementation to set the log level of the message appropriately.

Specified by:

info in interface ProcessingReport

Parameters:

message - the message

Throws:

ProcessingException - the level of this message grants that an exception is thrown instead

See Also:

ProcessingReport.getExceptionThreshold(), ProcessingMessage.setLogLevel(LogLevel)

warn

public void warn(ProcessingMessage message)
          throws ProcessingException

Description copied from interface: ProcessingReport

Log a message with a level of LogLevel.WARNING

It is the responsibility of the implementation to set the log level of the message appropriately.

Specified by:

warn in interface ProcessingReport

Parameters:

message - the message

Throws:

ProcessingException - the level of this message grants that an exception is thrown instead

See Also:

ProcessingReport.getExceptionThreshold(), ProcessingMessage.setLogLevel(LogLevel)

error

public void error(ProcessingMessage message)
           throws ProcessingException

Description copied from interface: ProcessingReport

Log a message with a level of LogLevel.ERROR

It is the responsibility of the implementation to set the log level of the message appropriately.

Specified by:

error in interface ProcessingReport

Parameters:

message - the message

Throws:

ProcessingException - the level of this message grants that an exception is thrown instead

See Also:

ProcessingReport.getExceptionThreshold(), ProcessingMessage.setLogLevel(LogLevel)

isSuccess

public boolean isSuccess()

Description copied from interface: ProcessingReport

Tell whether the report is a success

A report is considered successful if no messages with a level of LogLevel.ERROR or higher have been logged.

Specified by:

isSuccess in interface ProcessingReport

Returns:

a boolean

mergeWith

public void mergeWith(ProcessingReport other)
               throws ProcessingException

Description copied from interface: ProcessingReport

Merge another report into this report

Specified by:

mergeWith in interface ProcessingReport

Parameters:

other - the other report

Throws:

ProcessingException - a message in the other report has a level granting that an exception be thrown

iterator

public Iterator<ProcessingMessage> iterator()

Specified by:

iterator in interface Iterable<ProcessingMessage>