Class RetrieveAttributeResponse
- java.lang.Object
-
- org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveAttributeResponse>
-
- org.eclipse.ditto.signals.commands.things.query.RetrieveAttributeResponse
-
- All Implemented Interfaces:
org.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveAttributeResponse>
,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<RetrieveAttributeResponse>
,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<RetrieveAttributeResponse>
,org.eclipse.ditto.signals.commands.base.WithEntity<RetrieveAttributeResponse>
,ThingQueryCommandResponse<RetrieveAttributeResponse>
,ThingCommandResponse<RetrieveAttributeResponse>
@Immutable public final class RetrieveAttributeResponse extends org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveAttributeResponse> implements ThingQueryCommandResponse<RetrieveAttributeResponse>
Response to aRetrieveAttribute
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
All Methods Static Methods Instance Methods Concrete Methods Deprecated 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 RetrieveAttributeResponse
fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveAttribute
command from a JSON string.static RetrieveAttributeResponse
fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveAttribute
command from a JSON object.org.eclipse.ditto.json.JsonValue
getAttributeValue()
Returns the retrieved Attribute.org.eclipse.ditto.json.JsonValue
getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
org.eclipse.ditto.json.JsonPointer
getResourcePath()
org.eclipse.ditto.model.things.ThingId
getThingEntityId()
int
hashCode()
static RetrieveAttributeResponse
of(String thingId, org.eclipse.ditto.json.JsonPointer attributePointer, org.eclipse.ditto.json.JsonValue attributeValue, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Deprecated.Thing ID is now typed.static RetrieveAttributeResponse
of(org.eclipse.ditto.model.things.ThingId thingId, org.eclipse.ditto.json.JsonPointer attributePointer, org.eclipse.ditto.json.JsonValue attributeValue, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveAttribute
command.RetrieveAttributeResponse
setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
RetrieveAttributeResponse
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.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
@Deprecated public static RetrieveAttributeResponse of(String thingId, org.eclipse.ditto.json.JsonPointer attributePointer, org.eclipse.ditto.json.JsonValue attributeValue, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Deprecated.Creates a response to aRetrieveAttribute
command.- Parameters:
thingId
- the Thing ID of the retrieved attribute.attributePointer
- the JSON pointer of the attribute to retrieve.attributeValue
- the retrieved Attribute value.dittoHeaders
- the headers of the preceding command.- Returns:
- the response.
- Throws:
NullPointerException
- if any argument isnull
.org.eclipse.ditto.json.JsonKeyInvalidException
- if keys ofattributePointer
are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
of
public static RetrieveAttributeResponse of(org.eclipse.ditto.model.things.ThingId thingId, org.eclipse.ditto.json.JsonPointer attributePointer, org.eclipse.ditto.json.JsonValue attributeValue, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveAttribute
command.- Parameters:
thingId
- the Thing ID of the retrieved attribute.attributePointer
- the JSON pointer of the attribute to retrieve.attributeValue
- the retrieved Attribute value.dittoHeaders
- the headers of the preceding command.- Returns:
- the response.
- Throws:
NullPointerException
- if any argument isnull
.org.eclipse.ditto.json.JsonKeyInvalidException
- if keys ofattributePointer
are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
fromJson
public static RetrieveAttributeResponse fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveAttribute
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 attribute pointer are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
fromJson
public static RetrieveAttributeResponse fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveAttribute
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 attribute 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
-
getAttributeValue
public org.eclipse.ditto.json.JsonValue getAttributeValue()
Returns the retrieved Attribute.- Returns:
- the retrieved Attribute.
-
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<RetrieveAttributeResponse>
-
setEntity
public RetrieveAttributeResponse setEntity(org.eclipse.ditto.json.JsonValue entity)
- Specified by:
setEntity
in interfaceThingQueryCommandResponse<RetrieveAttributeResponse>
- Specified by:
setEntity
in interfaceorg.eclipse.ditto.signals.commands.base.WithEntity<RetrieveAttributeResponse>
-
setDittoHeaders
public RetrieveAttributeResponse setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.signals.commands.base.CommandResponse<RetrieveAttributeResponse>
- Specified by:
setDittoHeaders
in interfaceThingCommandResponse<RetrieveAttributeResponse>
- Specified by:
setDittoHeaders
in interfaceThingQueryCommandResponse<RetrieveAttributeResponse>
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveAttributeResponse>
-
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<RetrieveAttributeResponse>
-
canEqual
protected boolean canEqual(@Nullable Object other)
- Overrides:
canEqual
in classorg.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveAttributeResponse>
-
equals
public boolean equals(@Nullable Object o)
- Overrides:
equals
in classorg.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveAttributeResponse>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classorg.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveAttributeResponse>
-
toString
public String toString()
- Overrides:
toString
in classorg.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveAttributeResponse>
-
-