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

Class ModifyFeatureDesiredPropertyResponse

    • Nested Class Summary

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

        org.eclipse.ditto.base.model.signals.commands.CommandResponse.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 TYPE
      Type of this response.

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

        TYPE_QUALIFIER

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void appendPayload​(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion, java.util.function.Predicate<org.eclipse.ditto.json.JsonField> thePredicate)  
      protected boolean canEqual​(java.lang.Object other)  
      static ModifyFeatureDesiredPropertyResponse created​(ThingId thingId, java.lang.CharSequence featureId, org.eclipse.ditto.json.JsonPointer desiredPropertyPointer, org.eclipse.ditto.json.JsonValue desiredValue, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Returns a new ModifyFeatureDesiredPropertyResponse for a created desired property.
      boolean equals​(java.lang.Object o)  
      static ModifyFeatureDesiredPropertyResponse fromJson​(java.lang.String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a ModifyFeatureDesiredProperty command from a JSON string.
      static ModifyFeatureDesiredPropertyResponse fromJson​(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a ModifyFeatureDesiredProperty command from a JSON object.
      org.eclipse.ditto.json.JsonPointer getDesiredPropertyPointer()
      Returns the pointer of the modified desired property.
      java.util.Optional<org.eclipse.ditto.json.JsonValue> getDesiredPropertyValue()
      Returns the created desired property.
      java.util.Optional<org.eclipse.ditto.json.JsonValue> getEntity​(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)  
      ThingId getEntityId()  
      java.lang.String getFeatureId()
      Returns the ID of the Feature whose desired properties were modified.
      org.eclipse.ditto.json.JsonPointer getResourcePath()  
      org.eclipse.ditto.base.model.json.JsonSchemaVersion[] getSupportedSchemaVersions()
      ModifyFeatureDesiredPropertyResponse is only available in JsonSchemaVersion V_2.
      int hashCode()  
      static ModifyFeatureDesiredPropertyResponse modified​(ThingId thingId, java.lang.CharSequence featureId, org.eclipse.ditto.json.JsonPointer desiredPropertyPointer, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Returns a new ModifyFeatureDesiredPropertyResponse for a modified desired property.
      ModifyFeatureDesiredPropertyResponse setDittoHeaders​(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)  
      java.lang.String toString()  

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

        getDittoHeaders, getHttpStatus, getManifest, getType, toJson

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

        getImplementedSchemaVersion, getResponseType, isOfExpectedResponseType, toJson, toJson

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

        getLatestSchemaVersion, implementsSchemaVersion, implementsSchemaVersion, toJsonString

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

        toJson, toJsonString, toJsonString

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

        getName

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

        getDittoHeaders

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

        getHttpStatus

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

        getManifest

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

        getEntity

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

        getType

    • Field Detail

    • Method Detail

      • created

        public static ModifyFeatureDesiredPropertyResponse created​(ThingId thingId,
                                                           java.lang.CharSequence featureId,
                                                           org.eclipse.ditto.json.JsonPointer desiredPropertyPointer,
                                                           org.eclipse.ditto.json.JsonValue desiredValue,
                                                           org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Returns a new ModifyFeatureDesiredPropertyResponse for a created desired property. This corresponds to the HTTP status HttpStatus.CREATED.
        Parameters:
        thingId - the Thing ID of the created desired property.
        featureId - the Feature's ID whose desired property was created.
        desiredPropertyPointer - the pointer of the created desired property.
        desiredValue - the created desired property's value.
        dittoHeaders - the headers of the ThingCommand which caused the new response.
        Returns:
        a command response for a created desired property.
        Throws:
        java.lang.NullPointerException - if any argument is null.

      • modified

        public static ModifyFeatureDesiredPropertyResponse modified​(ThingId thingId,
                                                            java.lang.CharSequence featureId,
                                                            org.eclipse.ditto.json.JsonPointer desiredPropertyPointer,
                                                            org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Returns a new ModifyFeatureDesiredPropertyResponse for a modified desired property. This corresponds to the HTTP status HttpStatus.NO_CONTENT.
        Parameters:
        thingId - the Thing ID of the modified desired property.
        featureId - the Feature's ID whose desired property was modified.
        desiredPropertyPointer - the pointer of the modified desired property.
        dittoHeaders - the headers of the ThingCommand which caused the new response.
        Returns:
        a command response for a modified desired property.
        Throws:
        java.lang.NullPointerException - if any argument is null.

      • fromJson

        public static ModifyFeatureDesiredPropertyResponse fromJson​(java.lang.String jsonString,
                                                            org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Creates a response to a ModifyFeatureDesiredProperty 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:
        java.lang.NullPointerException - if any argument is null.
        java.lang.IllegalArgumentException - if jsonString is empty.
        org.eclipse.ditto.json.JsonParseException - if the passed in jsonString was not in the expected format.
        org.eclipse.ditto.json.JsonKeyInvalidException - if keys of the desired property pointer are not valid according to pattern RegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN.

      • fromJson

        public static ModifyFeatureDesiredPropertyResponse fromJson​(org.eclipse.ditto.json.JsonObject jsonObject,
                                                            org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Creates a response to a ModifyFeatureDesiredProperty 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:
        java.lang.NullPointerException - if any argument is null.
        org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected format.
        org.eclipse.ditto.json.JsonKeyInvalidException - if keys of the desired property pointer are not valid according to pattern RegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN.

      • getDesiredPropertyPointer

        public org.eclipse.ditto.json.JsonPointer getDesiredPropertyPointer()
        Returns the pointer of the modified desired property.
        Returns:
        the the pointer of the modified desired property.

      • getFeatureId

        public java.lang.String getFeatureId()
        Returns the ID of the Feature whose desired properties were modified.
        Returns:
        the ID.

      • getDesiredPropertyValue

        public java.util.Optional<org.eclipse.ditto.json.JsonValue> getDesiredPropertyValue()
        Returns the created desired property.
        Returns:
        the created desired property.

      • getEntity

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

      • getSupportedSchemaVersions

        public org.eclipse.ditto.base.model.json.JsonSchemaVersion[] getSupportedSchemaVersions()
        ModifyFeatureDesiredPropertyResponse is only available in JsonSchemaVersion V_2.
        Specified by:
        getSupportedSchemaVersions in interface org.eclipse.ditto.base.model.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>
        Returns:
        the supported JsonSchemaVersions.

      • getResourcePath

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

      • appendPayload

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

      • canEqual

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

      • equals

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

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<ModifyFeatureDesiredPropertyResponse>