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

Class ModifyThing

java.lang.Object

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

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

All Implemented Interfaces:

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

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

This command modifies an existing Thing. It contains the full Thing including the Thing ID which should be used for modification.

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 org.eclipse.ditto.json.JsonFieldDefinition<org.eclipse.ditto.json.JsonObject>	JSON_INITIAL_POLICY Json Field definition for the optional initial "inline" policy when creating a Thing.
static String	NAME Name of the "Modify 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)
protected boolean	canEqual(Object other)
boolean	changesAuthorization() Checks whether this command may change authorization of the Thing.
boolean	equals(Object obj)
static ModifyThing	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new ModifyThing from a JSON object.
static ModifyThing	fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new ModifyThing from a JSON string.
Optional<org.eclipse.ditto.json.JsonValue>	getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
Optional<org.eclipse.ditto.json.JsonObject>	getInitialPolicy()
org.eclipse.ditto.json.JsonPointer	getResourcePath()
org.eclipse.ditto.model.things.Thing	getThing() Returns the Thing to modify.
String	getThingId()
int	hashCode()
static ModifyThing	of(String thingId, org.eclipse.ditto.model.things.Thing thing, org.eclipse.ditto.json.JsonObject initialPolicy, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Returns a command for modifying a thing which is passed as argument.
ModifyThing	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

Field Detail

NAME

public static final String NAME

Name of the "Modify Thing" command.

See Also:

Constant Field Values

TYPE

public static final String TYPE

Type of this command.

See Also:

Constant Field Values

JSON_INITIAL_POLICY

public static final org.eclipse.ditto.json.JsonFieldDefinition<org.eclipse.ditto.json.JsonObject> JSON_INITIAL_POLICY

Json Field definition for the optional initial "inline" policy when creating a Thing.

Method Detail

of

public static ModifyThing of(String thingId,
                             org.eclipse.ditto.model.things.Thing thing,
                             @Nullable
                             org.eclipse.ditto.json.JsonObject initialPolicy,
                             org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Returns a command for modifying a thing which is passed as argument.

Parameters:

thingId - the Thing's ID.

thing - the Thing to modify.

initialPolicy - the initial Policy to set for the Thing when creating it - may be null.

dittoHeaders - the headers of the command.

Returns:

the command.

Throws:

NullPointerException - if any argument is null.

fromJson

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

Creates a new ModifyThing 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 jsonString is null.

IllegalArgumentException - if jsonString is empty.

org.eclipse.ditto.json.JsonParseException - if the passed in jsonString was not in the expected format.

fromJson

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

Creates a new ModifyThing 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 jsonObject is null.

org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected format.

org.eclipse.ditto.json.JsonMissingFieldException - if jsonObject did not contain a field for ThingModifyCommand.JsonFields#JSON_THING_ID or JSON_THING.

getThing

public org.eclipse.ditto.model.things.Thing getThing()

Returns the Thing to modify.

Returns:

the Thing to modify.

getThingId

public String getThingId()

Specified by:

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

getInitialPolicy

public Optional<org.eclipse.ditto.json.JsonObject> getInitialPolicy()

Returns:

the initial Policy if there should be one applied when creating the Thing.

getResourcePath

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

Specified by:

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

getEntity

public Optional<org.eclipse.ditto.json.JsonValue> getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)

Specified by:

getEntity in interface org.eclipse.ditto.signals.base.WithOptionalEntity

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

setDittoHeaders

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

Specified by:

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

Specified by:

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

Specified by:

setDittoHeaders in interface ThingModifyCommand<ModifyThing>

Specified by:

setDittoHeaders in interface ThingCommand<ModifyThing>

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

Returns:

true if authorization would change, false otherwise.

hashCode

public int hashCode()

Overrides:

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

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

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

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

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

toString

public String toString()

Overrides:

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