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

Interface LiveCommand<T extends org.eclipse.ditto.signals.commands.base.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.signals.commands.base.Command<T>, 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<T>, org.eclipse.ditto.model.base.headers.WithDittoHeaders<T>, org.eclipse.ditto.signals.base.WithId, org.eclipse.ditto.model.base.headers.WithManifest, org.eclipse.ditto.signals.base.WithName, org.eclipse.ditto.signals.base.WithResource, org.eclipse.ditto.model.things.WithThingId, org.eclipse.ditto.signals.base.WithType

All Known Subinterfaces:

CreateThingLiveCommand, DeleteAttributeLiveCommand, DeleteAttributesLiveCommand, DeleteFeatureDefinitionLiveCommand, DeleteFeatureLiveCommand, DeleteFeaturePropertiesLiveCommand, DeleteFeaturePropertyLiveCommand, DeleteFeaturesLiveCommand, DeleteThingLiveCommand, ModifyAttributeLiveCommand, ModifyAttributesLiveCommand, ModifyFeatureDefinitionLiveCommand, ModifyFeatureLiveCommand, ModifyFeaturePropertiesLiveCommand, ModifyFeaturePropertyLiveCommand, ModifyFeaturesLiveCommand, ModifyThingLiveCommand, RetrieveAttributeLiveCommand, RetrieveAttributesLiveCommand, RetrieveFeatureDefinitionLiveCommand, RetrieveFeatureLiveCommand, RetrieveFeaturePropertiesLiveCommand, RetrieveFeaturePropertyLiveCommand, RetrieveFeaturesLiveCommand, RetrieveThingLiveCommand, RetrieveThingsLiveCommand

All Known Implementing Classes:

AbstractLiveCommand

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

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.

Nested Class Summary

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

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

Field Summary

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

TYPE_QUALIFIER

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

getCategory, getImplementedSchemaVersion, getTypePrefix, setDittoHeaders, toJson, toJson

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.json.Jsonifiable.WithPredicate

toJson, toJsonString, toJsonString

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

getName

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

getDittoHeaders

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

getEntityId, getId

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

getManifest

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

getResourcePath, getResourceType

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

getThingEntityId, getThingId

Methods inherited from interface org.eclipse.ditto.signals.base.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.