Package org.eclipse.ditto.json

Class AbstractJsonExceptionBuilder<T extends JsonException>

java.lang.Object

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

Type Parameters:

T - type of the subclass of JsonRuntimeException.

All Implemented Interfaces:

JsonExceptionBuilder<T>

Direct Known Subclasses:

JsonFieldSelectorInvalidException.Builder, JsonKeyInvalidException.Builder, JsonMissingFieldException.Builder, JsonParseException.Builder, JsonPointerInvalidException.Builder, JsonRuntimeException.Builder

@NotThreadSafe
public abstract class AbstractJsonExceptionBuilder<T extends JsonException>
extends Object
implements JsonExceptionBuilder<T>

Abstract base implementation for builders which create objects of subtypes of JsonRuntimeException.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJsonExceptionBuilder(String errorCode)	Constructs a new AbstractJsonExceptionBuilder object.

Method Summary

Modifier and Type	Method	Description
T	build()	Builds an instance of the target exception type using the provided data.
JsonExceptionBuilder<T>	cause(Throwable cause)	Sets the cause which led to the exception to be built.
JsonExceptionBuilder<T>	cause(Supplier<Throwable> causeSupplier)	Sets the cause which led to the exception to be built.
JsonExceptionBuilder<T>	description(String description)	Sets a description with further information about the exception to be built.
JsonExceptionBuilder<T>	description(Supplier<String> descriptionSupplier)	Sets a description with further information about the exception to be built.
protected abstract T	doBuild(String errorCode, String message, String description, Throwable cause, URI href)	This method must be implemented by subclasses.
JsonExceptionBuilder<T>	href(URI href)	Sets a link to a resource which provides further information about the exception to be built.
JsonExceptionBuilder<T>	href(Supplier<URI> hrefSupplier)	Sets a link to a resource which provides further information about the exception to be built.
JsonExceptionBuilder<T>	message(String message)	Sets the detail message of the exception to be built.
JsonExceptionBuilder<T>	message(Supplier<String> messageSupplier)	Sets the detail message of the exception to be built.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractJsonExceptionBuilder

protected AbstractJsonExceptionBuilder(String errorCode)

Constructs a new AbstractJsonExceptionBuilder object.

Parameters:

errorCode - a code which uniquely identifies the exception.

Throws:

NullPointerException - if errorCode is null.

IllegalArgumentException - if errorCode is empty.

Method Details

message

public JsonExceptionBuilder<T> message(@Nullable
 String message)

Description copied from interface: JsonExceptionBuilder

Sets the detail message of the exception to be built.

Specified by:

message in interface JsonExceptionBuilder<T extends JsonException>

Parameters:

message - the detail message.

Returns:

this builder to allow method chaining.

message

public JsonExceptionBuilder<T> message(Supplier<String> messageSupplier)

Description copied from interface: JsonExceptionBuilder

Sets the detail message of the exception to be built.

Specified by:

message in interface JsonExceptionBuilder<T extends JsonException>

Parameters:

messageSupplier - supplier of the message to be set.

Returns:

this builder to allow method chaining.

description

public JsonExceptionBuilder<T> description(@Nullable
 String description)

Description copied from interface: JsonExceptionBuilder

Sets a description with further information about the exception to be built.

Specified by:

description in interface JsonExceptionBuilder<T extends JsonException>

Parameters:

description - a description.

Returns:

this builder to allow method chaining.

description

public JsonExceptionBuilder<T> description(Supplier<String> descriptionSupplier)

Description copied from interface: JsonExceptionBuilder

Sets a description with further information about the exception to be built.

Specified by:

description in interface JsonExceptionBuilder<T extends JsonException>

Parameters:

descriptionSupplier - supplier of the description to be set.

Returns:

this builder to allow method chaining.

cause

public JsonExceptionBuilder<T> cause(@Nullable
 Throwable cause)

Description copied from interface: JsonExceptionBuilder

Sets the cause which led to the exception to be built.

Specified by:

cause in interface JsonExceptionBuilder<T extends JsonException>

Parameters:

cause - the cause.

Returns:

this builder to allow method chaining.

cause

public JsonExceptionBuilder<T> cause(Supplier<Throwable> causeSupplier)

Description copied from interface: JsonExceptionBuilder

Sets the cause which led to the exception to be built.

Specified by:

cause in interface JsonExceptionBuilder<T extends JsonException>

Parameters:

causeSupplier - supplier of the cause to be set.

Returns:

this builder to allow method chaining.

href

public JsonExceptionBuilder<T> href(@Nullable
 URI href)

Description copied from interface: JsonExceptionBuilder

Sets a link to a resource which provides further information about the exception to be built.

Specified by:

href in interface JsonExceptionBuilder<T extends JsonException>

Parameters:

href - a link to further information.

Returns:

this builder to allow method chaining.

href

public JsonExceptionBuilder<T> href(Supplier<URI> hrefSupplier)

Description copied from interface: JsonExceptionBuilder

Sets a link to a resource which provides further information about the exception to be built.

Specified by:

href in interface JsonExceptionBuilder<T extends JsonException>

Parameters:

hrefSupplier - supplier of the link to be set.

Returns:

this builder to allow method chaining.

build

public T build()

Description copied from interface: JsonExceptionBuilder

Builds an instance of the target exception type using the provided data.

Specified by:

build in interface JsonExceptionBuilder<T extends JsonException>

Returns:

a new exception of the target type.

doBuild

protected abstract T doBuild(String errorCode,
 String message,
 String description,
 Throwable cause,
 URI href)

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.

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.