org.eel.kitchen.jsonschema.report

Class Message.Builder

java.lang.Object

org.eel.kitchen.jsonschema.report.Message.Builder

Enclosing class:

Message

public static final class Message.Builder
extends Object

Builder class for a Message

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.

Method Summary

Methods

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

Method Detail

setKeyword

public Message.Builder setKeyword(String keyword)

Set the keyword associated with this message

Parameters:

keyword - the keyword

Returns:

the builder

setMessage

public Message.Builder setMessage(String message)

Set the error message

Parameters:

message - the error message

Returns:

the builder

setFatal

public Message.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 Message.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> Message.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> Message.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 Message.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 Message.Builder clearInfo()

Clear all supplementary information

This will not reset the domain, keyword or message.

Returns:

the builder

build

public Message build()

Build the actual message

Returns:

a Message

Throws:

NullPointerException - the keyword or message are null