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

Class ModifyFeaturePropertyResponse

java.lang.Object

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

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

All Implemented Interfaces:

org.eclipse.ditto.model.base.headers.WithDittoHeaders<ModifyFeaturePropertyResponse>, 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<ModifyFeaturePropertyResponse>, 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<ModifyFeaturePropertyResponse>, ThingModifyCommandResponse<ModifyFeaturePropertyResponse>, ThingCommandResponse<ModifyFeaturePropertyResponse>

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

Response to a ModifyFeatureProperty 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)
static ModifyFeaturePropertyResponse	created(String thingId, String featureId, org.eclipse.ditto.json.JsonPointer featurePropertyPointer, org.eclipse.ditto.json.JsonValue featureValue, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Returns a new ModifyFeaturePropertyResponse for a created FeatureProperty.
boolean	equals(Object o)
static ModifyFeaturePropertyResponse	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a response to a ModifyFeatureProperty command from a JSON object.
static ModifyFeaturePropertyResponse	fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a response to a ModifyFeatureProperty command from a JSON string.
Optional<org.eclipse.ditto.json.JsonValue>	getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
String	getFeatureId() Returns the ID of the Feature whose properties were modified.
org.eclipse.ditto.json.JsonPointer	getFeaturePropertyPointer() Returns the pointer of the modified FeatureProperty.
Optional<org.eclipse.ditto.json.JsonValue>	getFeaturePropertyValue() Returns the created FeatureProperty.
org.eclipse.ditto.json.JsonPointer	getResourcePath()
String	getThingId()
int	hashCode()
static ModifyFeaturePropertyResponse	modified(String thingId, String featureId, org.eclipse.ditto.json.JsonPointer featurePropertyPointer, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Returns a new ModifyFeaturePropertyResponse for a modified FeatureProperty.
ModifyFeaturePropertyResponse	setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
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.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 ModifyFeaturePropertyResponse created(String thingId,
                                                    String featureId,
                                                    org.eclipse.ditto.json.JsonPointer featurePropertyPointer,
                                                    org.eclipse.ditto.json.JsonValue featureValue,
                                                    org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Returns a new ModifyFeaturePropertyResponse for a created FeatureProperty. This corresponds to the HTTP status code HttpStatusCode.CREATED.

Parameters:

thingId - the Thing ID of the created feature property.

featureId - the Feature's ID whose Property was created.

featurePropertyPointer - the pointer of the created FeatureProperty.

featureValue - the created FeatureProperty value.

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

Returns:

a command response for a created FeatureProperty.

Throws:

NullPointerException - if any argument is null.

modified

public static ModifyFeaturePropertyResponse modified(String thingId,
                                                     String featureId,
                                                     org.eclipse.ditto.json.JsonPointer featurePropertyPointer,
                                                     org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Returns a new ModifyFeaturePropertyResponse for a modified FeatureProperty. This corresponds to the HTTP status code HttpStatusCode.NO_CONTENT.

Parameters:

thingId - the Thing ID of the modified feature property.

featureId - the Feature's ID whose Property was modified.

featurePropertyPointer - the pointer of the modified FeatureProperty.

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

Returns:

a command response for a modified FeatureProperty.

Throws:

NullPointerException - if dittoHeaders is null.

fromJson

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

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

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

getThingId

public String getThingId()

Specified by:

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

getFeaturePropertyPointer

public org.eclipse.ditto.json.JsonPointer getFeaturePropertyPointer()

Returns the pointer of the modified FeatureProperty.

Returns:

the the pointer of the modified FeatureProperty.

getFeatureId

public String getFeatureId()

Returns the ID of the Feature whose properties were modified.

Returns:

the ID.

getFeaturePropertyValue

public Optional<org.eclipse.ditto.json.JsonValue> getFeaturePropertyValue()

Returns the created FeatureProperty.

Returns:

the created FeatureProperty.

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

setDittoHeaders

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

Specified by:

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

Specified by:

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

Specified by:

setDittoHeaders in interface ThingModifyCommandResponse<ModifyFeaturePropertyResponse>

Specified by:

setDittoHeaders in interface ThingCommandResponse<ModifyFeaturePropertyResponse>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

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

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

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

hashCode

public int hashCode()

Overrides:

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

toString

public String toString()

Overrides:

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