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

Class RetrieveThingsResponse

java.lang.Object

org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveThingsResponse>

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

All Implemented Interfaces:

org.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveThingsResponse>, 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<RetrieveThingsResponse>, 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.CommandResponse<RetrieveThingsResponse>, org.eclipse.ditto.signals.commands.base.WithEntity<RetrieveThingsResponse>, org.eclipse.ditto.signals.commands.base.WithNamespace, ThingQueryCommandResponse<RetrieveThingsResponse>, ThingCommandResponse<RetrieveThingsResponse>

@Immutable
public final class RetrieveThingsResponse
extends org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveThingsResponse>
implements ThingQueryCommandResponse<RetrieveThingsResponse>, org.eclipse.ditto.signals.commands.base.WithNamespace

Response to a RetrieveThings command.

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>

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

ThingCommandResponse.JsonFields

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

Fields inherited from interface org.eclipse.ditto.signals.commands.things.ThingCommandResponse

TYPE_PREFIX

Method Summary

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 RetrieveThingsResponse	fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Creates a response to a RetrieveThings command from a JSON string.
static RetrieveThingsResponse	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Creates a response to a RetrieveThings command from a JSON object.
org.eclipse.ditto.json.JsonValue	getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
Optional<String>	getEntityPlainString()
Optional<String>	getNamespace()
org.eclipse.ditto.json.JsonPointer	getResourcePath()
org.eclipse.ditto.model.things.ThingId	getThingEntityId()
List<org.eclipse.ditto.model.things.Thing>	getThings()	Returns the retrieved Things.
int	hashCode()
static RetrieveThingsResponse	of(String thingsPlainJson, String namespace, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Creates a response to a RetrieveThings command.
static RetrieveThingsResponse	of(List<String> thingsPlainJson, String namespace, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Creates a response to a RetrieveThings command.
static RetrieveThingsResponse	of(List<org.eclipse.ditto.model.things.Thing> things, Predicate<org.eclipse.ditto.json.JsonField> predicate, String namespace, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Creates a response to a RetrieveThings command.
static RetrieveThingsResponse	of(List<org.eclipse.ditto.model.things.Thing> things, org.eclipse.ditto.json.JsonFieldSelector fieldSelector, Predicate<org.eclipse.ditto.json.JsonField> predicate, String namespace, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Creates a response to a RetrieveThings command.
static RetrieveThingsResponse	of(org.eclipse.ditto.json.JsonArray things, String namespace, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)	Creates a response to a RetrieveThings command.
RetrieveThingsResponse	setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
RetrieveThingsResponse	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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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.signals.commands.things.ThingCommandResponse

getEntityId, getResourceType

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

getDittoHeaders

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

getEntity

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

Field Detail

TYPE

public static final String TYPE

Type of this response.

See Also:

Constant Field Values

Method Detail

of

public static RetrieveThingsResponse of(List<String> thingsPlainJson,
                                        @Nullable
                                        String namespace,
                                        org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a response to a RetrieveThings command.

Parameters:

thingsPlainJson - the retrieved Things.

namespace - the namespace of this search request

dittoHeaders - the headers of the preceding command.

Returns:

the response.

Throws:

NullPointerException - if any argument is null.

of

public static RetrieveThingsResponse of(String thingsPlainJson,
                                        @Nullable
                                        String namespace,
                                        org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a response to a RetrieveThings command.

Parameters:

thingsPlainJson - the retrieved Things.

namespace - the namespace of this search request

dittoHeaders - the headers of the preceding command.

Returns:

the response.

Throws:

NullPointerException - if any argument is null.

of

public static RetrieveThingsResponse of(org.eclipse.ditto.json.JsonArray things,
                                        @Nullable
                                        String namespace,
                                        org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a response to a RetrieveThings command.

Parameters:

things - the retrieved Things.

namespace - the namespace of this search request

dittoHeaders - the headers of the preceding command.

Returns:

the response.

Throws:

NullPointerException - if any argument is null.

of

public static RetrieveThingsResponse of(List<org.eclipse.ditto.model.things.Thing> things,
                                        Predicate<org.eclipse.ditto.json.JsonField> predicate,
                                        @Nullable
                                        String namespace,
                                        org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a response to a RetrieveThings command.

Parameters:

things - the retrieved Things.

predicate - the predicate to apply to the things when transforming to JSON.

namespace - the namespace of this search request

dittoHeaders - the headers of the preceding command.

Returns:

the response.

Throws:

NullPointerException - if any argument is null.

of

public static RetrieveThingsResponse of(List<org.eclipse.ditto.model.things.Thing> things,
                                        @Nullable
                                        org.eclipse.ditto.json.JsonFieldSelector fieldSelector,
                                        @Nullable
                                        Predicate<org.eclipse.ditto.json.JsonField> predicate,
                                        @Nullable
                                        String namespace,
                                        org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a response to a RetrieveThings command.

Parameters:

things - the retrieved Things.

fieldSelector - the JsonFieldSelector to apply to the passed things when transforming to JSON.

predicate - the predicate to apply to the things when transforming to JSON.

namespace - the namespace of this retrieve things request

dittoHeaders - the headers of the preceding command.

Returns:

the response.

Throws:

NullPointerException - if any argument is null.

fromJson

public static RetrieveThingsResponse fromJson(String jsonString,
                                              org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a response to a RetrieveThings 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.

fromJson

public static RetrieveThingsResponse fromJson(org.eclipse.ditto.json.JsonObject jsonObject,
                                              org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a response to a RetrieveThings 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.

getThingEntityId

public org.eclipse.ditto.model.things.ThingId getThingEntityId()

Specified by:

getThingEntityId in interface org.eclipse.ditto.model.things.WithThingId

getNamespace

public Optional<String> getNamespace()

Specified by:

getNamespace in interface org.eclipse.ditto.signals.commands.base.WithNamespace

getThings

public List<org.eclipse.ditto.model.things.Thing> getThings()

Returns the retrieved Things.

Returns:

the retrieved Things.

getEntityPlainString

public Optional<String> getEntityPlainString()

Specified by:

getEntityPlainString in interface org.eclipse.ditto.signals.commands.base.WithEntity<RetrieveThingsResponse>

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

setEntity

public RetrieveThingsResponse setEntity(org.eclipse.ditto.json.JsonValue entity)

Specified by:

setEntity in interface ThingQueryCommandResponse<RetrieveThingsResponse>

Specified by:

setEntity in interface org.eclipse.ditto.signals.commands.base.WithEntity<RetrieveThingsResponse>

setDittoHeaders

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

Specified by:

setDittoHeaders in interface org.eclipse.ditto.signals.commands.base.CommandResponse<RetrieveThingsResponse>

Specified by:

setDittoHeaders in interface ThingCommandResponse<RetrieveThingsResponse>

Specified by:

setDittoHeaders in interface ThingQueryCommandResponse<RetrieveThingsResponse>

Specified by:

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

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

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveThingsResponse>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveThingsResponse>

hashCode

public int hashCode()

Overrides:

hashCode in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveThingsResponse>

toString

public String toString()

Overrides:

toString in class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveThingsResponse>