Package org.eclipse.ditto.json

Class JsonKeyInvalidException.Builder

java.lang.Object

org.eclipse.ditto.json.AbstractJsonExceptionBuilder<JsonKeyInvalidException>

org.eclipse.ditto.json.JsonKeyInvalidException.Builder

All Implemented Interfaces:

JsonExceptionBuilder<JsonKeyInvalidException>

Enclosing class:

JsonKeyInvalidException

@NotThreadSafe
public static final class JsonKeyInvalidException.Builder
extends AbstractJsonExceptionBuilder<JsonKeyInvalidException>

A mutable builder for a JsonKeyInvalidException.

Method Summary

Modifier and Type	Method	Description
protected JsonKeyInvalidException	doBuild(String errorCode, String message, String description, Throwable cause, URI href)	This method must be implemented by subclasses.
JsonKeyInvalidException.Builder	jsonPointer(CharSequence jsonKeyString)	Sets a message which points to the name of the invalid JSON key.

Methods inherited from class org.eclipse.ditto.json.AbstractJsonExceptionBuilder

build, cause, cause, description, description, href, href, message, message

Methods inherited from class java.lang.Object

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

Method Details

jsonPointer

public JsonKeyInvalidException.Builder jsonPointer(@Nullable
 CharSequence jsonKeyString)

Sets a message which points to the name of the invalid JSON key. Thus if this method is called, AbstractJsonExceptionBuilder.message(String) should not be called.

Parameters:

jsonKeyString - the string representation of the invalid JSON pointer.

Returns:

this builder to allow method chaining.

doBuild

protected JsonKeyInvalidException doBuild(String errorCode,
 @Nullable
 String message,
 @Nullable
 String description,
 @Nullable
 Throwable cause,
 @Nullable
 URI href)

Description copied from class: AbstractJsonExceptionBuilder

This method must be implemented by subclasses. It is responsible for actually building the exception object. Therefore it receives the data which was provided during the building process.

Specified by:

doBuild in class AbstractJsonExceptionBuilder<JsonKeyInvalidException>

Parameters:

errorCode - the error code.

message - the detail message or null.

description - the description or null.

cause - the cause or null.

href - the link to further information or null.

Returns:

a new exception of the target type.