Package org.eclipse.ditto.json

Class JsonKeyInvalidException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.eclipse.ditto.json.JsonRuntimeException

org.eclipse.ditto.json.JsonKeyInvalidException

All Implemented Interfaces:

Serializable, JsonException

public final class JsonKeyInvalidException
extends JsonRuntimeException

Thrown if a JsonKey was in an invalid format.

Since:

1.2.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JsonKeyInvalidException.Builder	A mutable builder for a JsonKeyInvalidException.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_CODE	Error code of this exception.

Method Summary

Modifier and Type	Method	Description
static JsonKeyInvalidException.Builder	newBuilder()	Returns a builder for fluently creating instances of JsonKeyInvalidExceptions.
static JsonExceptionBuilder<JsonKeyInvalidException>	newBuilderWithDescription(CharSequence jsonKey, String description)	Returns a new builder containing the given message for the given JSON key.
static JsonExceptionBuilder<JsonKeyInvalidException>	newBuilderWithoutDescription(CharSequence jsonKey)	Returns a new builder already containing a default message that the JSON key is no valid.

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

getDescription, getErrorCode, getHref, newBuilder

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Details

ERROR_CODE

public static final String ERROR_CODE

Error code of this exception.

See Also:

• Constant Field Values

Method Details

newBuilder

public static JsonKeyInvalidException.Builder newBuilder()

Returns a builder for fluently creating instances of JsonKeyInvalidExceptions.

Returns:

a new builder for JsonKeyInvalidException objects.

newBuilderWithDescription

public static JsonExceptionBuilder<JsonKeyInvalidException> newBuilderWithDescription(CharSequence jsonKey,
 @Nullable
 String description)

Returns a new builder containing the given message for the given JSON key.

Parameters:

jsonKey - The JSON key the message is about.

description - The description to be in the exception.

Returns:

a builder for JsonKeyInvalidException objects.

newBuilderWithoutDescription

public static JsonExceptionBuilder<JsonKeyInvalidException> newBuilderWithoutDescription(CharSequence jsonKey)

Returns a new builder already containing a default message that the JSON key is no valid.

Parameters:

jsonKey - The JSON key the message is about.

Returns:

a builder for JsonKeyInvalidException objects.

Since:

1.2.0