Package org.eclipse.ditto.things.model.signals.commands.modify

Class ModifyFeatureDesiredProperty

  • All Implemented Interfaces:
    org.eclipse.ditto.base.model.entity.id.WithEntityId, org.eclipse.ditto.base.model.entity.type.WithEntityType, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<ModifyFeatureDesiredProperty>, 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.commands.Command<ModifyFeatureDesiredProperty>, org.eclipse.ditto.base.model.signals.Signal<ModifyFeatureDesiredProperty>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<ModifyFeatureDesiredProperty>, org.eclipse.ditto.base.model.signals.WithFeatureId, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithOptionalEntity, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType, ThingModifyCommand<ModifyFeatureDesiredProperty>, ThingCommand<ModifyFeatureDesiredProperty>, WithThingId
    @Immutable
public final class ModifyFeatureDesiredProperty
extends org.eclipse.ditto.base.model.signals.commands.AbstractCommand<ModifyFeatureDesiredProperty>
implements ThingModifyCommand<ModifyFeatureDesiredProperty>, org.eclipse.ditto.base.model.signals.WithFeatureId
    This command modifies a single desired property of a Feature's desired properties.
    Since:
    1.5.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 
      Modifier and Type Field Description
      static java.lang.String NAME
      Name of the "Modify Feature Desired Property" command.
      static java.lang.String TYPE
      Type of this command.

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

        TYPE_QUALIFIER

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void appendPayload​(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion, java.util.function.Predicate<org.eclipse.ditto.json.JsonField> thePredicate)  
      protected boolean canEqual​(java.lang.Object other)  
      boolean changesAuthorization()
      Checks whether this command may change authorization of the Thing.
      boolean equals​(java.lang.Object obj)  
      static ModifyFeatureDesiredProperty fromJson​(java.lang.String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new ModifyFeatureDesiredProperty from a JSON string.
      static ModifyFeatureDesiredProperty fromJson​(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new ModifyFeatureDesiredProperty from a JSON object.
      org.eclipse.ditto.base.model.signals.commands.Command.Category getCategory()  
      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.
      java.util.Optional<org.eclipse.ditto.json.JsonValue> getEntity​(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)  
      ThingId getEntityId()  
      java.lang.String getFeatureId()  
      org.eclipse.ditto.json.JsonPointer getResourcePath()  
      org.eclipse.ditto.base.model.json.JsonSchemaVersion[] getSupportedSchemaVersions()
      ModifyFeatureDesiredProperty is only available in JsonSchemaVersion V_2.
      int hashCode()  
      static ModifyFeatureDesiredProperty of​(ThingId thingId, java.lang.CharSequence featureId, org.eclipse.ditto.json.JsonPointer desiredPropertyJsonPointer, org.eclipse.ditto.json.JsonValue desiredPropertyValue, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Returns a Command for modifying a Feature's desired property on a Thing.
      ModifyFeatureDesiredProperty setDittoHeaders​(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)  
      java.lang.String toString()  

      • Methods inherited from class org.eclipse.ditto.base.model.signals.commands.AbstractCommand

        getDittoHeaders, getManifest, getType, toJson

      • 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.commands.Command

        getImplementedSchemaVersion, toJson, toJson

      • Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable

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

        getEntity

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

        getType

    • Field Detail

      • NAME

        public static final java.lang.String NAME
        Name of the "Modify Feature Desired Property" command.
        See Also:
        Constant Field Values

    • Method Detail

      • of

        public static ModifyFeatureDesiredProperty of​(ThingId thingId,
                                              java.lang.CharSequence featureId,
                                              org.eclipse.ditto.json.JsonPointer desiredPropertyJsonPointer,
                                              org.eclipse.ditto.json.JsonValue desiredPropertyValue,
                                              org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Returns a Command for modifying a Feature's desired property on a Thing.
        Parameters:
        thingId - the Thing's ID whose Feature's desired property to modify.
        featureId - the Feature's ID whose desired property to modify.
        desiredPropertyJsonPointer - the JSON pointer of the desired property key to modify.
        desiredPropertyValue - the value of the desired property to modify.
        dittoHeaders - the headers of the command.
        Returns:
        a Command for modifying the provided desired property.
        Throws:
        java.lang.NullPointerException - if any argument but thingId is null.
        org.eclipse.ditto.json.JsonKeyInvalidException - if keys of desiredPropertyJsonPointer are not valid according to pattern RegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN.

      • fromJson

        public static ModifyFeatureDesiredProperty fromJson​(java.lang.String jsonString,
                                                    org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Creates a new ModifyFeatureDesiredProperty from a JSON string.
        Parameters:
        jsonString - the JSON string of which the command is to be created.
        dittoHeaders - the headers of the command.
        Returns:
        the command.
        Throws:
        java.lang.NullPointerException - if any argument is null.
        java.lang.IllegalArgumentException - if jsonString is empty.
        org.eclipse.ditto.json.JsonParseException - if the passed in jsonString was not in the expected format.
        ThingIdInvalidException - if the parsed thing ID did not comply to RegexPatterns.ID_REGEX.
        org.eclipse.ditto.json.JsonKeyInvalidException - if keys of the desired property pointer are not valid according to pattern RegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN.

      • fromJson

        public static ModifyFeatureDesiredProperty fromJson​(org.eclipse.ditto.json.JsonObject jsonObject,
                                                    org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Creates a new ModifyFeatureDesiredProperty from a JSON object.
        Parameters:
        jsonObject - the JSON object of which the command is to be created.
        dittoHeaders - the headers of the command.
        Returns:
        the command.
        Throws:
        java.lang.NullPointerException - if any argument is null.
        org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected format.
        ThingIdInvalidException - if the parsed thing ID did not comply to RegexPatterns.ID_REGEX.
        org.eclipse.ditto.json.JsonKeyInvalidException - if keys of the desired property pointer are not valid according to pattern RegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN.

      • getDesiredPropertyPointer

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

      • getDesiredPropertyValue

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

      • getEntityId

        public ThingId getEntityId()
        Specified by:
        getEntityId in interface org.eclipse.ditto.base.model.entity.id.WithEntityId
        Specified by:
        getEntityId in interface WithThingId

      • getFeatureId

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

      • getEntity

        public java.util.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

      • getSupportedSchemaVersions

        public org.eclipse.ditto.base.model.json.JsonSchemaVersion[] getSupportedSchemaVersions()
        ModifyFeatureDesiredProperty is only available in JsonSchemaVersion V_2.
        Specified by:
        getSupportedSchemaVersions in interface org.eclipse.ditto.base.model.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>
        Returns:
        the supported JsonSchemaVersions.

      • getResourcePath

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

      • appendPayload

        protected void appendPayload​(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder,
                             org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion,
                             java.util.function.Predicate<org.eclipse.ditto.json.JsonField> thePredicate)
        Specified by:
        appendPayload in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<ModifyFeatureDesiredProperty>

      • getCategory

        public org.eclipse.ditto.base.model.signals.commands.Command.Category getCategory()
        Specified by:
        getCategory in interface org.eclipse.ditto.base.model.signals.commands.Command<ModifyFeatureDesiredProperty>

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<ModifyFeatureDesiredProperty>

      • equals

        public boolean equals​(@Nullable
                      java.lang.Object obj)
        Overrides:
        equals in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<ModifyFeatureDesiredProperty>

      • canEqual

        protected boolean canEqual​(@Nullable
                           java.lang.Object other)
        Overrides:
        canEqual in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<ModifyFeatureDesiredProperty>

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<ModifyFeatureDesiredProperty>