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

Class RetrieveFeaturePropertyResponse

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.eclipse.ditto.signals.commands.base.CommandResponse

        org.eclipse.ditto.signals.commands.base.CommandResponse.JsonFields

      • Nested classes/interfaces inherited from interface org.eclipse.ditto.model.base.json.Jsonifiable

        org.eclipse.ditto.model.base.json.Jsonifiable.WithFieldSelector, org.eclipse.ditto.model.base.json.Jsonifiable.WithFieldSelectorAndPredicate<T extends Object>, org.eclipse.ditto.model.base.json.Jsonifiable.WithPointer<J extends org.eclipse.ditto.json.JsonValue>, org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate<J extends org.eclipse.ditto.json.JsonValue,​T extends Object>

    • Field Summary

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

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

        TYPE_QUALIFIER

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      protected void appendPayload​(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.model.base.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.model.base.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.model.base.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveFeatureProperty command from a JSON object.
      org.eclipse.ditto.json.JsonValue getEntity​(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)  
      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()  
      org.eclipse.ditto.model.things.ThingId getThingEntityId()  
      int hashCode()  
      static RetrieveFeaturePropertyResponse of​(String thingId, String featureId, org.eclipse.ditto.json.JsonPointer featurePropertyPointer, org.eclipse.ditto.json.JsonValue featurePropertyValue, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Deprecated.
      Thing ID is now typed.
      static RetrieveFeaturePropertyResponse of​(org.eclipse.ditto.model.things.ThingId thingId, String featureId, org.eclipse.ditto.json.JsonPointer featurePropertyPointer, org.eclipse.ditto.json.JsonValue featurePropertyValue, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveFeatureProperty command.
      RetrieveFeaturePropertyResponse setDittoHeaders​(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)  
      RetrieveFeaturePropertyResponse setEntity​(org.eclipse.ditto.json.JsonValue entity)  
      String toString()  

      • Methods inherited from class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse

        getDittoHeaders, getManifest, getStatusCode, getType, toJson

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

        getImplementedSchemaVersion, getResponseType, getStatusCode, getStatusCodeValue, isOfExpectedResponseType, toJson, toJson

      • Methods inherited from interface org.eclipse.ditto.model.base.json.Jsonifiable

        getLatestSchemaVersion, getSupportedSchemaVersions, implementsSchemaVersion, implementsSchemaVersion, toJsonString

      • Methods inherited from interface org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate

        toJson, toJsonString, toJsonString

      • Methods inherited from interface org.eclipse.ditto.signals.base.Signal

        getName

      • Methods inherited from interface org.eclipse.ditto.model.base.headers.WithDittoHeaders

        getDittoHeaders

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

        getEntity, getEntityPlainString

      • Methods inherited from interface org.eclipse.ditto.signals.base.WithId

        getId

      • Methods inherited from interface org.eclipse.ditto.model.base.headers.WithManifest

        getManifest

      • Methods inherited from interface org.eclipse.ditto.model.things.WithThingId

        getThingId

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

        getType

    • Method Detail

      • of

        public static RetrieveFeaturePropertyResponse of​(org.eclipse.ditto.model.things.ThingId thingId,
                                                 String featureId,
                                                 org.eclipse.ditto.json.JsonPointer featurePropertyPointer,
                                                 org.eclipse.ditto.json.JsonValue featurePropertyValue,
                                                 org.eclipse.ditto.model.base.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.

      • fromJson

        public static RetrieveFeaturePropertyResponse fromJson​(String jsonString,
                                                       org.eclipse.ditto.model.base.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 jsonString 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.model.base.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 jsonObject 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.

      • getThingEntityId

        public org.eclipse.ditto.model.things.ThingId getThingEntityId()
        Specified by:
        getThingEntityId in interface org.eclipse.ditto.model.things.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.model.base.json.JsonSchemaVersion schemaVersion)
        Specified by:
        getEntity in interface org.eclipse.ditto.signals.commands.base.WithEntity<RetrieveFeaturePropertyResponse>

      • getResourcePath

        public org.eclipse.ditto.json.JsonPointer getResourcePath()
        Specified by:
        getResourcePath in interface org.eclipse.ditto.signals.base.WithResource

      • appendPayload

        protected void appendPayload​(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder,
                             org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion,
                             Predicate<org.eclipse.ditto.json.JsonField> thePredicate)
        Specified by:
        appendPayload in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeaturePropertyResponse>

      • hashCode

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