Class RetrieveFeatureDesiredPropertyResponse
- java.lang.Object
-
- org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeatureDesiredPropertyResponse>
-
- org.eclipse.ditto.signals.commands.things.query.RetrieveFeatureDesiredPropertyResponse
-
- All Implemented Interfaces:
org.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveFeatureDesiredPropertyResponse>
,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<RetrieveFeatureDesiredPropertyResponse>
,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<RetrieveFeatureDesiredPropertyResponse>
,org.eclipse.ditto.signals.commands.base.WithEntity<RetrieveFeatureDesiredPropertyResponse>
,ThingQueryCommandResponse<RetrieveFeatureDesiredPropertyResponse>
,ThingCommandResponse<RetrieveFeatureDesiredPropertyResponse>
@Immutable public final class RetrieveFeatureDesiredPropertyResponse extends org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeatureDesiredPropertyResponse> implements ThingQueryCommandResponse<RetrieveFeatureDesiredPropertyResponse>
Response to aRetrieveFeatureDesiredProperty
command.- Since:
- 1.5.0
-
-
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
All Methods Static Methods Instance Methods Concrete Methods 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 RetrieveFeatureDesiredPropertyResponse
fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDesiredProperty
command from a JSON string.static RetrieveFeatureDesiredPropertyResponse
fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDesiredProperty
command from a JSON object.org.eclipse.ditto.json.JsonPointer
getDesiredPropertyPointer()
Returns the JSON pointer of the desired property to retrieve.org.eclipse.ditto.json.JsonValue
getDesiredPropertyValue()
Returns the retrieved desired property.org.eclipse.ditto.json.JsonValue
getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
String
getFeatureId()
Returns the identifier of theFeature
whose desired properties were modified.org.eclipse.ditto.json.JsonPointer
getResourcePath()
org.eclipse.ditto.model.base.json.JsonSchemaVersion[]
getSupportedSchemaVersions()
RetrieveFeatureDesiredPropertyResponse is only available in JsonSchemaVersion V_2.org.eclipse.ditto.model.things.ThingId
getThingEntityId()
int
hashCode()
static RetrieveFeatureDesiredPropertyResponse
of(org.eclipse.ditto.model.things.ThingId thingId, CharSequence featureId, org.eclipse.ditto.json.JsonPointer desiredPropertyPointer, org.eclipse.ditto.json.JsonValue desiredPropertyValue, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDesiredProperty
command.RetrieveFeatureDesiredPropertyResponse
setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
RetrieveFeatureDesiredPropertyResponse
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, 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.commands.things.ThingCommandResponse
getEntityId, getResourceType
-
Methods inherited from interface org.eclipse.ditto.model.base.headers.WithDittoHeaders
getDittoHeaders
-
-
-
-
Field Detail
-
TYPE
public static final String TYPE
Type of this response.- See Also:
- Constant Field Values
-
-
Method Detail
-
of
public static RetrieveFeatureDesiredPropertyResponse of(org.eclipse.ditto.model.things.ThingId thingId, CharSequence featureId, org.eclipse.ditto.json.JsonPointer desiredPropertyPointer, org.eclipse.ditto.json.JsonValue desiredPropertyValue, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDesiredProperty
command.- Parameters:
thingId
- the Thing ID of the retrieved desired property.featureId
- the identifier of the Feature whose desired property was retrieved.desiredPropertyPointer
- the retrieved desired property JSON pointer.desiredPropertyValue
- the retrieved desired property value.dittoHeaders
- the headers of the preceding command.- Returns:
- the response.
- Throws:
NullPointerException
- if any argument isnull
.org.eclipse.ditto.json.JsonKeyInvalidException
- if keys ofdesiredPropertyPointer
are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
fromJson
public static RetrieveFeatureDesiredPropertyResponse fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDesiredProperty
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
- ifjsonString
isnull
.IllegalArgumentException
- ifjsonString
is empty.org.eclipse.ditto.json.JsonParseException
- if the passed injsonString
was not in the expected format.org.eclipse.ditto.json.JsonKeyInvalidException
- if keys of the desired property pointer are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
fromJson
public static RetrieveFeatureDesiredPropertyResponse fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDesiredProperty
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
- ifjsonObject
isnull
.org.eclipse.ditto.json.JsonParseException
- if the passed injsonObject
was not in the expected format.org.eclipse.ditto.json.JsonKeyInvalidException
- if keys of the desired property pointer are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
getThingEntityId
public org.eclipse.ditto.model.things.ThingId getThingEntityId()
- Specified by:
getThingEntityId
in interfaceorg.eclipse.ditto.model.things.WithThingId
-
getFeatureId
public String getFeatureId()
Returns the identifier of theFeature
whose desired properties were modified.- Returns:
- the identifier.
-
getDesiredPropertyPointer
public org.eclipse.ditto.json.JsonPointer getDesiredPropertyPointer()
Returns the JSON pointer of the desired property to retrieve.- Returns:
- the JSON pointer of the desired property to retrieve.
-
getDesiredPropertyValue
public org.eclipse.ditto.json.JsonValue getDesiredPropertyValue()
Returns the retrieved desired property.- Returns:
- the retrieved desired property.
-
getEntity
public org.eclipse.ditto.json.JsonValue getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
- Specified by:
getEntity
in interfaceorg.eclipse.ditto.signals.commands.base.WithEntity<RetrieveFeatureDesiredPropertyResponse>
-
setEntity
public RetrieveFeatureDesiredPropertyResponse setEntity(org.eclipse.ditto.json.JsonValue entity)
- Specified by:
setEntity
in interfaceThingQueryCommandResponse<RetrieveFeatureDesiredPropertyResponse>
- Specified by:
setEntity
in interfaceorg.eclipse.ditto.signals.commands.base.WithEntity<RetrieveFeatureDesiredPropertyResponse>
-
setDittoHeaders
public RetrieveFeatureDesiredPropertyResponse setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.signals.commands.base.CommandResponse<RetrieveFeatureDesiredPropertyResponse>
- Specified by:
setDittoHeaders
in interfaceThingCommandResponse<RetrieveFeatureDesiredPropertyResponse>
- Specified by:
setDittoHeaders
in interfaceThingQueryCommandResponse<RetrieveFeatureDesiredPropertyResponse>
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveFeatureDesiredPropertyResponse>
-
getSupportedSchemaVersions
public org.eclipse.ditto.model.base.json.JsonSchemaVersion[] getSupportedSchemaVersions()
RetrieveFeatureDesiredPropertyResponse is only available in JsonSchemaVersion V_2.- Specified by:
getSupportedSchemaVersions
in interfaceorg.eclipse.ditto.model.base.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>
- Returns:
- the supported JsonSchemaVersions.
-
getResourcePath
public org.eclipse.ditto.json.JsonPointer getResourcePath()
- Specified by:
getResourcePath
in interfaceorg.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 classorg.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeatureDesiredPropertyResponse>
-
canEqual
protected boolean canEqual(@Nullable Object other)
- Overrides:
canEqual
in classorg.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeatureDesiredPropertyResponse>
-
equals
public boolean equals(@Nullable Object o)
- Overrides:
equals
in classorg.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeatureDesiredPropertyResponse>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classorg.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeatureDesiredPropertyResponse>
-
toString
public String toString()
- Overrides:
toString
in classorg.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeatureDesiredPropertyResponse>
-
-