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

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.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.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.WithThingId, 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 several Things based on the the passed in List of Thing IDs.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface org.eclipse.ditto.signals.commands.things.ThingCommand

ThingCommand.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>, 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>

Field Summary

Fields

Modifier and Type	Field and 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

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

TYPE_QUALIFIER

Method Summary

Modifier and Type	Method and 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(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new RetrieveThings from a JSON object.
static RetrieveThings	fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new RetrieveThings from a JSON string.
static RetrieveThings.Builder	getBuilder(List<String> 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(String... thingIds) Returns a builder for a command for retrieving the 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.
String	getThingId()
List<String>	getThingIds() Returns an unmodifiable unsorted List of the identifiers of the Things to be retrieved.
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.things.ThingCommand

getId, getResourceType, getTypePrefix

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

getImplementedSchemaVersion, toJson, toJson

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

getName

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

toJson, toJsonString, toJsonString

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.headers.WithDittoHeaders

getDittoHeaders

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

getManifest

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

getType

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

public static RetrieveThings.Builder getBuilder(String... 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 authorizationContext is null.

getBuilder

public static RetrieveThings.Builder getBuilder(List<String> 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 authorizationContext 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.

Throws:

NullPointerException - if authorizationContext is null.

fromJson

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

getThingIds

public List<String> getThingIds()

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.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 interface ThingQueryCommand<RetrieveThings>

Returns:

the selected fields.

getThingId

public String getThingId()

Specified by:

getThingId in interface org.eclipse.ditto.signals.base.WithThingId

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<RetrieveThings>

setDittoHeaders

public RetrieveThings setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Specified by:

setDittoHeaders in interface org.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveThings>

Specified by:

setDittoHeaders in interface org.eclipse.ditto.signals.commands.base.Command<RetrieveThings>

Specified by:

setDittoHeaders in interface ThingQueryCommand<RetrieveThings>

Specified by:

setDittoHeaders in interface ThingCommand<RetrieveThings>

hashCode

public int hashCode()

Overrides:

hashCode in class org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveThings>

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveThings>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveThings>

toString

public String toString()

Overrides:

toString in class org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveThings>