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

Class ModifyAttribute

java.lang.Object
org.eclipse.ditto.base.model.signals.commands.AbstractCommand<ModifyAttribute>
org.eclipse.ditto.things.model.signals.commands.modify.ModifyAttribute
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<ModifyAttribute>, 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<ModifyAttribute>, org.eclipse.ditto.base.model.signals.Signal<ModifyAttribute>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<ModifyAttribute>, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithOptionalEntity<ModifyAttribute>, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType, ThingModifyCommand<ModifyAttribute>, ThingCommand<ModifyAttribute>, WithThingId
@Immutable public final class ModifyAttribute extends org.eclipse.ditto.base.model.signals.commands.AbstractCommand<ModifyAttribute> implements ThingModifyCommand<ModifyAttribute>
This command modifies an attribute.

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

    ThingCommand.JsonFields

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
    Name of the "Modify Thing Attribute" command.
    static final String
    TYPE
    Type of this command.

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

    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.commands.ThingCommand

    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
    changesAuthorization()
    Checks whether this command may change authorization of the Thing.
    boolean
    equals(Object obj)
     
    static ModifyAttribute
    fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a new ModifyAttribute from a JSON string.
    static ModifyAttribute
    fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a new ModifyAttribute from a JSON object.
    org.eclipse.ditto.json.JsonPointer
    getAttributePointer()
    Returns the JSON pointer of the attribute to modify.
    org.eclipse.ditto.json.JsonValue
    getAttributeValue()
    Returns the value of the attribute to modify.
    org.eclipse.ditto.base.model.signals.commands.Command.Category
    getCategory()
     
    Optional<org.eclipse.ditto.json.JsonValue>
    getEntity(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)
     
    ThingId
    getEntityId()
     
    org.eclipse.ditto.json.JsonPointer
    getResourcePath()
     
    int
    hashCode()
     
    static ModifyAttribute
    of(ThingId thingId, org.eclipse.ditto.json.JsonPointer attributeJsonPointer, org.eclipse.ditto.json.JsonValue newAttributeValue, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Returns a command for modifying an attribute which is passed as argument.
    ModifyAttribute
    setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
     
    ModifyAttribute
    setEntity(org.eclipse.ditto.json.JsonValue entity)
     
    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, getSupportedSchemaVersions, 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.things.model.signals.commands.ThingCommand

    getEntityType, getResourceType, getTypePrefix

    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 Details

  • Method Details

    • of

      public static ModifyAttribute of(ThingId thingId, org.eclipse.ditto.json.JsonPointer attributeJsonPointer, org.eclipse.ditto.json.JsonValue newAttributeValue, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Returns a command for modifying an attribute which is passed as argument.
      Parameters:
      thingId - the ID of the thing on which to modify the attribute.
      attributeJsonPointer - the JSON pointer of the attribute key to modify.
      newAttributeValue - the value of the attribute to modify.
      dittoHeaders - the headers of the command.
      Returns:
      a command for modifying the provided new attribute.
      Throws:
      NullPointerException - if any argument but thingId is null.
      AttributePointerInvalidException - if attributeJsonPointer is empty.
      org.eclipse.ditto.json.JsonKeyInvalidException - if keys of attributeJsonPointer are not valid according to pattern RegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN.

    • fromJson

      public static ModifyAttribute fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new ModifyAttribute 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:
      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 format.
      ThingIdInvalidException - if the parsed thing ID did not comply to RegexPatterns.ID_REGEX.
      AttributePointerInvalidException - if JSON_ATTRIBUTE contains an empty pointer.
      org.eclipse.ditto.json.JsonKeyInvalidException - if keys of attribute pointer are not valid according to pattern RegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN.

    • fromJson

      public static ModifyAttribute fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new ModifyAttribute 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:
      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.
      AttributePointerInvalidException - if JSON_ATTRIBUTE contains an empty pointer.
      org.eclipse.ditto.json.JsonKeyInvalidException - if keys of attribute pointer are not valid according to pattern RegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN.

    • getAttributePointer

      public org.eclipse.ditto.json.JsonPointer getAttributePointer()
      Returns the JSON pointer of the attribute to modify.
      Returns:
      the JSON pointer.

    • getAttributeValue

      public org.eclipse.ditto.json.JsonValue getAttributeValue()
      Returns the value of the attribute 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

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

    • setEntity

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

    • 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, Predicate<org.eclipse.ditto.json.JsonField> thePredicate)
      Specified by:
      appendPayload in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<ModifyAttribute>

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

    • setDittoHeaders

      public ModifyAttribute setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.signals.commands.Command<ModifyAttribute>
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.headers.DittoHeadersSettable<ModifyAttribute>
      Specified by:
      setDittoHeaders in interface ThingCommand<ModifyAttribute>
      Specified by:
      setDittoHeaders in interface ThingModifyCommand<ModifyAttribute>

    • changesAuthorization

      public boolean changesAuthorization()
      Description copied from interface: ThingModifyCommand
      Checks whether this command may change authorization of the Thing.
      Specified by:
      changesAuthorization in interface ThingModifyCommand<ModifyAttribute>
      Returns:
      true if authorization would change, false otherwise.

    • hashCode

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

    • equals

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

    • canEqual

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

    • toString

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