Class RetrieveThings
- java.lang.Object
-
- org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveThings>
-
- org.eclipse.ditto.signals.commands.things.query.RetrieveThings
-
- All Implemented Interfaces:
org.eclipse.ditto.model.base.entity.type.WithEntityType
,org.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveThings>
,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<RetrieveThings>
,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<RetrieveThings>
,org.eclipse.ditto.signals.commands.base.WithNamespace
,ThingQueryCommand<RetrieveThings>
,ThingCommand<RetrieveThings>
@Immutable public final class RetrieveThings extends org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveThings> implements ThingQueryCommand<RetrieveThings>, org.eclipse.ditto.signals.commands.base.WithNamespace
Command which retrieves severalThing
s based on the the passed in List of Thing IDs.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RetrieveThings.Builder
Builder to facilitate creation ofRetrieveThings
instances.-
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>
-
Nested classes/interfaces inherited from interface org.eclipse.ditto.signals.commands.things.ThingCommand
ThingCommand.JsonFields
-
-
Field Summary
Fields Modifier and Type Field Description static org.eclipse.ditto.json.JsonFieldDefinition<org.eclipse.ditto.json.JsonArray>
JSON_THING_IDS
static String
NAME
Name of the "Retrieve Things" command.static String
TYPE
Type of this command.-
Fields inherited from interface org.eclipse.ditto.signals.commands.things.ThingCommand
RESOURCE_TYPE, TYPE_PREFIX
-
-
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 RetrieveThings
fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newRetrieveThings
from a JSON string.static RetrieveThings
fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newRetrieveThings
from a JSON object.static RetrieveThings.Builder
getBuilder(String... thingIds)
Deprecated.Thing IDs are now typed.static RetrieveThings.Builder
getBuilder(List<org.eclipse.ditto.model.things.ThingId> thingIds)
Returns a builder for a command for retrieving the Things.static RetrieveThings.Builder
getBuilder(org.eclipse.ditto.model.things.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.Optional<String>
getNamespace()
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()
List<org.eclipse.ditto.model.things.ThingId>
getThingEntityIds()
Returns an unmodifiable unsorted List of the identifiers of theThing
s to be retrieved.List<String>
getThingIds()
Deprecated.the thing ID is now typed.int
hashCode()
RetrieveThings
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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
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.commands.things.ThingCommand
getEntityId, getEntityType, getResourceType, getTypePrefix
-
Methods inherited from interface org.eclipse.ditto.signals.commands.things.query.ThingQueryCommand
getCategory
-
-
-
-
Field Detail
-
NAME
public static final String NAME
Name of the "Retrieve Things" command.- See Also:
- Constant Field Values
-
TYPE
public static final String TYPE
Type of this command.- See Also:
- Constant Field Values
-
JSON_THING_IDS
public static final org.eclipse.ditto.json.JsonFieldDefinition<org.eclipse.ditto.json.JsonArray> JSON_THING_IDS
-
-
Method Detail
-
getBuilder
@Deprecated public static RetrieveThings.Builder getBuilder(String... thingIds)
Deprecated.Thing IDs are now typed. UsegetBuilder(org.eclipse.ditto.model.things.ThingId...)
instead.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
- ifthingIds
isnull
.
-
getBuilder
public static RetrieveThings.Builder getBuilder(org.eclipse.ditto.model.things.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
- ifthingIds
isnull
.
-
getBuilder
public static RetrieveThings.Builder getBuilder(List<org.eclipse.ditto.model.things.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
- ifthingIds
isnull
.
-
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
- aRetrieveThings
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.model.base.headers.DittoHeaders dittoHeaders)
Creates a newRetrieveThings
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
- ifjsonString
isnull
.IllegalArgumentException
- ifjsonString
is empty.org.eclipse.ditto.json.JsonParseException
- if the passed injsonString
was not in the expected format.
-
fromJson
public static RetrieveThings fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newRetrieveThings
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
- ifjsonObject
isnull
.org.eclipse.ditto.json.JsonParseException
- if the passed injsonObject
was not in the expected format.
-
getThingIds
@Deprecated public List<String> getThingIds()
Deprecated.the thing ID is now typed. UsegetThingEntityIds()
instead.Returns an unmodifiable unsorted List of the identifiers of theThing
s to be retrieved.- Returns:
- the identifiers of the Things.
-
getThingEntityIds
public List<org.eclipse.ditto.model.things.ThingId> getThingEntityIds()
Returns an unmodifiable unsorted List of the identifiers of theThing
s to be retrieved.- Returns:
- the identifiers of the Things.
-
getNamespace
public Optional<String> getNamespace()
- Specified by:
getNamespace
in interfaceorg.eclipse.ditto.signals.commands.base.WithNamespace
-
getSelectedFields
public Optional<org.eclipse.ditto.json.JsonFieldSelector> getSelectedFields()
Description copied from interface:ThingQueryCommand
Returns the selected fields which are to be included in the JSON of the retrieved entity.- Specified by:
getSelectedFields
in interfaceThingQueryCommand<RetrieveThings>
- Returns:
- the selected fields.
-
getThingEntityId
public org.eclipse.ditto.model.things.ThingId getThingEntityId()
- Specified by:
getThingEntityId
in interfaceorg.eclipse.ditto.model.things.WithThingId
-
getResourcePath
public org.eclipse.ditto.json.JsonPointer getResourcePath()
- Specified by:
getResourcePath
in interfaceorg.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 classorg.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveThings>
-
setDittoHeaders
public RetrieveThings setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.signals.commands.base.Command<RetrieveThings>
- Specified by:
setDittoHeaders
in interfaceThingCommand<RetrieveThings>
- Specified by:
setDittoHeaders
in interfaceThingQueryCommand<RetrieveThings>
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveThings>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveThings>
-
equals
public boolean equals(@Nullable Object obj)
- Overrides:
equals
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveThings>
-
canEqual
protected boolean canEqual(@Nullable Object other)
- Overrides:
canEqual
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveThings>
-
toString
public String toString()
- Overrides:
toString
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveThings>
-
-