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

Class RetrieveThings

java.lang.Object
org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveThings>
org.eclipse.ditto.things.model.signals.commands.query.RetrieveThings
All Implemented Interfaces:
org.eclipse.ditto.base.model.headers.DittoHeadersSettable<RetrieveThings>, 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.Command<RetrieveThings>, org.eclipse.ditto.base.model.signals.commands.WithNamespace, org.eclipse.ditto.base.model.signals.commands.WithSelectedFields, org.eclipse.ditto.base.model.signals.Signal<RetrieveThings>, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType
@Immutable public final class RetrieveThings extends org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveThings> implements org.eclipse.ditto.base.model.signals.commands.WithNamespace, org.eclipse.ditto.base.model.signals.commands.WithSelectedFields
Command which retrieves several Things based on the the passed in List of Thing IDs.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RetrieveThings.Builder
    Builder to facilitate creation of RetrieveThings instances.

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

    org.eclipse.ditto.base.model.signals.commands.Command.Category, org.eclipse.ditto.base.model.signals.commands.Command.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>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.eclipse.ditto.json.JsonFieldDefinition<org.eclipse.ditto.json.JsonArray>
    JSON_THING_IDS
     
    static final String
    NAME
    Name of the "Retrieve Things" command.
    static final String
    RESOURCE_TYPE
    Thing resource type.
    static final String
    TYPE
    Type of this command.

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

    TYPE_QUALIFIER

    Fields inherited from interface org.eclipse.ditto.base.model.signals.Signal

    CHANNEL_LIVE, CHANNEL_TWIN

    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 obj)
     
    static RetrieveThings
    fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a new RetrieveThings from a JSON string.
    static RetrieveThings
    fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a new RetrieveThings from a JSON object.
    static RetrieveThings.Builder
    getBuilder(List<ThingId> thingIds)
    Returns a builder for a command for retrieving the Things.
    static RetrieveThings.Builder
    getBuilder(RetrieveThings retrieveThings)
    Returns a builder for a command for retrieving Things.
    static RetrieveThings.Builder
    getBuilder(ThingId... thingIds)
    Returns a builder for a command for retrieving the Things.
    org.eclipse.ditto.base.model.signals.commands.Command.Category
    getCategory()
     
    List<ThingId>
    getEntityIds()
    Returns an unmodifiable unsorted List of the identifiers of the Things to be retrieved.
    Optional<String>
    getNamespace()
     
    org.eclipse.ditto.json.JsonPointer
    getResourcePath()
     
    String
    getResourceType()
     
    Optional<org.eclipse.ditto.json.JsonFieldSelector>
    getSelectedFields()
     
    String
    getTypePrefix()
     
    int
    hashCode()
     
    RetrieveThings
    setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
     
    String
    toString()
     

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

    getDittoHeaders, 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.Command

    getImplementedSchemaVersion, 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

  • Field Details

    • NAME

      public static final String NAME
      Name of the "Retrieve Things" command.
      See Also:

    • RESOURCE_TYPE

      public static final String RESOURCE_TYPE
      Thing resource type.

    • TYPE

      public static final String TYPE
      Type of this command.
      See Also:

    • JSON_THING_IDS

      public static final org.eclipse.ditto.json.JsonFieldDefinition<org.eclipse.ditto.json.JsonArray> JSON_THING_IDS

  • Method Details

    • getBuilder

      public static RetrieveThings.Builder getBuilder(ThingId... thingIds)
      Returns a builder for a command for retrieving the Things.
      Parameters:
      thingIds - one or more Thing IDs to be retrieved.
      Returns:
      a builder for a Thing retrieving command.
      Throws:
      NullPointerException - if thingIds is null.

    • getBuilder

      public static RetrieveThings.Builder getBuilder(List<ThingId> thingIds)
      Returns a builder for a command for retrieving the Things.
      Parameters:
      thingIds - the Thing IDs to be retrieved.
      Returns:
      a builder for a Thing retrieving command.
      Throws:
      NullPointerException - if thingIds is null.

    • getBuilder

      public static RetrieveThings.Builder getBuilder(RetrieveThings retrieveThings)
      Returns a builder for a command for retrieving Things. The builder gets initialised with the data from the specified RetrieveThings.
      Parameters:
      retrieveThings - a RetrieveThings object which acts as template for the new builder.
      Returns:
      a builder for a Thing retrieving command.

    • fromJson

      public static RetrieveThings fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new RetrieveThings 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 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 RetrieveThings fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new RetrieveThings 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 jsonObject is null.
      org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected format.

    • getEntityIds

      public List<ThingId> getEntityIds()
      Returns an unmodifiable unsorted List of the identifiers of the Things to be retrieved.
      Returns:
      the identifiers of the Things.

    • getNamespace

      public Optional<String> getNamespace()
      Specified by:
      getNamespace in interface org.eclipse.ditto.base.model.signals.commands.WithNamespace

    • getSelectedFields

      public Optional<org.eclipse.ditto.json.JsonFieldSelector> getSelectedFields()
      Specified by:
      getSelectedFields in interface org.eclipse.ditto.base.model.signals.commands.WithSelectedFields

    • getResourcePath

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

    • getResourceType

      public String getResourceType()
      Specified by:
      getResourceType 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.AbstractCommand<RetrieveThings>

    • getTypePrefix

      public String getTypePrefix()
      Specified by:
      getTypePrefix in interface org.eclipse.ditto.base.model.signals.commands.Command<RetrieveThings>

    • getCategory

      public org.eclipse.ditto.base.model.signals.commands.Command.Category getCategory()
      Specified by:
      getCategory in interface org.eclipse.ditto.base.model.signals.commands.Command<RetrieveThings>

    • setDittoHeaders

      public RetrieveThings setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.signals.commands.Command<RetrieveThings>
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.headers.DittoHeadersSettable<RetrieveThings>

    • hashCode

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

    • equals

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

    • canEqual

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

    • toString

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