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

Interface ThingCommand<T extends ThingCommand<T>>

Type Parameters:

T - the type of the implementing class.

All Superinterfaces:

org.eclipse.ditto.base.model.signals.commands.Command<T>, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<T>, 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.Signal<T>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<T>, org.eclipse.ditto.base.model.headers.WithDittoHeaders, org.eclipse.ditto.base.model.entity.id.WithEntityId, org.eclipse.ditto.base.model.entity.type.WithEntityType, org.eclipse.ditto.base.model.headers.WithManifest, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithResource, WithThingId, org.eclipse.ditto.base.model.signals.WithType

All Known Subinterfaces:

ThingModifyCommand<T>, ThingQueryCommand<T>

All Known Implementing Classes:

CreateThing, DeleteAttribute, DeleteAttributes, DeleteFeature, DeleteFeatureDefinition, DeleteFeatureDesiredProperties, DeleteFeatureDesiredProperty, DeleteFeatureProperties, DeleteFeatureProperty, DeleteFeatures, DeleteThing, DeleteThingDefinition, MergeThing, ModifyAttribute, ModifyAttributes, ModifyFeature, ModifyFeatureDefinition, ModifyFeatureDesiredProperties, ModifyFeatureDesiredProperty, ModifyFeatureProperties, ModifyFeatureProperty, ModifyFeatures, ModifyPolicyId, ModifyThing, ModifyThingDefinition, RetrieveAttribute, RetrieveAttributes, RetrieveFeature, RetrieveFeatureDefinition, RetrieveFeatureDesiredProperties, RetrieveFeatureDesiredProperty, RetrieveFeatureProperties, RetrieveFeatureProperty, RetrieveFeatures, RetrievePolicyId, RetrieveThing, RetrieveThingDefinition

public interface ThingCommand<T extends ThingCommand<T>>
extends org.eclipse.ditto.base.model.signals.commands.Command<T>, WithThingId, org.eclipse.ditto.base.model.entity.type.WithEntityType, org.eclipse.ditto.base.model.signals.SignalWithEntityId<T>

Aggregates all Commands which are related to a Thing.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ThingCommand.JsonFields	This class contains definitions for all specific fields of a ThingCommand's JSON representation.

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

org.eclipse.ditto.base.model.signals.commands.Command.Category

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	RESOURCE_TYPE	Thing resource type.
static final String	TYPE_PREFIX	Type Prefix of Thing commands.

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

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
default org.eclipse.ditto.base.model.entity.type.EntityType	getEntityType()	Returns the entity type ThingConstants.ENTITY_TYPE.
default String	getResourceType()
default String	getTypePrefix()
static boolean	isThingCommand(org.eclipse.ditto.base.model.signals.WithType signal)	Indicates whether the specified signal argument is a ThingCommand.
T	setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)

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

getCategory, getImplementedSchemaVersion, 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.base.model.headers.WithDittoHeaders

getDittoHeaders

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

getManifest

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

getResourcePath

Methods inherited from interface org.eclipse.ditto.things.model.WithThingId

getEntityId

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

getType

Field Details

TYPE_PREFIX

static final String TYPE_PREFIX

Type Prefix of Thing commands.

See Also:

• Constant Field Values

RESOURCE_TYPE

static final String RESOURCE_TYPE

Thing resource type.

Method Details

getTypePrefix

default String getTypePrefix()

Specified by:

getTypePrefix in interface org.eclipse.ditto.base.model.signals.commands.Command<T extends ThingCommand<T>>

getResourceType

default String getResourceType()

Specified by:

getResourceType in interface org.eclipse.ditto.base.model.signals.WithResource

getEntityType

default org.eclipse.ditto.base.model.entity.type.EntityType getEntityType()

Returns the entity type ThingConstants.ENTITY_TYPE.

Specified by:

getEntityType in interface org.eclipse.ditto.base.model.entity.type.WithEntityType

Returns:

the Thing entity type.

Since:

1.1.0

setDittoHeaders

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

Specified by:

setDittoHeaders in interface org.eclipse.ditto.base.model.signals.commands.Command<T extends ThingCommand<T>>

Specified by:

setDittoHeaders in interface org.eclipse.ditto.base.model.headers.DittoHeadersSettable<T extends ThingCommand<T>>

isThingCommand

static boolean isThingCommand(@Nullable
 org.eclipse.ditto.base.model.signals.WithType signal)

Indicates whether the specified signal argument is a ThingCommand.

Parameters:

signal - the signal to be checked.

Returns:

true if signal is a ThingCommand, false else.

Since:

3.0.0