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

Class RetrieveThingsResponse

java.lang.Object
org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<RetrieveThingsResponse>
org.eclipse.ditto.things.model.signals.commands.query.RetrieveThingsResponse
All Implemented Interfaces:
org.eclipse.ditto.base.model.headers.DittoHeadersSettable<RetrieveThingsResponse>, 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<RetrieveThingsResponse>, org.eclipse.ditto.base.model.signals.commands.WithEntity<RetrieveThingsResponse>, org.eclipse.ditto.base.model.signals.commands.WithHttpStatus, org.eclipse.ditto.base.model.signals.commands.WithNamespace, org.eclipse.ditto.base.model.signals.Signal<RetrieveThingsResponse>, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType
@Immutable public final class RetrieveThingsResponse extends org.eclipse.ditto.base.model.signals.commands.AbstractCommandResponse<RetrieveThingsResponse> implements org.eclipse.ditto.base.model.signals.commands.WithNamespace, org.eclipse.ditto.base.model.signals.commands.WithEntity<RetrieveThingsResponse>
Response to a RetrieveThings command.

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

  • 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.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 RetrieveThingsResponse
    fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveThings command from a JSON string.
    static RetrieveThingsResponse
    fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveThings command from a JSON object.
    org.eclipse.ditto.json.JsonValue
    getEntity(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)
     
    Optional<String>
    getEntityPlainString()
     
    Optional<String>
    getNamespace()
     
    org.eclipse.ditto.json.JsonPointer
    getResourcePath()
     
    String
    getResourceType()
     
    List<Thing>
    getThings()
    Returns the retrieved Things.
    int
    hashCode()
     
    static RetrieveThingsResponse
    newInstance(org.eclipse.ditto.json.JsonArray things, String thingsPlainJson, String namespace, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Returns a new instance of RetrieveThingsResponse for the specified arguments.
    static RetrieveThingsResponse
    of(String thingsPlainJson, String namespace, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveThings command.
    static RetrieveThingsResponse
    of(List<String> thingsPlainJson, String namespace, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveThings command.
    static RetrieveThingsResponse
    of(List<Thing> things, Predicate<org.eclipse.ditto.json.JsonField> predicate, String namespace, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveThings command.
    static RetrieveThingsResponse
    of(List<Thing> things, org.eclipse.ditto.json.JsonFieldSelector fieldSelector, Predicate<org.eclipse.ditto.json.JsonField> predicate, String namespace, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveThings command.
    static RetrieveThingsResponse
    of(org.eclipse.ditto.json.JsonArray things, String namespace, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a response to a RetrieveThings command.
    RetrieveThingsResponse
    setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
     
    RetrieveThingsResponse
    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

    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.base.model.signals.commands.WithEntity

    getEntity

  • Field Details

  • Method Details

    • of

      public static RetrieveThingsResponse of(List<String> thingsPlainJson, @Nullable String namespace, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThings command.
      Parameters:
      thingsPlainJson - the retrieved Things.
      namespace - the namespace of this search request
      dittoHeaders - the headers of the preceding command.
      Returns:
      the response.
      Throws:
      NullPointerException - if any argument is null.

    • of

      public static RetrieveThingsResponse of(String thingsPlainJson, @Nullable String namespace, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThings command.
      Parameters:
      thingsPlainJson - the retrieved Things.
      namespace - the namespace of this search request
      dittoHeaders - the headers of the preceding command.
      Returns:
      the response.
      Throws:
      NullPointerException - if thingsPlainJson or dittoHeaders is null.

    • of

      public static RetrieveThingsResponse of(org.eclipse.ditto.json.JsonArray things, @Nullable String namespace, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThings command.
      Parameters:
      things - the retrieved Things.
      namespace - the namespace of this search request.
      dittoHeaders - the headers of the preceding command.
      Returns:
      the response.
      Throws:
      NullPointerException - if things or dittoHeaders is null.

    • of

      public static RetrieveThingsResponse of(List<Thing> things, Predicate<org.eclipse.ditto.json.JsonField> predicate, @Nullable String namespace, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThings command.
      Parameters:
      things - the retrieved Things.
      predicate - the predicate to apply to the things when transforming to JSON.
      namespace - the namespace of this search request.
      dittoHeaders - the headers of the preceding command.
      Returns:
      the response.
      Throws:
      NullPointerException - if any argument but namespace is null.

    • of

      public static RetrieveThingsResponse of(List<Thing> things, @Nullable org.eclipse.ditto.json.JsonFieldSelector fieldSelector, @Nullable Predicate<org.eclipse.ditto.json.JsonField> predicate, @Nullable String namespace, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a response to a RetrieveThings command.
      Parameters:
      things - the retrieved Things.
      fieldSelector - the JsonFieldSelector to apply to the passed things when transforming to JSON.
      predicate - the predicate to apply to the things when transforming to JSON.
      namespace - the namespace of this retrieve things request
      dittoHeaders - the headers of the preceding command.
      Returns:
      the response.
      Throws:
      NullPointerException - if things or dittoHeaders is null.

    • newInstance

      public static RetrieveThingsResponse newInstance(@Nullable org.eclipse.ditto.json.JsonArray things, String thingsPlainJson, @Nullable String namespace, org.eclipse.ditto.base.model.common.HttpStatus httpStatus, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Returns a new instance of RetrieveThingsResponse for the specified arguments.
      Parameters:
      things - the retrieved Things or null if only thingsPlainJson is known.
      thingsPlainJson - the retrieved Things as JSON array string.
      namespace - the namespace of the retrieved things.
      httpStatus - the status of the response.
      dittoHeaders - the headers of the response.
      Returns:
      the RetrieveThingsResponse instance.
      Throws:
      NullPointerException - if any argument is null.
      IllegalArgumentException - if httpStatus is not allowed for a RetrieveThingsResponse.
      Since:
      2.3.0

    • fromJson

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

    • getNamespace

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

    • getThings

      public List<Thing> getThings()
      Returns the retrieved Things.
      Returns:
      the retrieved Things.

    • getEntityPlainString

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

    • getEntity

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

    • setEntity

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

    • setDittoHeaders

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

    • getResourcePath

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

    • getResourceType

      public String getResourceType()
      Specified by:
      getResourceType 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<RetrieveThingsResponse>

    • canEqual

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

    • equals

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

    • hashCode

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

    • toString

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