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

Class ModifyFeatureDesiredPropertyResponse

java.lang.Object
org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<ModifyFeatureDesiredPropertyResponse>
org.eclipse.ditto.things.model.signals.commands.modify.ModifyFeatureDesiredPropertyResponse
All Implemented Interfaces:
org.eclipse.ditto.base.model.entity.id.WithEntityId, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<ModifyFeatureDesiredPropertyResponse>, 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>, org.eclipse.ditto.base.model.signals.commands.CommandResponse<ModifyFeatureDesiredPropertyResponse>, org.eclipse.ditto.base.model.signals.commands.WithHttpStatus, org.eclipse.ditto.base.model.signals.Signal<ModifyFeatureDesiredPropertyResponse>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<ModifyFeatureDesiredPropertyResponse>, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithOptionalEntity<ModifyFeatureDesiredPropertyResponse>, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType, ThingModifyCommandResponse<ModifyFeatureDesiredPropertyResponse>, ThingCommandResponse<ModifyFeatureDesiredPropertyResponse>, WithThingId
@Immutable public final class ModifyFeatureDesiredPropertyResponse extends org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<ModifyFeatureDesiredPropertyResponse> implements ThingModifyCommandResponse<ModifyFeatureDesiredPropertyResponse>
Response to a ModifyFeatureDesiredProperty command.
Since:
1.5.0

  • 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 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 Object>

    Nested classes/interfaces inherited from interface org.eclipse.ditto.things.model.signals.commands.ThingCommandResponse

    ThingCommandResponse.JsonFields

  • Field Summary

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

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

    TYPE_QUALIFIER

    Fields inherited from interface org.eclipse.ditto.base.model.signals.Signal

    CHANNEL_LIVE, CHANNEL_TWIN

    Fields inherited from interface org.eclipse.ditto.things.model.signals.commands.ThingCommandResponse

    TYPE_PREFIX

    Fields inherited from interface org.eclipse.ditto.base.model.signals.WithType

    MESSAGES_COMMAND_RESPONSES_PREFIX, MESSAGES_COMMANDS_PREFIX, POLICY_ANNOUNCEMENT_PREFIX, THINGS_COMMAND_RESPONSES_PREFIX, THINGS_COMMANDS_PREFIX, THINGS_EVENTS_PREFIX

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    appendPayload(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion, Predicate<org.eclipse.ditto.json.JsonField> thePredicate)
     
    protected boolean
    canEqual(Object other)
     
    static ModifyFeatureDesiredPropertyResponse
    created(ThingId thingId, 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(Object o)
     
    static ModifyFeatureDesiredPropertyResponse
    fromJson(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.
    Optional<org.eclipse.ditto.json.JsonValue>
    getDesiredPropertyValue()
    Returns the created desired property.
    Optional<org.eclipse.ditto.json.JsonValue>
    getEntity(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)
     
    ThingId
    getEntityId()
     
    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, 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.
    static ModifyFeatureDesiredPropertyResponse
    newInstance(ThingId thingId, CharSequence featureId, org.eclipse.ditto.json.JsonPointer desiredPropertyPointer, org.eclipse.ditto.json.JsonValue desiredPropertyValue, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Returns a new instance of ModifyFeatureDesiredPropertyResponse for the specified arguments.
    ModifyFeatureDesiredPropertyResponse
    setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
     
    ModifyFeatureDesiredPropertyResponse
    setEntity(org.eclipse.ditto.json.JsonValue entity)
     
    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.things.model.signals.commands.ThingCommandResponse

    getResourceType

    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 Details

  • Method Details

    • created

      public static ModifyFeatureDesiredPropertyResponse created(ThingId thingId, 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:
      NullPointerException - if any argument is null.

    • modified

      public static ModifyFeatureDesiredPropertyResponse modified(ThingId thingId, 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:
      NullPointerException - if any argument is null.

    • newInstance

      public static ModifyFeatureDesiredPropertyResponse newInstance(ThingId thingId, CharSequence featureId, org.eclipse.ditto.json.JsonPointer desiredPropertyPointer, @Nullable org.eclipse.ditto.json.JsonValue desiredPropertyValue, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Returns a new instance of ModifyFeatureDesiredPropertyResponse for the specified arguments.
      Parameters:
      thingId - the ID of the thing the feature belongs to.
      featureId - ID of the feature of which the desired properties were modified.
      desiredPropertyPointer - the pointer of the created or modified desired property.
      desiredPropertyValue - the created desired property value or null if an existing one was modified.
      httpStatus - the status of the response.
      dittoHeaders - the headers of the response.
      Returns:
      the ModifyFeatureDesiredPropertyResponse instance.
      Throws:
      NullPointerException - if any argument but desiredPropertyValue is null.
      IllegalArgumentException - if featureId is empty or blank or if httpStatus is not allowed for a ModifyFeatureDesiredPropertyResponse or if httpStatus contradicts desiredPropertyValue.
      Since:
      2.3.0

    • fromJson

      public static ModifyFeatureDesiredPropertyResponse fromJson(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:
      NullPointerException - if any argument is null.
      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:
      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.

    • getEntityId

      public ThingId getEntityId()
      Specified by:
      getEntityId in interface org.eclipse.ditto.base.model.entity.id.WithEntityId
      Specified by:
      getEntityId in interface WithThingId

    • getDesiredPropertyPointer

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

    • getFeatureId

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

    • getDesiredPropertyValue

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

    • getEntity

      public 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<ModifyFeatureDesiredPropertyResponse>

    • setEntity

      public ModifyFeatureDesiredPropertyResponse setEntity(org.eclipse.ditto.json.JsonValue entity)
      Specified by:
      setEntity in interface org.eclipse.ditto.base.model.signals.WithOptionalEntity<ModifyFeatureDesiredPropertyResponse>

    • 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, Predicate<org.eclipse.ditto.json.JsonField> thePredicate)
      Specified by:
      appendPayload in class org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<ModifyFeatureDesiredPropertyResponse>

    • setDittoHeaders

      public ModifyFeatureDesiredPropertyResponse setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.signals.commands.CommandResponse<ModifyFeatureDesiredPropertyResponse>
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.headers.DittoHeadersSettable<ModifyFeatureDesiredPropertyResponse>
      Specified by:
      setDittoHeaders in interface ThingCommandResponse<ModifyFeatureDesiredPropertyResponse>
      Specified by:
      setDittoHeaders in interface ThingModifyCommandResponse<ModifyFeatureDesiredPropertyResponse>

    • canEqual

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

    • equals

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

    • hashCode

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

    • toString

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