Package org.eclipse.ditto.things.model.signals.commands.query

Class RetrieveWotThingDescriptionResponse

java.lang.Object
org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<RetrieveWotThingDescriptionResponse>
org.eclipse.ditto.things.model.signals.commands.query.RetrieveWotThingDescriptionResponse
All Implemented Interfaces:
org.eclipse.ditto.base.model.entity.id.WithEntityId, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<RetrieveWotThingDescriptionResponse>, org.eclipse.ditto.base.model.headers.WithDittoHeaders, org.eclipse.ditto.base.model.headers.WithManifest, org.eclipse.ditto.base.model.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate<org.eclipse.ditto.json.JsonObject,org.eclipse.ditto.json.JsonField>, org.eclipse.ditto.base.model.signals.commands.CommandResponse<RetrieveWotThingDescriptionResponse>, org.eclipse.ditto.base.model.signals.commands.WithEntity<RetrieveWotThingDescriptionResponse>, org.eclipse.ditto.base.model.signals.commands.WithHttpStatus, org.eclipse.ditto.base.model.signals.Signal<RetrieveWotThingDescriptionResponse>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<RetrieveWotThingDescriptionResponse>, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType, ThingQueryCommandResponse<RetrieveWotThingDescriptionResponse>, ThingCommandResponse<RetrieveWotThingDescriptionResponse>, WithThingId
@Immutable public final class RetrieveWotThingDescriptionResponse extends org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<RetrieveWotThingDescriptionResponse> implements ThingQueryCommandResponse<RetrieveWotThingDescriptionResponse>
Response to a RetrieveThing command with DittoHeaderDefinition.ACCEPT header being "application/td+json" requesting a WoT (Web of Things) Thing Description.
Since:
2.4.0

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.eclipse.ditto.base.model.signals.commands.CommandResponse

    org.eclipse.ditto.base.model.signals.commands.CommandResponse.JsonFields

    Nested classes/interfaces inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable

    org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelector, org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelectorAndPredicate<T extends Object>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPointer<J extends org.eclipse.ditto.json.JsonValue>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate<J extends org.eclipse.ditto.json.JsonValue,T extends Object>

    Nested classes/interfaces inherited from interface org.eclipse.ditto.things.model.signals.commands.ThingCommandResponse

    ThingCommandResponse.JsonFields

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TYPE
    Type of this response.

    Fields inherited from interface org.eclipse.ditto.base.model.signals.commands.CommandResponse

    TYPE_QUALIFIER

    Fields inherited from interface org.eclipse.ditto.base.model.signals.Signal

    CHANNEL_LIVE, CHANNEL_TWIN

    Fields inherited from interface org.eclipse.ditto.things.model.signals.commands.ThingCommandResponse

    TYPE_PREFIX

    Fields inherited from interface org.eclipse.ditto.base.model.signals.WithType

    MESSAGES_COMMAND_RESPONSES_PREFIX, MESSAGES_COMMANDS_PREFIX, POLICY_ANNOUNCEMENT_PREFIX, THINGS_COMMAND_RESPONSES_PREFIX, THINGS_COMMANDS_PREFIX, THINGS_EVENTS_PREFIX

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    appendPayload(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion, Predicate<org.eclipse.ditto.json.JsonField> thePredicate)
     
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    static RetrieveWotThingDescriptionResponse
    fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveThing command from a JSON string.
    static RetrieveWotThingDescriptionResponse
    fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveThing command from a JSON object.
    org.eclipse.ditto.json.JsonObject
    getEntity(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)
     
    ThingId
    getEntityId()
     
    Optional<String>
    getEntityPlainString()
     
    org.eclipse.ditto.json.JsonPointer
    getResourcePath()
     
    org.eclipse.ditto.json.JsonObject
    getTd()
    Returns the retrieved Thing Description.
    int
    hashCode()
     
    static RetrieveWotThingDescriptionResponse
    newInstance(ThingId thingId, org.eclipse.ditto.json.JsonObject td, String tdPlainJson, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Returns a new instance of RetrieveThingResponse for the specified arguments.
    static RetrieveWotThingDescriptionResponse
    of(ThingId thingId, String tdPlainJson, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveThing command returning the Thing Description (TD).
    static RetrieveWotThingDescriptionResponse
    of(ThingId thingId, org.eclipse.ditto.json.JsonObject td, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveThing command returning the Thing Description (TD).
    RetrieveWotThingDescriptionResponse
    setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
     
    RetrieveWotThingDescriptionResponse
    setEntity(org.eclipse.ditto.json.JsonValue entity)
     
    String
    toString()
     

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

    getDittoHeaders, getHttpStatus, getManifest, getType, toJson

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.eclipse.ditto.base.model.signals.commands.CommandResponse

    getImplementedSchemaVersion, getResponseType, isOfExpectedResponseType, toJson, toJson

    Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable

    getLatestSchemaVersion, getSupportedSchemaVersions, implementsSchemaVersion, implementsSchemaVersion, toJsonString

    Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate

    toJson, toJsonString, toJsonString

    Methods inherited from interface org.eclipse.ditto.base.model.signals.Signal

    getName

    Methods inherited from interface org.eclipse.ditto.things.model.signals.commands.ThingCommandResponse

    getResourceType

    Methods inherited from interface org.eclipse.ditto.base.model.headers.WithDittoHeaders

    getDittoHeaders

    Methods inherited from interface org.eclipse.ditto.base.model.signals.commands.WithEntity

    getEntity

    Methods inherited from interface org.eclipse.ditto.base.model.signals.commands.WithHttpStatus

    getHttpStatus

    Methods inherited from interface org.eclipse.ditto.base.model.headers.WithManifest

    getManifest

    Methods inherited from interface org.eclipse.ditto.base.model.signals.WithType

    getType

  • Field Details

  • Method Details

    • of

      public static RetrieveWotThingDescriptionResponse of(ThingId thingId, org.eclipse.ditto.json.JsonObject td, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThing command returning the Thing Description (TD).
      Parameters:
      thingId - the Thing ID of the retrieved Thing.
      td - the retrieved+calculated Thing Description.
      dittoHeaders - the headers of the preceding command.
      Returns:
      the response.
      Throws:
      NullPointerException - if any argument is null.

    • of

      public static RetrieveWotThingDescriptionResponse of(ThingId thingId, String tdPlainJson, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThing command returning the Thing Description (TD).
      Parameters:
      thingId - the Thing ID of the retrieved Thing.
      tdPlainJson - the retrieved+calculated Thing Description as plain JSON.
      dittoHeaders - the headers of the preceding command.
      Returns:
      the response.
      Throws:
      NullPointerException - if any argument is null.

    • newInstance

      public static RetrieveWotThingDescriptionResponse newInstance(ThingId thingId, @Nullable org.eclipse.ditto.json.JsonObject td, String tdPlainJson, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Returns a new instance of RetrieveThingResponse for the specified arguments.
      Parameters:
      thingId - the ID of the thing.
      td - the retrieved Thing Description or null if only tdPlainJson is available.
      tdPlainJson - the retrieved Thing Description as plain JSON string.
      httpStatus - the status of the response.
      dittoHeaders - the headers of the response.
      Returns:
      the RetrieveThingResponse instance.
      Throws:
      NullPointerException - if any argument is null.
      IllegalArgumentException - if httpStatus is not allowed for a RetrieveThingResponse.

    • fromJson

      public static RetrieveWotThingDescriptionResponse fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThing 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 RetrieveWotThingDescriptionResponse fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThing 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.

    • getEntityId

      public ThingId getEntityId()
      Specified by:
      getEntityId in interface org.eclipse.ditto.base.model.entity.id.WithEntityId
      Specified by:
      getEntityId in interface WithThingId

    • getTd

      public org.eclipse.ditto.json.JsonObject getTd()
      Returns the retrieved Thing Description.
      Returns:
      the retrieved Thing Description.

    • getEntityPlainString

      public Optional<String> getEntityPlainString()
      Specified by:
      getEntityPlainString in interface org.eclipse.ditto.base.model.signals.commands.WithEntity<RetrieveWotThingDescriptionResponse>

    • getEntity

      public org.eclipse.ditto.json.JsonObject getEntity(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)
      Specified by:
      getEntity in interface org.eclipse.ditto.base.model.signals.commands.WithEntity<RetrieveWotThingDescriptionResponse>

    • setEntity

      public RetrieveWotThingDescriptionResponse setEntity(org.eclipse.ditto.json.JsonValue entity)
      Specified by:
      setEntity in interface ThingQueryCommandResponse<RetrieveWotThingDescriptionResponse>
      Specified by:
      setEntity in interface org.eclipse.ditto.base.model.signals.commands.WithEntity<RetrieveWotThingDescriptionResponse>

    • setDittoHeaders

      public RetrieveWotThingDescriptionResponse setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.signals.commands.CommandResponse<RetrieveWotThingDescriptionResponse>
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.headers.DittoHeadersSettable<RetrieveWotThingDescriptionResponse>
      Specified by:
      setDittoHeaders in interface ThingCommandResponse<RetrieveWotThingDescriptionResponse>
      Specified by:
      setDittoHeaders in interface ThingQueryCommandResponse<RetrieveWotThingDescriptionResponse>

    • getResourcePath

      public org.eclipse.ditto.json.JsonPointer getResourcePath()
      Specified by:
      getResourcePath in interface org.eclipse.ditto.base.model.signals.WithResource

    • appendPayload

      protected void appendPayload(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion, Predicate<org.eclipse.ditto.json.JsonField> thePredicate)
      Specified by:
      appendPayload in class org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<RetrieveWotThingDescriptionResponse>

    • canEqual

      protected boolean canEqual(@Nullable Object other)
      Overrides:
      canEqual in class org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<RetrieveWotThingDescriptionResponse>

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<RetrieveWotThingDescriptionResponse>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<RetrieveWotThingDescriptionResponse>

    • toString

      public String toString()
      Overrides:
      toString in class org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<RetrieveWotThingDescriptionResponse>