Class ThingIdInvalidException

  • All Implemented Interfaces:
    java.io.Serializable, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<org.eclipse.ditto.base.model.exceptions.DittoRuntimeException>, org.eclipse.ditto.base.model.headers.WithDittoHeaders, org.eclipse.ditto.base.model.headers.WithManifest, org.eclipse.ditto.base.model.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate<org.eclipse.ditto.json.JsonObject,​org.eclipse.ditto.json.JsonField>, ThingException

    @Immutable
    public final class ThingIdInvalidException
    extends org.eclipse.ditto.base.model.exceptions.DittoRuntimeException
    implements ThingException
    Thrown if the Thing's ID is not valid (for example if it does not comply to the Thing ID REGEX).
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ThingIdInvalidException.Builder
      A mutable builder with a fluent API for a ThingIdInvalidException.
      • Nested classes/interfaces inherited from class org.eclipse.ditto.base.model.exceptions.DittoRuntimeException

        org.eclipse.ditto.base.model.exceptions.DittoRuntimeException.JsonFields
      • Nested classes/interfaces inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable

        org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelector, org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelectorAndPredicate<T extends java.lang.Object>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPointer<J extends org.eclipse.ditto.json.JsonValue>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate<J extends org.eclipse.ditto.json.JsonValue,​T extends java.lang.Object>
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ERROR_CODE
      Error code of this exception.
    • Constructor Summary

      Constructors 
      Constructor Description
      ThingIdInvalidException​(java.lang.String thingId)
      Constructs a new ThingIdInvalidException object.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ThingIdInvalidException fromJson​(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Constructs a new ThingIdInvalidException object with the exception message extracted from the given JSON object.
      static ThingIdInvalidException fromMessage​(java.lang.String message, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Constructs a new ThingIdInvalidException object with the given exception message.
      static ThingIdInvalidException.Builder newBuilder​(java.lang.CharSequence thingId)
      A mutable builder for a ThingIdInvalidException.
      org.eclipse.ditto.base.model.exceptions.DittoRuntimeException setDittoHeaders​(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)  
      • Methods inherited from class org.eclipse.ditto.base.model.exceptions.DittoRuntimeException

        appendToJson, asDittoRuntimeException, equals, fromJson, fromMessage, getDescription, getDittoHeaders, getErrorCode, getHref, getHref, getHttpStatus, getHttpStatus, getImplementedSchemaVersion, getManifest, hashCode, toBuilder, toJson, toJson, toString
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable

        getLatestSchemaVersion, getSupportedSchemaVersions, implementsSchemaVersion, implementsSchemaVersion, toJsonString
      • Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate

        toJson, toJsonString, toJsonString
    • Field Detail

      • ERROR_CODE

        public static final java.lang.String ERROR_CODE
        Error code of this exception.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ThingIdInvalidException

        public ThingIdInvalidException​(java.lang.String thingId)
        Constructs a new ThingIdInvalidException object.
        Parameters:
        thingId - the invalid Thing ID.
    • Method Detail

      • newBuilder

        public static ThingIdInvalidException.Builder newBuilder​(@Nullable
                                                                 java.lang.CharSequence thingId)
        A mutable builder for a ThingIdInvalidException.
        Parameters:
        thingId - the ID of the thing.
        Returns:
        the builder.
      • fromMessage

        public static ThingIdInvalidException fromMessage​(@Nullable
                                                          java.lang.String message,
                                                          org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Constructs a new ThingIdInvalidException object with the given exception message.
        Parameters:
        message - detail message. This message can be later retrieved by the Throwable.getMessage() method.
        dittoHeaders - the headers of the command which resulted in this exception.
        Returns:
        the new ThingIdInvalidException.
        Throws:
        java.lang.NullPointerException - if dittoHeaders is null.
      • fromJson

        public static ThingIdInvalidException fromJson​(org.eclipse.ditto.json.JsonObject jsonObject,
                                                       org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Constructs a new ThingIdInvalidException object with the exception message extracted from the given JSON object.
        Parameters:
        jsonObject - the JSON to read the DittoRuntimeException.JsonFields.MESSAGE field from.
        dittoHeaders - the headers of the command which resulted in this exception.
        Returns:
        the new ThingIdInvalidException.
        Throws:
        java.lang.NullPointerException - if any argument is null.
        org.eclipse.ditto.json.JsonMissingFieldException - if this JsonObject did not contain an error message.
        org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected format.
      • setDittoHeaders

        public org.eclipse.ditto.base.model.exceptions.DittoRuntimeException setDittoHeaders​(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Specified by:
        setDittoHeaders in interface org.eclipse.ditto.base.model.headers.DittoHeadersSettable<org.eclipse.ditto.base.model.exceptions.DittoRuntimeException>