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

Class FeatureDesiredPropertiesModified

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<FeatureDesiredPropertiesModified>
org.eclipse.ditto.things.model.signals.events.FeatureDesiredPropertiesModified
All Implemented Interfaces:
org.eclipse.ditto.base.model.entity.id.WithEntityId, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<FeatureDesiredPropertiesModified>, 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<FeatureDesiredPropertiesModified>, org.eclipse.ditto.base.model.signals.events.EventsourcedEvent<FeatureDesiredPropertiesModified>, org.eclipse.ditto.base.model.signals.Signal<FeatureDesiredPropertiesModified>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<FeatureDesiredPropertiesModified>, org.eclipse.ditto.base.model.signals.WithFeatureId, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithOptionalEntity<FeatureDesiredPropertiesModified>, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType, ThingEvent<FeatureDesiredPropertiesModified>, ThingModifiedEvent<FeatureDesiredPropertiesModified>, WithThingId
@Immutable public final class FeatureDesiredPropertiesModified extends AbstractThingEvent<FeatureDesiredPropertiesModified> implements ThingModifiedEvent<FeatureDesiredPropertiesModified>, org.eclipse.ditto.base.model.signals.WithFeatureId
This event is emitted after a Feature's desired properties were 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 Properties 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 FeatureDesiredPropertiesModified
    fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a new FeatureDesiredPropertiesModified from a JSON string.
    static FeatureDesiredPropertiesModified
    fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a new FeatureDesiredPropertiesModified from a JSON object.
    org.eclipse.ditto.base.model.signals.commands.Command.Category
    getCommandCategory()
    Get the category of the command that caused this event.
    FeatureProperties
    getDesiredProperties()
    Returns the modified desired properties.
    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 FeatureDesiredPropertiesModified
    of(ThingId thingId, CharSequence featureId, FeatureProperties desiredProperties, long revision, Instant timestamp, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders, org.eclipse.ditto.base.model.entity.metadata.Metadata metadata)
    Constructs a new FeatureDesiredPropertiesModified object.
    FeatureDesiredPropertiesModified
    setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
     
    FeatureDesiredPropertiesModified
    setEntity(org.eclipse.ditto.json.JsonValue entity)
     
    FeatureDesiredPropertiesModified
    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 FeatureDesiredPropertiesModified of(ThingId thingId, CharSequence featureId, FeatureProperties desiredProperties, 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 FeatureDesiredPropertiesModified object.
      Parameters:
      thingId - the ID of the Thing whose Feature's desired properties were modified.
      featureId - the ID of the Feature whose desired properties were modified.
      desiredProperties - the modified desired properties.
      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 FeatureDesiredPropertiesModified created.
      Throws:
      NullPointerException - if any argument but timestamp and metadata is null.

    • fromJson

      public static FeatureDesiredPropertiesModified fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new FeatureDesiredPropertiesModified from a JSON string.
      Parameters:
      jsonString - the JSON string of which a new FeatureDesiredPropertiesModified instance is to be created.
      dittoHeaders - the headers of the command which was the cause of this event.
      Returns:
      the FeatureDesiredPropertiesModified which was created from the given JSON string.
      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 'FeatureDesiredPropertiesModified' format.

    • fromJson

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

    • getFeatureId

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

    • getDesiredProperties

      public FeatureProperties getDesiredProperties()
      Returns the modified desired properties.
      Returns:
      the modified desired properties.

    • 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<FeatureDesiredPropertiesModified>

    • setEntity

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

    • getResourcePath

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

    • setRevision

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

    • setDittoHeaders

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

    • 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<FeatureDesiredPropertiesModified>
      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<FeatureDesiredPropertiesModified>

    • hashCode

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

    • equals

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

    • canEqual

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

    • toString

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