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

Class RetrieveFeature

  • All Implemented Interfaces:
    org.eclipse.ditto.model.base.entity.type.WithEntityType, org.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveFeature>, org.eclipse.ditto.model.base.headers.WithManifest, org.eclipse.ditto.model.base.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>, org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate<org.eclipse.ditto.json.JsonObject,​org.eclipse.ditto.json.JsonField>, org.eclipse.ditto.model.things.WithThingId, org.eclipse.ditto.signals.base.Signal<RetrieveFeature>, org.eclipse.ditto.signals.base.WithFeatureId, org.eclipse.ditto.signals.base.WithId, org.eclipse.ditto.signals.base.WithName, org.eclipse.ditto.signals.base.WithResource, org.eclipse.ditto.signals.base.WithType, org.eclipse.ditto.signals.commands.base.Command<RetrieveFeature>, ThingQueryCommand<RetrieveFeature>, ThingCommand<RetrieveFeature>
    @Immutable
public final class RetrieveFeature
extends org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveFeature>
implements ThingQueryCommand<RetrieveFeature>, org.eclipse.ditto.signals.base.WithFeatureId
    Command which retrieves one Feature based on the passed in Feature ID.

    • Nested Class Summary

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

        org.eclipse.ditto.signals.commands.base.Command.Category, org.eclipse.ditto.signals.commands.base.Command.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 NAME
      Name of the "Retrieve Feature" command.
      static String TYPE
      Type of this command.

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

        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 obj)  
      static RetrieveFeature fromJson​(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Creates a new RetrieveFeature from a JSON string.
      static RetrieveFeature fromJson​(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Creates a new RetrieveFeature from a JSON object.
      String getFeatureId()  
      org.eclipse.ditto.json.JsonPointer getResourcePath()  
      Optional<org.eclipse.ditto.json.JsonFieldSelector> getSelectedFields()
      Returns the selected fields which are to be included in the JSON of the retrieved entity.
      org.eclipse.ditto.model.things.ThingId getThingEntityId()  
      int hashCode()  
      static RetrieveFeature of​(String thingId, String featureId, org.eclipse.ditto.json.JsonFieldSelector selectedFields, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Deprecated.
      Thing ID is now typed.
      static RetrieveFeature of​(String thingId, String featureId, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Deprecated.
      Thing ID is now typed.
      static RetrieveFeature of​(org.eclipse.ditto.model.things.ThingId thingId, String featureId, org.eclipse.ditto.json.JsonFieldSelector selectedFields, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Returns a Command for retrieving a Feature with the given ID of a Thing.
      static RetrieveFeature of​(org.eclipse.ditto.model.things.ThingId thingId, String featureId, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Returns a Command for retrieving a Feature with the given ID of a Thing.
      RetrieveFeature setDittoHeaders​(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)  
      String toString()  

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

        getDittoHeaders, getManifest, getType, toJson

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

        getImplementedSchemaVersion, 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.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 RetrieveFeature of​(org.eclipse.ditto.model.things.ThingId thingId,
                                 String featureId,
                                 org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
        Returns a Command for retrieving a Feature with the given ID of a Thing.
        Parameters:
        thingId - the ID of a Thing whose Feature to be retrieved by this command.
        featureId - the ID of the a single Feature to be retrieved by this command.
        dittoHeaders - the headers of the command.
        Returns:
        a Command for retrieving the Feature with the featureId as its ID.
        Throws:
        NullPointerException - if any argument but dittoHeaders is null.

      • of

        public static RetrieveFeature of​(org.eclipse.ditto.model.things.ThingId thingId,
                                 String featureId,
                                 @Nullable
                                 org.eclipse.ditto.json.JsonFieldSelector selectedFields,
                                 org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
        Returns a Command for retrieving a Feature with the given ID of a Thing.
        Parameters:
        thingId - the ID of a Thing whose Feature to be retrieved by this command.
        featureId - the ID of the a single Feature to be retrieved by this command.
        selectedFields - defines the fields of the JSON representation of the Feature to retrieve.
        dittoHeaders - the headers of the command.
        Returns:
        a Command for retrieving the Feature with the featureId as its ID.
        Throws:
        NullPointerException - if featureId or dittoHeaders is null.

      • fromJson

        public static RetrieveFeature fromJson​(String jsonString,
                                       org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
        Creates a new RetrieveFeature from a JSON string.
        Parameters:
        jsonString - the JSON string of which the command is to be created.
        dittoHeaders - the headers of the command.
        Returns:
        the command.
        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.model.things.ThingIdInvalidException - if the parsed thing ID did not comply to RegexPatterns.ID_REGEX.

      • fromJson

        public static RetrieveFeature fromJson​(org.eclipse.ditto.json.JsonObject jsonObject,
                                       org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
        Creates a new RetrieveFeature from a JSON object.
        Parameters:
        jsonObject - the JSON object of which the command is to be created.
        dittoHeaders - the headers of the command.
        Returns:
        the command.
        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.model.things.ThingIdInvalidException - if the parsed thing ID did not comply to RegexPatterns.ID_REGEX.

      • getThingEntityId

        public org.eclipse.ditto.model.things.ThingId getThingEntityId()
        Specified by:
        getThingEntityId in interface org.eclipse.ditto.model.things.WithThingId

      • getFeatureId

        public String getFeatureId()
        Specified by:
        getFeatureId in interface org.eclipse.ditto.signals.base.WithFeatureId

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

      • hashCode

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

      • equals

        public boolean equals​(@Nullable
                      Object obj)
        Overrides:
        equals in class org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveFeature>

      • canEqual

        protected boolean canEqual​(@Nullable
                           Object other)
        Overrides:
        canEqual in class org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveFeature>

      • toString

        public String toString()
        Overrides:
        toString in class org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveFeature>