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

Class DeleteThing

java.lang.Object

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

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

All Implemented Interfaces:

org.eclipse.ditto.model.base.headers.WithDittoHeaders<DeleteThing>, 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<DeleteThing>, 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<DeleteThing>, ThingModifyCommand<DeleteThing>, ThingCommand<DeleteThing>

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

This command deletes a thing. Contains the thingId of the Thing. If the Thing did not exist in the system, a response with status code 404 (Not found) will be generated.

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" 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)
boolean	changesAuthorization() Checks whether this command may change authorization of the Thing.
boolean	equals(Object obj)
static DeleteThing	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new DeleteThing from a JSON object.
static DeleteThing	fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new DeleteThing from a JSON string.
org.eclipse.ditto.json.JsonPointer	getResourcePath()
String	getThingId()
int	hashCode()
static DeleteThing	of(String thingId, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Returns a command for deleting a Thing.
DeleteThing	setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
String	toString()

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

canEqual, 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" 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 DeleteThing of(String thingId,
                             org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Returns a command for deleting a Thing. Its ID is passed as argument.

Parameters:

thingId - the ID of a Thing to be deleted by this command.

dittoHeaders - the headers of the command.

Returns:

a command for deleting the Thing.

Throws:

NullPointerException - if dittoHeaders is null

org.eclipse.ditto.model.things.ThingIdInvalidException - if the parsed thing ID did not comply to Thing.ID_REGEX.

fromJson

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

Creates a new DeleteThing 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 the parsed thing ID did not comply to Thing.ID_REGEX.

fromJson

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

Creates a new DeleteThing 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 the parsed thing ID did not comply to Thing.ID_REGEX.

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

setDittoHeaders

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

Specified by:

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

Specified by:

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

Specified by:

setDittoHeaders in interface ThingModifyCommand<DeleteThing>

Specified by:

setDittoHeaders in interface ThingCommand<DeleteThing>

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

Returns:

true if authorization would change, false otherwise.

hashCode

public int hashCode()

Overrides:

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

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

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

toString

public String toString()

Overrides:

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