Class FeatureDesiredPropertiesCreated

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<FeatureDesiredPropertiesCreated>
org.eclipse.ditto.things.model.signals.events.FeatureDesiredPropertiesCreated
All Implemented Interfaces:
org.eclipse.ditto.base.model.entity.id.WithEntityId, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<FeatureDesiredPropertiesCreated>, 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<FeatureDesiredPropertiesCreated>, org.eclipse.ditto.base.model.signals.events.EventsourcedEvent<FeatureDesiredPropertiesCreated>, org.eclipse.ditto.base.model.signals.Signal<FeatureDesiredPropertiesCreated>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<FeatureDesiredPropertiesCreated>, org.eclipse.ditto.base.model.signals.WithFeatureId, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithOptionalEntity<FeatureDesiredPropertiesCreated>, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType, ThingEvent<FeatureDesiredPropertiesCreated>, ThingModifiedEvent<FeatureDesiredPropertiesCreated>, WithThingId

@Immutable public final class FeatureDesiredPropertiesCreated extends AbstractThingEvent<FeatureDesiredPropertiesCreated> implements ThingModifiedEvent<FeatureDesiredPropertiesCreated>, org.eclipse.ditto.base.model.signals.WithFeatureId
This event is emitted after a Feature's desired properties were created.
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 of the "Feature Desired Properties Created" event.
    static final String
    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
     
    boolean
     
    fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a new FeatureDesiredPropertiesCreated from a JSON string.
    fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a new FeatureDesiredPropertiesCreated from a JSON object.
    org.eclipse.ditto.base.model.signals.commands.Command.Category
    Get the category of the command that caused this event.
    Returns the created desired properties.
    Optional<org.eclipse.ditto.json.JsonValue>
    getEntity(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)
     
     
    org.eclipse.ditto.json.JsonPointer
     
    int
     
    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 FeatureDesiredPropertiesCreated object.
    setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
     
    setEntity(org.eclipse.ditto.json.JsonValue entity)
     
    setRevision(long revision)
     
     

    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 FeatureDesiredPropertiesCreated 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 FeatureDesiredPropertiesCreated object.
      Parameters:
      thingId - the ID of the Thing whose Feature's desired properties were created.
      featureId - the ID of the Feature whose desired properties were created.
      desiredProperties - the created 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. FeatureModified
      metadata - the metadata to apply for the event.
      Returns:
      the FeatureDesiredPropertiesCreated
      Throws:
      NullPointerException - if any argument but timestamp and metadata is null.
    • fromJson

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

      public static FeatureDesiredPropertiesCreated fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new FeatureDesiredPropertiesCreated from a JSON object.
      Parameters:
      jsonObject - the JSON object from which a new FeatureDesiredPropertiesCreated instance is to be created.
      dittoHeaders - the headers of the command which was the cause of this event.
      Returns:
      the FeatureDesiredPropertiesCreated 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 'FeatureDesiredPropertiesCreated' format.
    • getFeatureId

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

      public FeatureProperties getDesiredProperties()
      Returns the created desired properties.
      Returns:
      the created 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<FeatureDesiredPropertiesCreated>
    • setEntity

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

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

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

      public FeatureDesiredPropertiesCreated setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.headers.DittoHeadersSettable<FeatureDesiredPropertiesCreated>
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.signals.events.EventsourcedEvent<FeatureDesiredPropertiesCreated>
      Specified by:
      setDittoHeaders in interface ThingEvent<FeatureDesiredPropertiesCreated>
      Specified by:
      setDittoHeaders in interface ThingModifiedEvent<FeatureDesiredPropertiesCreated>
    • 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<FeatureDesiredPropertiesCreated>
      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<FeatureDesiredPropertiesCreated>
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AbstractThingEvent<FeatureDesiredPropertiesCreated>
    • equals

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

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

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