Class RetrieveFeatureDefinitionResponse
- java.lang.Object
-
- org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeatureDefinitionResponse>
-
- org.eclipse.ditto.signals.commands.things.query.RetrieveFeatureDefinitionResponse
-
- All Implemented Interfaces:
org.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveFeatureDefinitionResponse>
,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<RetrieveFeatureDefinitionResponse>
,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<RetrieveFeatureDefinitionResponse>
,org.eclipse.ditto.signals.commands.base.WithEntity<RetrieveFeatureDefinitionResponse>
,ThingQueryCommandResponse<RetrieveFeatureDefinitionResponse>
,ThingCommandResponse<RetrieveFeatureDefinitionResponse>
@Immutable public final class RetrieveFeatureDefinitionResponse extends org.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeatureDefinitionResponse> implements ThingQueryCommandResponse<RetrieveFeatureDefinitionResponse>
Response to aRetrieveFeatureDefinition
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 RetrieveFeatureDefinitionResponse
fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDefinition
command from a JSON string.static RetrieveFeatureDefinitionResponse
fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDefinition
command from a JSON object.org.eclipse.ditto.model.things.FeatureDefinition
getDefinition()
Returns the retrieved FeatureDefinition.org.eclipse.ditto.json.JsonValue
getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
String
getFeatureId()
Returns the identifier of theFeature
for which to retrieve the Definition.org.eclipse.ditto.json.JsonPointer
getResourcePath()
org.eclipse.ditto.model.things.ThingId
getThingEntityId()
int
hashCode()
static RetrieveFeatureDefinitionResponse
of(String thingId, String featureId, org.eclipse.ditto.json.JsonArray definitionJsonArray, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Deprecated.Thing ID is now typed.static RetrieveFeatureDefinitionResponse
of(String thingId, String featureId, org.eclipse.ditto.model.things.FeatureDefinition definition, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Deprecated.Thing ID is now typed.static RetrieveFeatureDefinitionResponse
of(org.eclipse.ditto.model.things.ThingId thingId, String featureId, org.eclipse.ditto.json.JsonArray definitionJsonArray, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDefinition
command.static RetrieveFeatureDefinitionResponse
of(org.eclipse.ditto.model.things.ThingId thingId, String featureId, org.eclipse.ditto.model.things.FeatureDefinition definition, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDefinition
command.RetrieveFeatureDefinitionResponse
setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
RetrieveFeatureDefinitionResponse
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 RetrieveFeatureDefinitionResponse of(String thingId, String featureId, org.eclipse.ditto.model.things.FeatureDefinition definition, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Deprecated.Creates a response to aRetrieveFeatureDefinition
command.- Parameters:
thingId
- the Thing ID of the retrieved Feature Definition.featureId
- the identifier of the Feature whose Definition was retrieved.definition
- the retrieved FeatureDefinition.dittoHeaders
- the headers of the preceding command.- Returns:
- the response.
- Throws:
NullPointerException
- if any argument isnull
.
-
of
public static RetrieveFeatureDefinitionResponse of(org.eclipse.ditto.model.things.ThingId thingId, String featureId, org.eclipse.ditto.model.things.FeatureDefinition definition, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDefinition
command.- Parameters:
thingId
- the Thing ID of the retrieved Feature Definition.featureId
- the identifier of the Feature whose Definition was retrieved.definition
- the retrieved FeatureDefinition.dittoHeaders
- the headers of the preceding command.- Returns:
- the response.
- Throws:
NullPointerException
- if any argument isnull
.
-
of
@Deprecated public static RetrieveFeatureDefinitionResponse of(String thingId, String featureId, org.eclipse.ditto.json.JsonArray definitionJsonArray, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Deprecated.Thing ID is now typed. Useof(org.eclipse.ditto.model.things.ThingId, String, org.eclipse.ditto.json.JsonArray, org.eclipse.ditto.model.base.headers.DittoHeaders)
instead.Creates a response to aRetrieveFeatureDefinition
command.- Parameters:
thingId
- the Thing ID of the retrieved Feature Definition.featureId
- the identifier of the Feature whose Definition was retrieved.definitionJsonArray
- the retrieved FeatureDefinition JSON array.dittoHeaders
- the headers of the preceding command.- Returns:
- the response.
- Throws:
NullPointerException
- if any argument isnull
.
-
of
public static RetrieveFeatureDefinitionResponse of(org.eclipse.ditto.model.things.ThingId thingId, String featureId, org.eclipse.ditto.json.JsonArray definitionJsonArray, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDefinition
command.- Parameters:
thingId
- the Thing ID of the retrieved Feature Definition.featureId
- the identifier of the Feature whose Definition was retrieved.definitionJsonArray
- the retrieved FeatureDefinition JSON array.dittoHeaders
- the headers of the preceding command.- Returns:
- the response.
- Throws:
NullPointerException
- if any argument isnull
.
-
fromJson
public static RetrieveFeatureDefinitionResponse fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDefinition
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.JsonMissingFieldException
- if the parsedjsonString
did not contain any of the required fieldsorg.eclipse.ditto.model.things.ThingIdInvalidException
- if the parsed thing ID did not comply toRegexPatterns.ID_REGEX
.
-
fromJson
public static RetrieveFeatureDefinitionResponse fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a response to aRetrieveFeatureDefinition
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.JsonMissingFieldException
- ifjsonObject
did not contain any of the required fieldsorg.eclipse.ditto.model.things.ThingIdInvalidException
- if the parsed thing ID did not comply toRegexPatterns.ID_REGEX
.
-
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
for which to retrieve the Definition.- Returns:
- the identifier.
-
getDefinition
public org.eclipse.ditto.model.things.FeatureDefinition getDefinition()
Returns the retrieved FeatureDefinition.- Returns:
- the retrieved FeatureDefinition.
-
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<RetrieveFeatureDefinitionResponse>
-
setEntity
public RetrieveFeatureDefinitionResponse setEntity(org.eclipse.ditto.json.JsonValue entity)
- Specified by:
setEntity
in interfaceThingQueryCommandResponse<RetrieveFeatureDefinitionResponse>
- Specified by:
setEntity
in interfaceorg.eclipse.ditto.signals.commands.base.WithEntity<RetrieveFeatureDefinitionResponse>
-
setDittoHeaders
public RetrieveFeatureDefinitionResponse setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.signals.commands.base.CommandResponse<RetrieveFeatureDefinitionResponse>
- Specified by:
setDittoHeaders
in interfaceThingCommandResponse<RetrieveFeatureDefinitionResponse>
- Specified by:
setDittoHeaders
in interfaceThingQueryCommandResponse<RetrieveFeatureDefinitionResponse>
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveFeatureDefinitionResponse>
-
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<RetrieveFeatureDefinitionResponse>
-
equals
public boolean equals(@Nullable Object o)
- Overrides:
equals
in classorg.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeatureDefinitionResponse>
-
canEqual
protected boolean canEqual(@Nullable Object other)
- Overrides:
canEqual
in classorg.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeatureDefinitionResponse>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classorg.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeatureDefinitionResponse>
-
toString
public String toString()
- Overrides:
toString
in classorg.eclipse.ditto.signals.commands.base.AbstractCommandResponse<RetrieveFeatureDefinitionResponse>
-
-