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

Class RetrieveAttributes

java.lang.Object

org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveAttributes>

org.eclipse.ditto.signals.commands.things.query.RetrieveAttributes

All Implemented Interfaces:

org.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveAttributes>, 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.signals.base.Signal<RetrieveAttributes>, org.eclipse.ditto.signals.base.WithId, org.eclipse.ditto.signals.base.WithName, org.eclipse.ditto.signals.base.WithResource, org.eclipse.ditto.signals.base.WithThingId, org.eclipse.ditto.signals.base.WithType, org.eclipse.ditto.signals.commands.base.Command<RetrieveAttributes>, ThingQueryCommand<RetrieveAttributes>, ThingCommand<RetrieveAttributes>

@Immutable
public final class RetrieveAttributes
extends org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveAttributes>
implements ThingQueryCommand<RetrieveAttributes>

Command which retrieves all attributes of a Thing.

Nested Class Summary

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

ThingCommand.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>, 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>

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Name of the retrieve "Retrieve Thing Attributes" command.
static String	TYPE Type of this command.

Fields inherited from interface org.eclipse.ditto.signals.commands.things.ThingCommand

RESOURCE_TYPE, TYPE_PREFIX

Fields inherited from interface org.eclipse.ditto.signals.commands.base.Command

TYPE_QUALIFIER

Method Summary

Modifier and Type	Method and 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 obj)
static RetrieveAttributes	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new RetrieveAttributes from a JSON object.
static RetrieveAttributes	fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new RetrieveAttributes from a JSON string.
org.eclipse.ditto.json.JsonPointer	getResourcePath()
Optional<org.eclipse.ditto.json.JsonFieldSelector>	getSelectedFields() Returns the selected fields which are to be included in the JSON of the retrieved entity.
String	getThingId()
int	hashCode()
static RetrieveAttributes	of(String thingId, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Returns a command for retrieving the attributes of a Thing with the given ID.
static RetrieveAttributes	of(String thingId, org.eclipse.ditto.json.JsonFieldSelector selectedFields, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Returns a command for retrieving an attribute of a Thing with the given ID.
RetrieveAttributes	setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
String	toString()

Methods inherited from class org.eclipse.ditto.signals.commands.base.AbstractCommand

getDittoHeaders, 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.signals.commands.things.ThingCommand

getId, getResourceType, getTypePrefix

Methods inherited from interface org.eclipse.ditto.signals.commands.base.Command

getImplementedSchemaVersion, toJson, toJson

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

getName

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

toJson, toJsonString, toJsonString

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.headers.WithDittoHeaders

getDittoHeaders

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

getManifest

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

getType

Field Detail

NAME

public static final String NAME

Name of the retrieve "Retrieve Thing Attributes" command.

See Also:

Constant Field Values

TYPE

public static final String TYPE

Type of this command.

See Also:

Constant Field Values

Method Detail

of

public static RetrieveAttributes of(String thingId,
                                    org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Returns a command for retrieving the attributes of a Thing with the given ID.

Parameters:

thingId - the ID of a single Thing whose attributes will be retrieved by this command.

dittoHeaders - the headers of the command.

Returns:

a Command for retrieving attributes of the Thing with the thingId as its ID which is readable from the passed authorization context.

Throws:

NullPointerException - if dittoHeaders is null.

org.eclipse.ditto.model.things.ThingIdInvalidException - if the parsed thing ID did not comply to Thing.ID_REGEX.

of

public static RetrieveAttributes of(String thingId,
                                    @Nullable
                                    org.eclipse.ditto.json.JsonFieldSelector selectedFields,
                                    org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Returns a command for retrieving an attribute of a Thing with the given ID.

Parameters:

thingId - the ID of a single Thing whose attributes will be retrieved by this command.

selectedFields - defines the optionally selected fields.

dittoHeaders - the headers of the command.

Returns:

a Command for retrieving attributes of the Thing with the thingId as its ID which is readable from the passed authorization context.

Throws:

NullPointerException - if dittoHeaders is null.

org.eclipse.ditto.model.things.ThingIdInvalidException - if the parsed thing ID did not comply to Thing.ID_REGEX.

fromJson

public static RetrieveAttributes fromJson(String jsonString,
                                          org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a new RetrieveAttributes from a JSON string.

Parameters:

jsonString - the JSON string of which the command is to be created.

dittoHeaders - the headers of the command.

Returns:

the command.

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.

org.eclipse.ditto.model.things.ThingIdInvalidException - if the parsed thing ID did not comply to Thing.ID_REGEX.

fromJson

public static RetrieveAttributes fromJson(org.eclipse.ditto.json.JsonObject jsonObject,
                                          org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a new RetrieveAttributes from a JSON object.

Parameters:

jsonObject - the JSON object of which the command is to be created.

dittoHeaders - the headers of the command.

Returns:

the command.

Throws:

NullPointerException - if any argument is null.

org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected format.

org.eclipse.ditto.model.things.ThingIdInvalidException - if the parsed thing ID did not comply to Thing.ID_REGEX.

getSelectedFields

public Optional<org.eclipse.ditto.json.JsonFieldSelector> getSelectedFields()

Description copied from interface: ThingQueryCommand

Returns the selected fields which are to be included in the JSON of the retrieved entity.

Specified by:

getSelectedFields in interface ThingQueryCommand<RetrieveAttributes>

Returns:

the selected fields.

getThingId

public String getThingId()

Specified by:

getThingId in interface org.eclipse.ditto.signals.base.WithThingId

getResourcePath

public org.eclipse.ditto.json.JsonPointer getResourcePath()

Specified by:

getResourcePath in interface org.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 class org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveAttributes>

setDittoHeaders

public RetrieveAttributes setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Specified by:

setDittoHeaders in interface org.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveAttributes>

Specified by:

setDittoHeaders in interface org.eclipse.ditto.signals.commands.base.Command<RetrieveAttributes>

Specified by:

setDittoHeaders in interface ThingQueryCommand<RetrieveAttributes>

Specified by:

setDittoHeaders in interface ThingCommand<RetrieveAttributes>

hashCode

public int hashCode()

Overrides:

hashCode in class org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveAttributes>

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveAttributes>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveAttributes>

toString

public String toString()

Overrides:

toString in class org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveAttributes>