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

Class DeleteAttribute

java.lang.Object

org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAttribute>

org.eclipse.ditto.signals.commands.things.modify.DeleteAttribute

All Implemented Interfaces:

org.eclipse.ditto.model.base.headers.WithDittoHeaders<DeleteAttribute>, org.eclipse.ditto.model.base.headers.WithManifest, org.eclipse.ditto.model.base.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>, org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate<org.eclipse.ditto.json.JsonObject,org.eclipse.ditto.json.JsonField>, org.eclipse.ditto.signals.base.Signal<DeleteAttribute>, org.eclipse.ditto.signals.base.WithId, org.eclipse.ditto.signals.base.WithName, org.eclipse.ditto.signals.base.WithOptionalEntity, org.eclipse.ditto.signals.base.WithResource, org.eclipse.ditto.signals.base.WithThingId, org.eclipse.ditto.signals.base.WithType, org.eclipse.ditto.signals.commands.base.Command<DeleteAttribute>, ThingModifyCommand<DeleteAttribute>, ThingCommand<DeleteAttribute>

@Immutable
public final class DeleteAttribute
extends org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAttribute>
implements ThingModifyCommand<DeleteAttribute>

This command deletes a thing's attribute. Contains the key of the attribute to delete and the ID of the Thing.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ditto.signals.commands.things.ThingCommand

ThingCommand.JsonFields

Nested classes/interfaces inherited from interface org.eclipse.ditto.model.base.json.Jsonifiable

org.eclipse.ditto.model.base.json.Jsonifiable.WithFieldSelector, org.eclipse.ditto.model.base.json.Jsonifiable.WithFieldSelectorAndPredicate<T>, org.eclipse.ditto.model.base.json.Jsonifiable.WithPointer<J extends org.eclipse.ditto.json.JsonValue>, org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate<J extends org.eclipse.ditto.json.JsonValue,T>

Field Summary

Fields

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

Fields inherited from interface org.eclipse.ditto.signals.commands.things.ThingCommand

RESOURCE_TYPE, TYPE_PREFIX

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

TYPE_QUALIFIER

Method Summary

Modifier and Type	Method and Description
protected void	appendPayload(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.model.base.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 DeleteAttribute	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new DeleteAttribute from a JSON object.
static DeleteAttribute	fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new DeleteAttribute from a JSON string.
org.eclipse.ditto.json.JsonPointer	getAttributePointer() Returns the JSON pointer of the attribute to delete.
org.eclipse.ditto.json.JsonPointer	getResourcePath()
String	getThingId()
int	hashCode()
static DeleteAttribute	of(String thingId, org.eclipse.ditto.json.JsonPointer attributeJsonPointer, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Returns a command for deleting a Thing's attribute which can be accessed with the given authorization context.
DeleteAttribute	setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
String	toString()

Methods inherited from class org.eclipse.ditto.signals.commands.base.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.signals.commands.things.ThingCommand

getId, getResourceType, getTypePrefix

Methods inherited from interface org.eclipse.ditto.signals.commands.base.Command

getImplementedSchemaVersion, toJson, toJson

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

getName

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

toJson, toJsonString, toJsonString

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

getLatestSchemaVersion, getSupportedSchemaVersions, implementsSchemaVersion, implementsSchemaVersion, toJsonString

Methods inherited from interface org.eclipse.ditto.model.base.headers.WithDittoHeaders

getDittoHeaders

Methods inherited from interface org.eclipse.ditto.model.base.headers.WithManifest

getManifest

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

getType

Methods inherited from interface org.eclipse.ditto.signals.base.WithOptionalEntity

getEntity, getEntity

Field Detail

NAME

public static final String NAME

Name of the "Delete Thing Attribute" command.

See Also:

Constant Field Values

TYPE

public static final String TYPE

Type of this command.

See Also:

Constant Field Values

Method Detail

of

public static DeleteAttribute of(String thingId,
                                 org.eclipse.ditto.json.JsonPointer attributeJsonPointer,
                                 org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Returns a command for deleting a Thing's attribute which can be accessed with the given authorization context. The attribute's key and the Thing's ID are passed as arguments.

Parameters:

thingId - the thing's key.

attributeJsonPointer - the JSON pointer of the attribute key to delete.

dittoHeaders - the headers of the command.

Returns:

a command for deleting a Thing's attribute.

Throws:

NullPointerException - if any argument but thingId is null.

org.eclipse.ditto.model.things.ThingIdInvalidException - if thingId did not comply to Thing.ID_REGEX.

fromJson

public static DeleteAttribute fromJson(String jsonString,
                                       org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a new DeleteAttribute 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.

org.eclipse.ditto.model.things.ThingIdInvalidException - if thingId did not comply to Thing.ID_REGEX.

fromJson

public static DeleteAttribute fromJson(org.eclipse.ditto.json.JsonObject jsonObject,
                                       org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a new DeleteAttribute 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.

org.eclipse.ditto.model.things.ThingIdInvalidException - if thingId did not comply to Thing.ID_REGEX.

getAttributePointer

public org.eclipse.ditto.json.JsonPointer getAttributePointer()

Returns the JSON pointer of the attribute to delete.

Returns:

the JSON pointer of the attribute to delete.

getThingId

public String getThingId()

Specified by:

getThingId in interface org.eclipse.ditto.signals.base.WithThingId

getResourcePath

public org.eclipse.ditto.json.JsonPointer getResourcePath()

Specified by:

getResourcePath in interface org.eclipse.ditto.signals.base.WithResource

appendPayload

protected void appendPayload(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder,
                             org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion,
                             Predicate<org.eclipse.ditto.json.JsonField> thePredicate)

Specified by:

appendPayload in class org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAttribute>

setDittoHeaders

public DeleteAttribute setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Specified by:

setDittoHeaders in interface org.eclipse.ditto.model.base.headers.WithDittoHeaders<DeleteAttribute>

Specified by:

setDittoHeaders in interface org.eclipse.ditto.signals.commands.base.Command<DeleteAttribute>

Specified by:

setDittoHeaders in interface ThingModifyCommand<DeleteAttribute>

Specified by:

setDittoHeaders in interface ThingCommand<DeleteAttribute>

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<DeleteAttribute>

Returns:

true if authorization would change, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAttribute>

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAttribute>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAttribute>

toString

public String toString()

Overrides:

toString in class org.eclipse.ditto.signals.commands.base.AbstractCommand<DeleteAttribute>