Package org.eclipse.ditto.client.live.commands.base

Interface LiveCommand<T extends org.eclipse.ditto.base.model.signals.commands.Command<T>,B extends LiveCommandAnswerBuilder>

Type Parameters:

T - the type of the LiveCommand; currently needed as return type for Command.setDittoHeaders(DittoHeaders).

B - the type of the LiveCommandAnswerBuilder to be returned for answer().

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.headers.WithDittoHeaders, org.eclipse.ditto.base.model.headers.WithManifest, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType

All Known Subinterfaces:

CreateThingLiveCommand, DeleteAttributeLiveCommand, DeleteAttributesLiveCommand, DeleteFeatureDefinitionLiveCommand, DeleteFeatureDesiredPropertiesLiveCommand, DeleteFeatureDesiredPropertyLiveCommand, DeleteFeatureLiveCommand, DeleteFeaturePropertiesLiveCommand, DeleteFeaturePropertyLiveCommand, DeleteFeaturesLiveCommand, DeleteThingLiveCommand, MergeThingLiveCommand, ModifyAttributeLiveCommand, ModifyAttributesLiveCommand, ModifyFeatureDefinitionLiveCommand, ModifyFeatureDesiredPropertiesLiveCommand, ModifyFeatureDesiredPropertyLiveCommand, ModifyFeatureLiveCommand, ModifyFeaturePropertiesLiveCommand, ModifyFeaturePropertyLiveCommand, ModifyFeaturesLiveCommand, ModifyThingLiveCommand, RetrieveAttributeLiveCommand, RetrieveAttributesLiveCommand, RetrieveFeatureDefinitionLiveCommand, RetrieveFeatureDesiredPropertiesLiveCommand, RetrieveFeatureDesiredPropertyLiveCommand, RetrieveFeatureLiveCommand, RetrieveFeaturePropertiesLiveCommand, RetrieveFeaturePropertyLiveCommand, RetrieveFeaturesLiveCommand, RetrieveThingLiveCommand, RetrieveThingsLiveCommand

All Known Implementing Classes:

AbstractLiveCommand

public interface LiveCommand<T extends org.eclipse.ditto.base.model.signals.commands.Command<T>,B extends LiveCommandAnswerBuilder>
extends org.eclipse.ditto.base.model.signals.commands.Command<T>

A Handle for live Commands giving access to the command. Also provides a Command specific LiveCommandAnswerBuilder used for building CommandResponses to return and Events to emit for incoming commands.

Since:

2.0.0

Nested Class Summary

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

org.eclipse.ditto.base.model.signals.commands.Command.Category, org.eclipse.ditto.base.model.signals.commands.Command.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 java.lang.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 java.lang.Object>

Field Summary

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
B	answer()	Returns a builder for an answer to this command which could include a CommandResponses or an Event.

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

getCategory, getImplementedSchemaVersion, getTypePrefix, setDittoHeaders, 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, getResourceType

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

getType

Method Detail

answer

@Nonnull
B answer()

Returns a builder for an answer to this command which could include a CommandResponses or an Event. The answer is emitted automatically for the received Command.

Returns:

the LiveCommandAnswerBuilder for building responses and events.