Module dev.metaschema.cli

Package dev.metaschema.cli.util

Class LoggingValidationHandler

java.lang.Object

dev.metaschema.core.model.validation.AbstractValidationResultProcessor

dev.metaschema.cli.util.LoggingValidationHandler

public final class LoggingValidationHandler
extends AbstractValidationResultProcessor

Supports logging validation findings to the console using ANSI color codes to improve the visibility of warnings and errors.

Method Summary

Modifier and Type	Method	Description
protected void	handleConstraintValidationFinding(ConstraintValidationFinding finding)	Process the Metaschema module constraint validation finding.
protected void	handleJsonValidationFinding(JsonSchemaContentValidator.JsonValidationFinding finding)	Process the JSON validation finding.
protected void	handleXmlValidationFinding(XmlSchemaContentValidator.XmlValidationFinding finding)	Process the XML validation finding.
static LoggingValidationHandler	instance()	Get a singleton instance of the logging validation handler.
static LoggingValidationHandler	instance(boolean logExceptions)	Get a singleton instance of the logging validation handler.
boolean	isLogExceptions()	Determine if exceptions should be logged.
static LoggingValidationHandler	withPathFormatter(IPathFormatter pathFormatter)	Create a new logging validation handler with a custom path formatter.
static LoggingValidationHandler	withSettings(boolean logExceptions, IPathFormatter pathFormatter)	Create a new logging validation handler with custom settings.

Methods inherited from class dev.metaschema.core.model.validation.AbstractValidationResultProcessor

handleResults, handleValidationFindings

Methods inherited from class java.lang.Object

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

Method Details

instance

@NonNull
public static LoggingValidationHandler instance()

Get a singleton instance of the logging validation handler.

This instance will not log exceptions.

Returns:

the instance

instance

@NonNull
public static LoggingValidationHandler instance(boolean logExceptions)

Get a singleton instance of the logging validation handler.

Parameters:

logExceptions - true if this instance will log exceptions or false otherwise

Returns:

the instance

withPathFormatter

@NonNull
public static LoggingValidationHandler withPathFormatter(@NonNull
 IPathFormatter pathFormatter)

Create a new logging validation handler with a custom path formatter.

Parameters:

pathFormatter - the path formatter to use for constraint validation findings

Returns:

a new handler instance

withSettings

@NonNull
public static LoggingValidationHandler withSettings(boolean logExceptions,
 @NonNull
 IPathFormatter pathFormatter)

Create a new logging validation handler with custom settings.

Parameters:

logExceptions - true if this instance will log exceptions or false otherwise

pathFormatter - the path formatter to use for constraint validation findings

Returns:

a new handler instance

isLogExceptions

public boolean isLogExceptions()

Determine if exceptions should be logged.

Returns:

true if exceptions are logged or false otherwise

handleJsonValidationFinding

protected void handleJsonValidationFinding(@NonNull
 JsonSchemaContentValidator.JsonValidationFinding finding)

Description copied from class: AbstractValidationResultProcessor

Process the JSON validation finding.

Specified by:

handleJsonValidationFinding in class AbstractValidationResultProcessor

Parameters:

finding - the validation finding to process

handleXmlValidationFinding

protected void handleXmlValidationFinding(XmlSchemaContentValidator.XmlValidationFinding finding)

Description copied from class: AbstractValidationResultProcessor

Process the XML validation finding.

Specified by:

handleXmlValidationFinding in class AbstractValidationResultProcessor

Parameters:

finding - the validation finding to process

handleConstraintValidationFinding

protected void handleConstraintValidationFinding(@NonNull
 ConstraintValidationFinding finding)

Description copied from class: AbstractValidationResultProcessor

Process the Metaschema module constraint validation finding.

Specified by:

handleConstraintValidationFinding in class AbstractValidationResultProcessor

Parameters:

finding - the validation finding to process