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

Class DeleteFeaturePropertyResponse

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

  • 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> predicate)
     
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    static DeleteFeaturePropertyResponse
    fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a DeleteFeatureProperty command from a JSON string.
    static DeleteFeaturePropertyResponse
    fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a DeleteFeatureProperty command from a JSON object.
    ThingId
    getEntityId()
     
    String
    getFeatureId()
    Returns the Feature's ID whose property was deleted.
    org.eclipse.ditto.json.JsonPointer
    getPropertyPointer()
    Returns the JSON pointer of the Property to delete.
    org.eclipse.ditto.json.JsonPointer
    getResourcePath()
     
    int
    hashCode()
     
    static DeleteFeaturePropertyResponse
    newInstance(ThingId thingId, CharSequence featureId, org.eclipse.ditto.json.JsonPointer propertyPointer, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Returns a new instance of DeleteFeaturePropertyResponse for the specified arguments.
    static DeleteFeaturePropertyResponse
    of(ThingId thingId, String featureId, org.eclipse.ditto.json.JsonPointer propertyPointer, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a DeleteFeatureProperty command.
    DeleteFeaturePropertyResponse
    setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
     
    DeleteFeaturePropertyResponse
    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, getSupportedSchemaVersions, 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, getEntity

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

    getType

  • Field Details

  • Method Details

    • of

      public static DeleteFeaturePropertyResponse of(ThingId thingId, String featureId, org.eclipse.ditto.json.JsonPointer propertyPointer, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a DeleteFeatureProperty command.
      Parameters:
      thingId - the Thing ID of the deleted feature property.
      featureId - the Feature's ID whose Property was deleted.
      propertyPointer - the JSON pointer of the deleted Property.
      dittoHeaders - the headers of the preceding command.
      Returns:
      the response.
      Throws:
      NullPointerException - if any argument is null.
      org.eclipse.ditto.json.JsonKeyInvalidException - if keys of propertyPointer are not valid according to pattern RegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN.

    • newInstance

      public static DeleteFeaturePropertyResponse newInstance(ThingId thingId, CharSequence featureId, org.eclipse.ditto.json.JsonPointer propertyPointer, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Returns a new instance of DeleteFeaturePropertyResponse for the specified arguments.
      Parameters:
      thingId - the ID of the thing the feature property was deleted from.
      featureId - ID of the feature the property was deleted from.
      propertyPointer - the JSON pointer of the deleted property.
      httpStatus - the status of the response.
      dittoHeaders - the headers of the response.
      Returns:
      the DeleteFeaturePropertyResponse instance.
      Throws:
      NullPointerException - if any argument is null.
      IllegalArgumentException - if featureId is empty or blank or if httpStatus is not allowed for a DeleteFeaturePropertyResponse.
      Since:
      2.3.0

    • fromJson

      public static DeleteFeaturePropertyResponse fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a DeleteFeatureProperty 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 - 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 property pointer are not valid according to pattern RegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN.

    • fromJson

      public static DeleteFeaturePropertyResponse fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a DeleteFeatureProperty 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 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

    • getFeatureId

      public String getFeatureId()
      Returns the Feature's ID whose property was deleted.
      Returns:
      the Feature's ID.

    • getPropertyPointer

      public org.eclipse.ditto.json.JsonPointer getPropertyPointer()
      Returns the JSON pointer of the Property to delete.
      Returns:
      the JSON pointer of the Property to delete.

    • 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> predicate)
      Specified by:
      appendPayload in class org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<DeleteFeaturePropertyResponse>

    • setDittoHeaders

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

    • setEntity

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

    • equals

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

    • canEqual

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

    • hashCode

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

    • toString

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