org.eel.kitchen.jsonschema.report

Class ValidationMessage.Builder

java.lang.Object

org.eel.kitchen.jsonschema.report.ValidationMessage.Builder

Enclosing class:

ValidationMessage

public static final class ValidationMessage.Builder
extends Object

Builder class for a ValidationMessage

To build a validation message, you instantiate this class, fill the necessary information and finally call build() to obtain the message.

In most cases, you won't need to instantiate one directly:

• when implementing a SyntaxChecker, an instance of this class will be passed as an argument, already filled with the correct domain and keyword;
• when implementing a KeywordValidator, you can obtain an instance also filled with the correct domain and keyword.

Field Summary

Fields

Modifier and Type	Field and Description
private ValidationDomain	domain Validation domain
(package private) boolean	fatal Is this error message fatal?
private ObjectNode	info Further information associated with the error message
private String	keyword Keyword associated with the message
private String	message Error message
private static Set<String>	RESERVED Reserved set of keywords which will be removed off info before the message is built

Constructor Summary

Constructors

Constructor and Description
ValidationMessage.Builder(ValidationDomain domain) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
<T> ValidationMessage.Builder	addInfo(String key, Collection<T> values) Add further information to the message as a Collection of objects of an arbitrary type
ValidationMessage.Builder	addInfo(String key, int value) Add further information to the message as an integer
ValidationMessage.Builder	addInfo(String key, JsonNode value) Add further information to the message as a JsonNode
<T> ValidationMessage.Builder	addInfo(String key, T value) Add further information to the message for an arbitrary type
ValidationMessage	build() Build the actual message
ValidationMessage.Builder	clearInfo() Clear all supplementary information
ValidationMessage.Builder	setFatal(boolean fatal) Should this error message be marked as fatal?
ValidationMessage.Builder	setKeyword(String keyword) Set the keyword associated with this message
ValidationMessage.Builder	setMessage(String message) Set the error message

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED

private static final Set<String> RESERVED

Reserved set of keywords which will be removed off info before the message is built

domain

private final ValidationDomain domain

Validation domain

keyword

private String keyword

Keyword associated with the message

In some events, it may be set to N/A.

message

private String message

Error message

info

private final ObjectNode info

Further information associated with the error message

fatal

boolean fatal

Is this error message fatal?

Constructor Detail

ValidationMessage.Builder

public ValidationMessage.Builder(ValidationDomain domain)

Constructor

Parameters:

domain - the validation domain

Method Detail

setKeyword

public ValidationMessage.Builder setKeyword(String keyword)

Set the keyword associated with this message

Parameters:

keyword - the keyword

Returns:

the builder

setMessage

public ValidationMessage.Builder setMessage(String message)

Set the error message

Parameters:

message - the error message

Returns:

the builder

setFatal

public ValidationMessage.Builder setFatal(boolean fatal)

Should this error message be marked as fatal?

Parameters:

fatal - true if this error message is fatal (false by default)

Returns:

the builder

addInfo

public ValidationMessage.Builder addInfo(String key,
                                JsonNode value)

Add further information to the message as a JsonNode

Parameters:

key - the key

value - the value

Returns:

the builder

addInfo

public <T> ValidationMessage.Builder addInfo(String key,
                                    T value)

Add further information to the message for an arbitrary type

This will call Object.toString() on the passed value. It is therefore important that objects passed as arguments implement it correctly.

Type Parameters:

T - the type of the value

Parameters:

key - the key

value - the value

Returns:

the builder

addInfo

public <T> ValidationMessage.Builder addInfo(String key,
                                    Collection<T> values)

Add further information to the message as a Collection of objects of an arbitrary type

This will call Object.toString() on each element of the collection.It is therefore important that objects passed as arguments implement it correctly.

Type Parameters:

T - the type of values in the collections

Parameters:

key - the key

values - the collection

Returns:

the builder

See Also:

addInfo(String, Object)

addInfo

public ValidationMessage.Builder addInfo(String key,
                                int value)

Add further information to the message as an integer

Parameters:

key - the key

value - the value

Returns:

the builder

clearInfo

public ValidationMessage.Builder clearInfo()

Clear all supplementary information

This will not reset the domain, keyword or message.

Returns:

the builder

build

public ValidationMessage build()

Build the actual message

Returns:

a ValidationMessage

Throws:

NullPointerException - the keyword or message are null