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

Class RetrieveFeatureResponse

java.lang.Object
org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<RetrieveFeatureResponse>
org.eclipse.ditto.things.model.signals.commands.query.RetrieveFeatureResponse
All Implemented Interfaces:
org.eclipse.ditto.base.model.entity.id.WithEntityId, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<RetrieveFeatureResponse>, 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<RetrieveFeatureResponse>, org.eclipse.ditto.base.model.signals.commands.WithEntity<RetrieveFeatureResponse>, org.eclipse.ditto.base.model.signals.commands.WithHttpStatus, org.eclipse.ditto.base.model.signals.Signal<RetrieveFeatureResponse>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<RetrieveFeatureResponse>, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType, ThingQueryCommandResponse<RetrieveFeatureResponse>, ThingCommandResponse<RetrieveFeatureResponse>, WithThingId
@Immutable public final class RetrieveFeatureResponse extends org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<RetrieveFeatureResponse> implements ThingQueryCommandResponse<RetrieveFeatureResponse>
Response to a RetrieveFeature 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 RetrieveFeatureResponse
    fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveFeature command from a JSON string.
    static RetrieveFeatureResponse
    fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveFeature command from a JSON object.
    org.eclipse.ditto.json.JsonObject
    getEntity(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)
     
    ThingId
    getEntityId()
     
    Feature
    getFeature()
    Returns the retrieved Feature.
    String
    getFeatureId()
    Returns the identifier of the Feature whose properties were modified.
    org.eclipse.ditto.json.JsonPointer
    getResourcePath()
     
    int
    hashCode()
     
    static RetrieveFeatureResponse
    newInstance(ThingId thingId, Feature feature, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Returns a new instance of RetrieveFeatureResponse for the specified arguments.
    static RetrieveFeatureResponse
    of(ThingId thingId, String featureId, org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveFeature command.
    static RetrieveFeatureResponse
    of(ThingId thingId, Feature feature, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveFeature command.
    RetrieveFeatureResponse
    setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
     
    RetrieveFeatureResponse
    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 RetrieveFeatureResponse of(ThingId thingId, String featureId, @Nullable org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveFeature command.
      Parameters:
      thingId - the Thing ID of the retrieved feature.
      featureId - the identifier of the retrieved Feature.
      jsonObject - the retrieved Feature JSON.
      dittoHeaders - the headers of the preceding command.
      Returns:
      the response.
      Throws:
      NullPointerException - if any argument but jsonObject is null.

    • of

      public static RetrieveFeatureResponse of(ThingId thingId, Feature feature, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveFeature command.
      Parameters:
      thingId - the Thing ID of the retrieved feature.
      feature - the retrieved Feature.
      dittoHeaders - the headers of the preceding command.
      Returns:
      the response.
      Throws:
      NullPointerException - if any argument is null.

    • newInstance

      public static RetrieveFeatureResponse newInstance(ThingId thingId, Feature feature, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Returns a new instance of RetrieveFeatureResponse for the specified arguments.
      Parameters:
      thingId - the ID of the thing the feature belong to.
      feature - the retrieved Feature.
      httpStatus - the status of the response.
      dittoHeaders - the headers of the response.
      Returns:
      the RetrieveFeatureResponse instance.
      Throws:
      NullPointerException - if any argument is null.
      IllegalArgumentException - if httpStatus is not allowed for a RetrieveFeatureResponse.
      Since:
      2.3.0

    • fromJson

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

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

    • getFeature

      public Feature getFeature()
      Returns the retrieved Feature.
      Returns:
      the retrieved Feature.

    • getEntity

      public org.eclipse.ditto.json.JsonObject getEntity(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)
      Specified by:
      getEntity in interface org.eclipse.ditto.base.model.signals.commands.WithEntity<RetrieveFeatureResponse>

    • setEntity

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

    • setDittoHeaders

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

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

    • canEqual

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

    • equals

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

    • hashCode

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

    • toString

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