org.eclipse.ditto.signals.commands.things.modify

Class ModifyFeatureResponse

java.lang.Object

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

org.eclipse.ditto.signals.commands.things.modify.ModifyFeatureResponse

All Implemented Interfaces:

org.eclipse.ditto.model.base.headers.WithDittoHeaders<ModifyFeatureResponse>, 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<ModifyFeatureResponse>, org.eclipse.ditto.signals.base.WithId, org.eclipse.ditto.signals.base.WithName, org.eclipse.ditto.signals.base.WithOptionalEntity, 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<ModifyFeatureResponse>, ThingModifyCommandResponse<ModifyFeatureResponse>, ThingCommandResponse<ModifyFeatureResponse>

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

Response to a ModifyFeature 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)
static ModifyFeatureResponse	created(String thingId, org.eclipse.ditto.model.things.Feature feature, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Returns a new ModifyFeatureResponse for a created Feature.
boolean	equals(Object o)
static ModifyFeatureResponse	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a response to a ModifyFeature command from a JSON object.
static ModifyFeatureResponse	fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a response to a ModifyFeature command from a JSON string.
Optional<org.eclipse.ditto.json.JsonValue>	getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
Optional<org.eclipse.ditto.model.things.Feature>	getFeatureCreated() Returns the created Feature.
org.eclipse.ditto.json.JsonPointer	getResourcePath()
String	getThingId()
int	hashCode()
static ModifyFeatureResponse	modified(String thingId, String featureId, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Returns a new ModifyFeatureResponse for a modified Feature.
ModifyFeatureResponse	setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
String	toString()

Methods inherited from class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse

canEqual, 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.base.WithOptionalEntity

getEntity

Field Detail

TYPE

public static final String TYPE

Type of this response.

See Also:

Constant Field Values

Method Detail

created

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

Returns a new ModifyFeatureResponse for a created Feature. This corresponds to the HTTP status code HttpStatusCode.CREATED.

Parameters:

thingId - the Thing ID of the created feature.

feature - the created Feature.

dittoHeaders - the headers of the ThingCommand which caused the new response.

Returns:

a command response for a created Feature.

Throws:

NullPointerException - if any argument is null.

modified

public static ModifyFeatureResponse modified(String thingId,
                                             String featureId,
                                             org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Returns a new ModifyFeatureResponse for a modified Feature. This corresponds to the HTTP status code HttpStatusCode.NO_CONTENT.

Parameters:

thingId - the Thing ID of the modified feature.

featureId - the identifier of the modified Feature.

dittoHeaders - the headers of the ThingCommand which caused the new response.

Returns:

a command response for a modified Feature.

Throws:

NullPointerException - if any argument is null.

fromJson

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

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

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

getFeatureCreated

public Optional<org.eclipse.ditto.model.things.Feature> getFeatureCreated()

Returns the created Feature.

Returns:

the created Feature.

getEntity

public Optional<org.eclipse.ditto.json.JsonValue> getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)

Specified by:

getEntity in interface org.eclipse.ditto.signals.base.WithOptionalEntity

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

setDittoHeaders

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

Specified by:

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

Specified by:

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

Specified by:

setDittoHeaders in interface ThingModifyCommandResponse<ModifyFeatureResponse>

Specified by:

setDittoHeaders in interface ThingCommandResponse<ModifyFeatureResponse>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

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

hashCode

public int hashCode()

Overrides:

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

toString

public String toString()

Overrides:

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