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

Class RetrieveThingResponse

    • 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)  
      boolean equals​(java.lang.Object o)  
      static RetrieveThingResponse fromJson​(java.lang.String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThing command from a JSON string.
      static RetrieveThingResponse fromJson​(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThing command from a JSON object.
      org.eclipse.ditto.json.JsonObject getEntity​(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)  
      ThingId getEntityId()  
      java.util.Optional<java.lang.String> getEntityPlainString()  
      org.eclipse.ditto.json.JsonPointer getResourcePath()  
      Thing getThing()
      Returns the retrieved Thing.
      int hashCode()  
      static RetrieveThingResponse of​(ThingId thingId, java.lang.String thingPlainJson, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThing command.
      static RetrieveThingResponse of​(ThingId thingId, org.eclipse.ditto.json.JsonObject thing, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThing command.
      static RetrieveThingResponse of​(ThingId thingId, Thing thing, org.eclipse.ditto.json.JsonFieldSelector fieldSelector, java.util.function.Predicate<org.eclipse.ditto.json.JsonField> predicate, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThing command.
      RetrieveThingResponse setDittoHeaders​(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)  
      RetrieveThingResponse setEntity​(org.eclipse.ditto.json.JsonValue entity)  
      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, 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.base.model.headers.WithDittoHeaders

        getDittoHeaders

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

        getEntity

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

    • Method Detail

      • of

        public static RetrieveThingResponse of​(ThingId thingId,
                                       org.eclipse.ditto.json.JsonObject thing,
                                       org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Creates a response to a RetrieveThing command.
        Parameters:
        thingId - the Thing ID of the retrieved Thing.
        thing - the retrieved Thing.
        dittoHeaders - the headers of the preceding command.
        Returns:
        the response.
        Throws:
        java.lang.NullPointerException - if any argument is null.

      • of

        public static RetrieveThingResponse of​(ThingId thingId,
                                       java.lang.String thingPlainJson,
                                       org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Creates a response to a RetrieveThing command.
        Parameters:
        thingId - the Thing ID of the retrieved Thing.
        thingPlainJson - the retrieved Thing as plain JSON.
        dittoHeaders - the headers of the preceding command.
        Returns:
        the response.
        Throws:
        java.lang.NullPointerException - if any argument is null.

      • of

        public static RetrieveThingResponse of​(ThingId thingId,
                                       Thing thing,
                                       @Nullable
                                       org.eclipse.ditto.json.JsonFieldSelector fieldSelector,
                                       @Nullable
                                       java.util.function.Predicate<org.eclipse.ditto.json.JsonField> predicate,
                                       org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Creates a response to a RetrieveThing command.
        Parameters:
        thingId - the Thing ID of the retrieved Thing.
        thing - the retrieved Thing.
        fieldSelector - the JsonFieldSelector to apply to the passed thing when transforming to JSON.
        predicate - the predicate to apply to the things when transforming to JSON.
        dittoHeaders - the headers of the preceding command.
        Returns:
        the response.
        Throws:
        java.lang.NullPointerException - if any argument is null.

      • fromJson

        public static RetrieveThingResponse fromJson​(java.lang.String jsonString,
                                             org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Creates a response to a RetrieveThing 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.

      • fromJson

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

      • getThing

        public Thing getThing()
        Returns the retrieved Thing.
        Returns:
        the retrieved Thing.

      • getEntityPlainString

        public java.util.Optional<java.lang.String> getEntityPlainString()
        Specified by:
        getEntityPlainString in interface org.eclipse.ditto.base.model.signals.commands.WithEntity<RetrieveThingResponse>

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

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

      • canEqual

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

      • equals

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

      • hashCode

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

      • toString

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