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

Class RetrieveFeatureResponse

java.lang.Object

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

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

All Implemented Interfaces:

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

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

Response to a RetrieveFeature command.

Nested Class Summary

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

ThingCommandResponse.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 String	TYPE Type of this response.

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

TYPE_PREFIX

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

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 o)
static RetrieveFeatureResponse	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a response to a RetrieveFeature command from a JSON object.
static RetrieveFeatureResponse	fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a response to a RetrieveFeature command from a JSON string.
org.eclipse.ditto.json.JsonObject	getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
org.eclipse.ditto.model.things.Feature	getFeature() Returns the retrieved Feature.
String	getFeatureId() Returns the identifier of the Feature whose properties were modified.
org.eclipse.ditto.json.JsonPointer	getResourcePath()
String	getThingId()
int	hashCode()
static RetrieveFeatureResponse	of(String thingId, org.eclipse.ditto.model.things.Feature feature, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a response to a RetrieveFeature command.
static RetrieveFeatureResponse	of(String thingId, String featureId, org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a response to a RetrieveFeature command.
RetrieveFeatureResponse	setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
RetrieveFeatureResponse	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.things.ThingCommandResponse

getId, getResourceType

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

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

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

getEntity

Field Detail

TYPE

public static final String TYPE

Type of this response.

See Also:

Constant Field Values

Method Detail

of

public static RetrieveFeatureResponse of(String thingId,
                                         String featureId,
                                         @Nullable
                                         org.eclipse.ditto.json.JsonObject jsonObject,
                                         org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a response to a RetrieveFeature command.

Parameters:

thingId - the Thing ID of the retrieved feature.

featureId - the identifier of the retrieved Feature.

jsonObject - the retrieved Feature JSON.

dittoHeaders - the headers of the preceding command.

Returns:

the response.

Throws:

NullPointerException - if any argument but jsonObject is null.

of

public static RetrieveFeatureResponse of(String thingId,
                                         org.eclipse.ditto.model.things.Feature feature,
                                         org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a response to a RetrieveFeature command.

Parameters:

thingId - the Thing ID of the retrieved feature.

feature - the retrieved Feature.

dittoHeaders - the headers of the preceding command.

Returns:

the response.

Throws:

NullPointerException - if any argument is null.

fromJson

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

Creates a response to a RetrieveFeature 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 RetrieveFeatureResponse fromJson(org.eclipse.ditto.json.JsonObject jsonObject,
                                               org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a response to a RetrieveFeature 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 any argument is null.

org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected format.

getThingId

public String getThingId()

Specified by:

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

getFeatureId

public String getFeatureId()

Returns the identifier of the Feature whose properties were modified.

Returns:

the identifier.

getFeature

public org.eclipse.ditto.model.things.Feature getFeature()

Returns the retrieved Feature.

Returns:

the retrieved Feature.

getEntity

public org.eclipse.ditto.json.JsonObject getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)

Specified by:

getEntity in interface org.eclipse.ditto.signals.commands.base.WithEntity<RetrieveFeatureResponse>

setEntity

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

Specified by:

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

Specified by:

setEntity in interface ThingQueryCommandResponse<RetrieveFeatureResponse>

setDittoHeaders

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

Specified by:

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

Specified by:

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

Specified by:

setDittoHeaders in interface ThingQueryCommandResponse<RetrieveFeatureResponse>

Specified by:

setDittoHeaders in interface ThingCommandResponse<RetrieveFeatureResponse>

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

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

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

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

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

hashCode

public int hashCode()

Overrides:

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

toString

public String toString()

Overrides:

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