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

Class FeatureDesiredPropertyModified

java.lang.Object
org.eclipse.ditto.base.model.signals.events.AbstractEvent<T>
org.eclipse.ditto.base.model.signals.events.AbstractEventsourcedEvent<T>
org.eclipse.ditto.things.model.signals.events.AbstractThingEvent<FeatureDesiredPropertyModified>
org.eclipse.ditto.things.model.signals.events.FeatureDesiredPropertyModified
All Implemented Interfaces:
org.eclipse.ditto.base.model.entity.id.WithEntityId, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<FeatureDesiredPropertyModified>, 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.events.Event<FeatureDesiredPropertyModified>, org.eclipse.ditto.base.model.signals.events.EventsourcedEvent<FeatureDesiredPropertyModified>, org.eclipse.ditto.base.model.signals.Signal<FeatureDesiredPropertyModified>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<FeatureDesiredPropertyModified>, org.eclipse.ditto.base.model.signals.WithFeatureId, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithOptionalEntity<FeatureDesiredPropertyModified>, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType, ThingEvent<FeatureDesiredPropertyModified>, ThingModifiedEvent<FeatureDesiredPropertyModified>, WithThingId
@Immutable public final class FeatureDesiredPropertyModified extends AbstractThingEvent<FeatureDesiredPropertyModified> implements ThingModifiedEvent<FeatureDesiredPropertyModified>, org.eclipse.ditto.base.model.signals.WithFeatureId
This event is emitted after a desired property of a Feature's desired properties was modified.
Since:
1.5.0

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.eclipse.ditto.base.model.signals.events.Event

    org.eclipse.ditto.base.model.signals.events.Event.JsonFields

    Nested classes/interfaces inherited from interface org.eclipse.ditto.base.model.signals.events.EventsourcedEvent

    org.eclipse.ditto.base.model.signals.events.EventsourcedEvent.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>

    Nested classes/interfaces inherited from interface org.eclipse.ditto.things.model.signals.events.ThingEvent

    ThingEvent.JsonFields

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
    Name of the "Feature Desired Property Modified" event.
    static final String
    TYPE
    Type of this event.

    Fields inherited from interface org.eclipse.ditto.base.model.signals.events.Event

    DEFAULT_REVISION, TYPE_QUALIFIER

    Fields inherited from interface org.eclipse.ditto.base.model.signals.Signal

    CHANNEL_LIVE, CHANNEL_TWIN

    Fields inherited from interface org.eclipse.ditto.things.model.signals.events.ThingEvent

    RESOURCE_TYPE, TYPE_PREFIX

    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 FeatureDesiredPropertyModified
    fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a new FeatureDesiredPropertyModified from a JSON string.
    static FeatureDesiredPropertyModified
    fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a new FeatureDesiredPropertyModified from a JSON object.
    org.eclipse.ditto.base.model.signals.commands.Command.Category
    getCommandCategory()
    Get the category of the command that caused this event.
    org.eclipse.ditto.json.JsonPointer
    getDesiredPropertyPointer()
    Returns the JSON pointer of the desired property to modify.
    org.eclipse.ditto.json.JsonValue
    getDesiredPropertyValue()
    Returns the value of the desired property to modify.
    Optional<org.eclipse.ditto.json.JsonValue>
    getEntity(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)
     
    String
    getFeatureId()
     
    org.eclipse.ditto.json.JsonPointer
    getResourcePath()
     
    int
    hashCode()
     
    static FeatureDesiredPropertyModified
    of(ThingId thingId, String featureId, org.eclipse.ditto.json.JsonPointer desiredPropertyJsonPointer, org.eclipse.ditto.json.JsonValue desiredPropertyValue, long revision, Instant timestamp, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders, org.eclipse.ditto.base.model.entity.metadata.Metadata metadata)
    Constructs a new FeatureDesiredPropertyModified object.
    FeatureDesiredPropertyModified
    setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
     
    FeatureDesiredPropertyModified
    setEntity(org.eclipse.ditto.json.JsonValue entity)
     
    FeatureDesiredPropertyModified
    setRevision(long revision)
     
    String
    toString()
     

    Methods inherited from class org.eclipse.ditto.things.model.signals.events.AbstractThingEvent

    getEntityId

    Methods inherited from class org.eclipse.ditto.base.model.signals.events.AbstractEventsourcedEvent

    getRevision, toJson

    Methods inherited from class org.eclipse.ditto.base.model.signals.events.AbstractEvent

    getDittoHeaders, getManifest, getMetadata, getTimestamp, getType

    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.events.Event

    getImplementedSchemaVersion, getMetadata, getTimestamp, getType, toJson

    Methods inherited from interface org.eclipse.ditto.base.model.signals.events.EventsourcedEvent

    getRevision

    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, toJson, toJsonString, toJsonString

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

    getName

    Methods inherited from interface org.eclipse.ditto.things.model.signals.events.ThingEvent

    getResourceType

    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.WithOptionalEntity

    getEntity

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

    getEntityId

  • Field Details

  • Method Details

    • of

      public static FeatureDesiredPropertyModified of(ThingId thingId, String featureId, org.eclipse.ditto.json.JsonPointer desiredPropertyJsonPointer, org.eclipse.ditto.json.JsonValue desiredPropertyValue, long revision, @Nullable Instant timestamp, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders, @Nullable org.eclipse.ditto.base.model.entity.metadata.Metadata metadata)
      Constructs a new FeatureDesiredPropertyModified object.
      Parameters:
      thingId - the ID of the Thing whose Feature's desired property was modified.
      featureId - the ID of the Feature whose desired property was modified.
      desiredPropertyJsonPointer - the JSON pointer of the modified desired property key.
      desiredPropertyValue - the value of the modified desired property.
      revision - the revision of the Thing.
      timestamp - the timestamp of this event.
      dittoHeaders - the headers of the command which was the cause of this event.
      metadata - the metadata to apply for the event.
      Returns:
      the FeatureDesiredPropertyModified created.
      Throws:
      NullPointerException - if any argument but timestamp and metadata is null.

    • fromJson

      public static FeatureDesiredPropertyModified fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new FeatureDesiredPropertyModified from a JSON string.
      Parameters:
      jsonString - the JSON string of which a new FeatureDesiredPropertyModified instance is to be created.
      dittoHeaders - the headers of the command which was the cause of this event.
      Returns:
      the FeatureDesiredPropertyModified which was created from the given JSON string.
      Throws:
      NullPointerException - if jsonString is null.
      IllegalArgumentException - if jsonString is empty.
      org.eclipse.ditto.json.JsonParseException - if the passed in jsonString was not in the expected 'FeatureDesiredPropertyModified' format.

    • fromJson

      public static FeatureDesiredPropertyModified fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new FeatureDesiredPropertyModified from a JSON object.
      Parameters:
      jsonObject - the JSON object from which a new FeatureDesiredPropertyModified instance is to be created.
      dittoHeaders - the headers of the command which was the cause of this event.
      Returns:
      the FeatureDesiredPropertyModified which was created from the given JSON object.
      Throws:
      NullPointerException - if jsonObject is null.
      org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected 'FeatureDesiredPropertyModified' format.

    • getFeatureId

      public String getFeatureId()
      Specified by:
      getFeatureId in interface org.eclipse.ditto.base.model.signals.WithFeatureId

    • getDesiredPropertyPointer

      public org.eclipse.ditto.json.JsonPointer getDesiredPropertyPointer()
      Returns the JSON pointer of the desired property to modify.
      Returns:
      the JSON pointer of the desired property to modify.

    • getDesiredPropertyValue

      public org.eclipse.ditto.json.JsonValue getDesiredPropertyValue()
      Returns the value of the desired property to modify.
      Returns:
      the value of the desired property to modify.

    • getEntity

      public Optional<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.WithOptionalEntity<FeatureDesiredPropertyModified>

    • setEntity

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

    • getResourcePath

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

    • setRevision

      public FeatureDesiredPropertyModified setRevision(long revision)
      Specified by:
      setRevision in class org.eclipse.ditto.base.model.signals.events.AbstractEventsourcedEvent<FeatureDesiredPropertyModified>

    • setDittoHeaders

      public FeatureDesiredPropertyModified setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.headers.DittoHeadersSettable<FeatureDesiredPropertyModified>
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.signals.events.EventsourcedEvent<FeatureDesiredPropertyModified>
      Specified by:
      setDittoHeaders in interface ThingEvent<FeatureDesiredPropertyModified>
      Specified by:
      setDittoHeaders in interface ThingModifiedEvent<FeatureDesiredPropertyModified>

    • getCommandCategory

      public org.eclipse.ditto.base.model.signals.commands.Command.Category getCommandCategory()
      Description copied from interface: ThingEvent
      Get the category of the command that caused this event.
      Specified by:
      getCommandCategory in interface ThingEvent<FeatureDesiredPropertyModified>
      Returns:
      the command category.

    • 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.events.AbstractEvent<FeatureDesiredPropertyModified>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AbstractThingEvent<FeatureDesiredPropertyModified>

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class AbstractThingEvent<FeatureDesiredPropertyModified>

    • canEqual

      protected boolean canEqual(@Nullable Object other)
      Overrides:
      canEqual in class AbstractThingEvent<FeatureDesiredPropertyModified>

    • toString

      public String toString()
      Overrides:
      toString in class AbstractThingEvent<FeatureDesiredPropertyModified>