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

Class RetrieveFeaturePropertyResponse

java.lang.Object
org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<RetrieveFeaturePropertyResponse>
org.eclipse.ditto.things.model.signals.commands.query.RetrieveFeaturePropertyResponse
All Implemented Interfaces:
org.eclipse.ditto.base.model.entity.id.WithEntityId, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<RetrieveFeaturePropertyResponse>, 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<RetrieveFeaturePropertyResponse>, org.eclipse.ditto.base.model.signals.commands.WithEntity<RetrieveFeaturePropertyResponse>, org.eclipse.ditto.base.model.signals.commands.WithHttpStatus, org.eclipse.ditto.base.model.signals.Signal<RetrieveFeaturePropertyResponse>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<RetrieveFeaturePropertyResponse>, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType, ThingQueryCommandResponse<RetrieveFeaturePropertyResponse>, ThingCommandResponse<RetrieveFeaturePropertyResponse>, WithThingId
@Immutable public final class RetrieveFeaturePropertyResponse extends org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<RetrieveFeaturePropertyResponse> implements ThingQueryCommandResponse<RetrieveFeaturePropertyResponse>
Response to a RetrieveFeatureProperty 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> thePredicate)
     
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    static RetrieveFeaturePropertyResponse
    fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveFeatureProperty command from a JSON string.
    static RetrieveFeaturePropertyResponse
    fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveFeatureProperty command from a JSON object.
    org.eclipse.ditto.json.JsonValue
    getEntity(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)
     
    ThingId
    getEntityId()
     
    String
    getFeatureId()
    Returns the identifier of the Feature whose properties were modified.
    org.eclipse.ditto.json.JsonPointer
    getPropertyPointer()
    Returns the JSON pointer of the Property to retrieve.
    org.eclipse.ditto.json.JsonValue
    getPropertyValue()
    Returns the retrieved FeatureProperty.
    org.eclipse.ditto.json.JsonPointer
    getResourcePath()
     
    int
    hashCode()
     
    static RetrieveFeaturePropertyResponse
    newInstance(ThingId thingId, String featureId, org.eclipse.ditto.json.JsonPointer propertyPointer, org.eclipse.ditto.json.JsonValue propertyValue, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Returns a new instance of RetrieveFeaturePropertyResponse for the specified arguments.
    static RetrieveFeaturePropertyResponse
    of(ThingId thingId, String featureId, org.eclipse.ditto.json.JsonPointer featurePropertyPointer, org.eclipse.ditto.json.JsonValue featurePropertyValue, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveFeatureProperty command.
    RetrieveFeaturePropertyResponse
    setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
     
    RetrieveFeaturePropertyResponse
    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.WithEntity

    getEntity, getEntityPlainString

    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.WithType

    getType

  • Field Details

  • Method Details

    • of

      public static RetrieveFeaturePropertyResponse of(ThingId thingId, String featureId, org.eclipse.ditto.json.JsonPointer featurePropertyPointer, org.eclipse.ditto.json.JsonValue featurePropertyValue, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveFeatureProperty command.
      Parameters:
      thingId - the Thing ID of the retrieved feature property.
      featureId - the identifier of the Feature whose Property was retrieved.
      featurePropertyPointer - the retrieved FeatureProperty JSON pointer.
      featurePropertyValue - the retrieved FeatureProperty value.
      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 featurePropertyPointer are not valid according to pattern RegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN.

    • newInstance

      public static RetrieveFeaturePropertyResponse newInstance(ThingId thingId, String featureId, org.eclipse.ditto.json.JsonPointer propertyPointer, org.eclipse.ditto.json.JsonValue propertyValue, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Returns a new instance of RetrieveFeaturePropertyResponse for the specified arguments.
      Parameters:
      thingId - the ID of the thing the feature property belong to.
      featureId - the identifier of the feature whose property was retrieved.
      propertyPointer - the retrieved feature property JSON pointer.
      propertyValue - the retrieved feature property value.
      httpStatus - the status of the response.
      dittoHeaders - the headers of the response.
      Returns:
      the RetrieveFeaturePropertyResponse instance.
      Throws:
      NullPointerException - if any argument is null.
      IllegalArgumentException - if httpStatus is not allowed for a RetrieveFeaturePropertyResponse.
      org.eclipse.ditto.json.JsonKeyInvalidException - if propertyPointer is invalid.
      Since:
      2.3.0

    • fromJson

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

    • fromJson

      public static RetrieveFeaturePropertyResponse fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveFeatureProperty 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 identifier of the Feature whose properties were modified.
      Returns:
      the identifier.

    • getPropertyPointer

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

    • getPropertyValue

      public org.eclipse.ditto.json.JsonValue getPropertyValue()
      Returns the retrieved FeatureProperty.
      Returns:
      the retrieved FeatureProperty.

    • getEntity

      public 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.commands.WithEntity<RetrieveFeaturePropertyResponse>

    • setEntity

      public RetrieveFeaturePropertyResponse setEntity(org.eclipse.ditto.json.JsonValue entity)
      Specified by:
      setEntity in interface ThingQueryCommandResponse<RetrieveFeaturePropertyResponse>
      Specified by:
      setEntity in interface org.eclipse.ditto.base.model.signals.commands.WithEntity<RetrieveFeaturePropertyResponse>

    • setDittoHeaders

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

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

    • canEqual

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

    • equals

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

    • hashCode

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

    • toString

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