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

Class ModifyFeatureDefinition

java.lang.Object

org.eclipse.ditto.base.model.signals.commands.AbstractCommand<ModifyFeatureDefinition>

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

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<ModifyFeatureDefinition>, 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<ModifyFeatureDefinition>, org.eclipse.ditto.base.model.signals.Signal<ModifyFeatureDefinition>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<ModifyFeatureDefinition>, org.eclipse.ditto.base.model.signals.WithFeatureId, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithOptionalEntity<ModifyFeatureDefinition>, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType, ThingModifyCommand<ModifyFeatureDefinition>, ThingCommand<ModifyFeatureDefinition>, WithThingId

@Immutable
public final class ModifyFeatureDefinition
extends org.eclipse.ditto.base.model.signals.commands.AbstractCommand<ModifyFeatureDefinition>
implements ThingModifyCommand<ModifyFeatureDefinition>, org.eclipse.ditto.base.model.signals.WithFeatureId

This command modifies a Feature's Definition.

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 Feature Definition" 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 o)
static ModifyFeatureDefinition	fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)	Creates a new ModifyFeatureDefinition from a JSON string.
static ModifyFeatureDefinition	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)	Creates a new ModifyFeatureDefinition from a JSON object.
org.eclipse.ditto.base.model.signals.commands.Command.Category	getCategory()
FeatureDefinition	getDefinition()	Returns the FeatureDefinition to modify.
Optional<org.eclipse.ditto.json.JsonValue>	getEntity(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion)
ThingId	getEntityId()
String	getFeatureId()
org.eclipse.ditto.json.JsonPointer	getResourcePath()
int	hashCode()
static ModifyFeatureDefinition	of(ThingId thingId, String featureId, FeatureDefinition definition, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)	Returns a Command for modifying a Feature's Definition on a Thing.
ModifyFeatureDefinition	setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
ModifyFeatureDefinition	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

NAME

public static final String NAME

Name of the "Modify Feature Definition" command.

See Also:

• Constant Field Values

TYPE

public static final String TYPE

Type of this command.

See Also:

• Constant Field Values

Method Details

of

public static ModifyFeatureDefinition of(ThingId thingId,
 String featureId,
 FeatureDefinition definition,
 org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)

Returns a Command for modifying a Feature's Definition on a Thing.

Parameters:

thingId - the Thing's ID whose Feature's Definition to modify.

featureId - the Feature's ID whose Definition to modify.

definition - the Definition to modify.

dittoHeaders - the headers of the command.

Returns:

a Command for modifying the provided Definition.

Throws:

NullPointerException - if any argument but thingId is null.

fromJson

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

Creates a new ModifyFeatureDefinition 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.json.JsonMissingFieldException - if the parsed jsonString did not contain any of the fields

• ThingCommand.JsonFields.JSON_THING_ID,
• JSON_FEATURE_ID or
• JSON_DEFINITION.

ThingIdInvalidException - if the parsed thing ID did not comply to RegexPatterns.ID_REGEX.

fromJson

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

Creates a new ModifyFeatureDefinition 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.json.JsonMissingFieldException - if jsonObject did not contain any of the fields

• ThingCommand.JsonFields.JSON_THING_ID,
• JSON_FEATURE_ID or
• JSON_DEFINITION.

ThingIdInvalidException - if the parsed thing ID did not comply to RegexPatterns.ID_REGEX.

getEntityId

public ThingId getEntityId()

Specified by:

getEntityId in interface org.eclipse.ditto.base.model.entity.id.WithEntityId

Specified by:

getEntityId in interface WithThingId

getDefinition

public FeatureDefinition getDefinition()

Returns the FeatureDefinition to modify.

Returns:

the Definition to modify.

getFeatureId

public String getFeatureId()

Specified by:

getFeatureId in interface org.eclipse.ditto.base.model.signals.WithFeatureId

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

setEntity

public ModifyFeatureDefinition setEntity(org.eclipse.ditto.json.JsonValue entity)

Specified by:

setEntity in interface org.eclipse.ditto.base.model.signals.WithOptionalEntity<ModifyFeatureDefinition>

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

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

setDittoHeaders

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

Specified by:

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

Specified by:

setDittoHeaders in interface org.eclipse.ditto.base.model.headers.DittoHeadersSettable<ModifyFeatureDefinition>

Specified by:

setDittoHeaders in interface ThingCommand<ModifyFeatureDefinition>

Specified by:

setDittoHeaders in interface ThingModifyCommand<ModifyFeatureDefinition>

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

Returns:

true if authorization would change, false otherwise.

equals

public boolean equals(@Nullable
 Object o)

Overrides:

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

canEqual

protected boolean canEqual(@Nullable
 Object other)

Overrides:

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

hashCode

public int hashCode()

Overrides:

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

toString

public String toString()

Overrides:

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