Package org.eclipse.ditto.signals.commands.things.modify

Class ModifyThingResponse

  • All Implemented Interfaces:
    org.eclipse.ditto.model.base.headers.WithDittoHeaders<ModifyThingResponse>, org.eclipse.ditto.model.base.headers.WithManifest, org.eclipse.ditto.model.base.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>, org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate<org.eclipse.ditto.json.JsonObject,​org.eclipse.ditto.json.JsonField>, org.eclipse.ditto.model.things.WithThingId, org.eclipse.ditto.signals.base.Signal<ModifyThingResponse>, org.eclipse.ditto.signals.base.WithId, org.eclipse.ditto.signals.base.WithName, org.eclipse.ditto.signals.base.WithOptionalEntity, org.eclipse.ditto.signals.base.WithResource, org.eclipse.ditto.signals.base.WithType, org.eclipse.ditto.signals.commands.base.CommandResponse<ModifyThingResponse>, ThingModifyCommandResponse<ModifyThingResponse>, ThingCommandResponse<ModifyThingResponse>
    @Immutable
public final class ModifyThingResponse
extends org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<ModifyThingResponse>
implements ThingModifyCommandResponse<ModifyThingResponse>
    Response to a ModifyThing command.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.eclipse.ditto.signals.commands.base.CommandResponse

        org.eclipse.ditto.signals.commands.base.CommandResponse.JsonFields

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

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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String TYPE
      Type of this response.

      • Fields inherited from interface org.eclipse.ditto.signals.commands.base.CommandResponse

        TYPE_QUALIFIER

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      protected void appendPayload​(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion, Predicate<org.eclipse.ditto.json.JsonField> thePredicate)  
      protected boolean canEqual​(Object other)  
      static ModifyThingResponse created​(org.eclipse.ditto.model.things.Thing thing, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Returns a new ModifyThingResponse for a created Thing.
      boolean equals​(Object o)  
      static ModifyThingResponse fromJson​(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Creates a response to a ModifyThing command from a JSON string.
      static ModifyThingResponse fromJson​(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Creates a response to a ModifyThing command from a JSON object.
      Optional<org.eclipse.ditto.json.JsonValue> getEntity​(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)  
      org.eclipse.ditto.json.JsonPointer getResourcePath()  
      Optional<org.eclipse.ditto.model.things.Thing> getThingCreated()
      Returns the created Thing.
      org.eclipse.ditto.model.things.ThingId getThingEntityId()  
      int hashCode()  
      static ModifyThingResponse modified​(String thingId, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Deprecated.
      Thing ID is now typed.
      static ModifyThingResponse modified​(org.eclipse.ditto.model.things.ThingId thingId, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Returns a new ModifyThingResponse for a modified Thing.
      ModifyThingResponse setDittoHeaders​(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)  
      String toString()  

      • Methods inherited from class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse

        getDittoHeaders, getManifest, getStatusCode, getType, toJson

      • Methods inherited from interface org.eclipse.ditto.signals.commands.base.CommandResponse

        getImplementedSchemaVersion, getResponseType, getStatusCode, getStatusCodeValue, isOfExpectedResponseType, toJson, toJson

      • Methods inherited from interface org.eclipse.ditto.model.base.json.Jsonifiable

        getLatestSchemaVersion, getSupportedSchemaVersions, implementsSchemaVersion, implementsSchemaVersion, toJsonString

      • Methods inherited from interface org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate

        toJson, toJsonString, toJsonString

      • Methods inherited from interface org.eclipse.ditto.signals.base.Signal

        getName

      • Methods inherited from interface org.eclipse.ditto.model.base.headers.WithDittoHeaders

        getDittoHeaders

      • Methods inherited from interface org.eclipse.ditto.signals.base.WithId

        getId

      • Methods inherited from interface org.eclipse.ditto.model.base.headers.WithManifest

        getManifest

      • Methods inherited from interface org.eclipse.ditto.signals.base.WithOptionalEntity

        getEntity

      • Methods inherited from interface org.eclipse.ditto.model.things.WithThingId

        getThingId

      • Methods inherited from interface org.eclipse.ditto.signals.base.WithType

        getType

    • Method Detail

      • created

        public static ModifyThingResponse created​(org.eclipse.ditto.model.things.Thing thing,
                                          org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
        Returns a new ModifyThingResponse for a created Thing. This corresponds to the HTTP status code HttpStatusCode.CREATED.
        Parameters:
        thing - the created Thing.
        dittoHeaders - the headers of the ThingCommand which caused the new response.
        Returns:
        a command response for a created Thing.
        Throws:
        NullPointerException - if any argument is null.

      • modified

        public static ModifyThingResponse modified​(org.eclipse.ditto.model.things.ThingId thingId,
                                           org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
        Returns a new ModifyThingResponse for a modified Thing. This corresponds to the HTTP status code HttpStatusCode.NO_CONTENT.
        Parameters:
        thingId - the Thing ID of the modified Thing.
        dittoHeaders - the headers of the ThingCommand which caused the new response.
        Returns:
        a command response for a modified Thing.
        Throws:
        NullPointerException - if dittoHeaders is null.

      • fromJson

        public static ModifyThingResponse fromJson​(String jsonString,
                                           org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
        Creates a response to a ModifyThing command from a JSON string.
        Parameters:
        jsonString - the JSON string of which the response is to be created.
        dittoHeaders - the headers of the preceding command.
        Returns:
        the response.
        Throws:
        NullPointerException - if jsonString is null.
        IllegalArgumentException - if jsonString is empty.
        org.eclipse.ditto.json.JsonParseException - if the passed in jsonString was not in the expected format.

      • fromJson

        public static ModifyThingResponse fromJson​(org.eclipse.ditto.json.JsonObject jsonObject,
                                           org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
        Creates a response to a ModifyThing command from a JSON object.
        Parameters:
        jsonObject - the JSON object of which the response is to be created.
        dittoHeaders - the headers of the preceding command.
        Returns:
        the response.
        Throws:
        NullPointerException - if jsonObject is null.
        org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected format.

      • getThingEntityId

        public org.eclipse.ditto.model.things.ThingId getThingEntityId()
        Specified by:
        getThingEntityId in interface org.eclipse.ditto.model.things.WithThingId

      • getThingCreated

        public Optional<org.eclipse.ditto.model.things.Thing> getThingCreated()
        Returns the created Thing.
        Returns:
        the created Thing.

      • getEntity

        public Optional<org.eclipse.ditto.json.JsonValue> getEntity​(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
        Specified by:
        getEntity in interface org.eclipse.ditto.signals.base.WithOptionalEntity

      • getResourcePath

        public org.eclipse.ditto.json.JsonPointer getResourcePath()
        Specified by:
        getResourcePath in interface org.eclipse.ditto.signals.base.WithResource

      • appendPayload

        protected void appendPayload​(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder,
                             org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion,
                             Predicate<org.eclipse.ditto.json.JsonField> thePredicate)
        Specified by:
        appendPayload in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<ModifyThingResponse>

      • canEqual

        protected boolean canEqual​(@Nullable
                           Object other)
        Overrides:
        canEqual in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<ModifyThingResponse>

      • equals

        public boolean equals​(@Nullable
                      Object o)
        Overrides:
        equals in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<ModifyThingResponse>

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<ModifyThingResponse>

      • toString

        public String toString()
        Overrides:
        toString in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<ModifyThingResponse>