Class ModifyFeatures
- java.lang.Object
-
- org.eclipse.ditto.signals.commands.base.AbstractCommand<ModifyFeatures>
-
- org.eclipse.ditto.signals.commands.things.modify.ModifyFeatures
-
- All Implemented Interfaces:
org.eclipse.ditto.model.base.entity.type.WithEntityType
,org.eclipse.ditto.model.base.headers.WithDittoHeaders<ModifyFeatures>
,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.model.things.WithThingId
,org.eclipse.ditto.signals.base.Signal<ModifyFeatures>
,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.WithType
,org.eclipse.ditto.signals.commands.base.Command<ModifyFeatures>
,ThingModifyCommand<ModifyFeatures>
,ThingCommand<ModifyFeatures>
public final class ModifyFeatures extends org.eclipse.ditto.signals.commands.base.AbstractCommand<ModifyFeatures> implements ThingModifyCommand<ModifyFeatures>
This command modifies all existing Features of a Thing.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.eclipse.ditto.signals.commands.base.Command
org.eclipse.ditto.signals.commands.base.Command.Category, org.eclipse.ditto.signals.commands.base.Command.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 extends Object>, 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 extends Object>
-
Nested classes/interfaces inherited from interface org.eclipse.ditto.signals.commands.things.ThingCommand
ThingCommand.JsonFields
-
-
Field Summary
Fields Modifier and Type Field Description static String
NAME
Name of the "Modify Features" command.static String
TYPE
Type of this command.-
Fields inherited from interface org.eclipse.ditto.signals.commands.things.ThingCommand
RESOURCE_TYPE, TYPE_PREFIX
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method 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 ModifyFeatures
fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newModifyFeatures
from a JSON string.static ModifyFeatures
fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newModifyFeatures
from a JSON object.org.eclipse.ditto.signals.commands.base.Command.Category
getCategory()
Optional<org.eclipse.ditto.json.JsonValue>
getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
org.eclipse.ditto.model.things.Features
getFeatures()
Returns the newFeatures
to modify.org.eclipse.ditto.json.JsonPointer
getResourcePath()
org.eclipse.ditto.model.things.ThingId
getThingEntityId()
int
hashCode()
static ModifyFeatures
of(String thingId, org.eclipse.ditto.model.things.Features features, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Deprecated.Thing ID is now typed.static ModifyFeatures
of(org.eclipse.ditto.model.things.ThingId thingId, org.eclipse.ditto.model.things.Features features, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Returns a Command for modifying the Features of a Thing.ModifyFeatures
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.base.Command
getImplementedSchemaVersion, toJson, toJson
-
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.json.Jsonifiable.WithPredicate
toJson, toJsonString, toJsonString
-
Methods inherited from interface org.eclipse.ditto.signals.commands.things.ThingCommand
getEntityId, getEntityType, getResourceType, getTypePrefix
-
-
-
-
Field Detail
-
NAME
public static final String NAME
Name of the "Modify Features" command.- See Also:
- Constant Field Values
-
TYPE
public static final String TYPE
Type of this command.- See Also:
- Constant Field Values
-
-
Method Detail
-
of
@Deprecated public static ModifyFeatures of(String thingId, org.eclipse.ditto.model.things.Features features, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Deprecated.Thing ID is now typed. Useof(org.eclipse.ditto.model.things.ThingId, org.eclipse.ditto.model.things.Features, org.eclipse.ditto.model.base.headers.DittoHeaders)
instead.Returns a Command for modifying the Features of a Thing.- Parameters:
thingId
- the ID of theThing
on which theFeatures
to modify.features
- theFeatures
to modify.dittoHeaders
- the headers of the command.- Returns:
- a Command for modifying the provided Features.
- Throws:
NullPointerException
- if any argument butthingId
isnull
.
-
of
public static ModifyFeatures of(org.eclipse.ditto.model.things.ThingId thingId, org.eclipse.ditto.model.things.Features features, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Returns a Command for modifying the Features of a Thing.- Parameters:
thingId
- the ID of theThing
on which theFeatures
to modify.features
- theFeatures
to modify.dittoHeaders
- the headers of the command.- Returns:
- a Command for modifying the provided Features.
- Throws:
NullPointerException
- if any argument butthingId
isnull
.
-
fromJson
public static ModifyFeatures fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newModifyFeatures
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 isnull
.IllegalArgumentException
- ifjsonString
is empty.org.eclipse.ditto.json.JsonParseException
- if the passed injsonString
was not in the expected format.org.eclipse.ditto.model.things.ThingIdInvalidException
- if the parsed thing ID did not comply toRegexPatterns.ID_REGEX
.
-
fromJson
public static ModifyFeatures fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newModifyFeatures
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 isnull
.org.eclipse.ditto.json.JsonParseException
- if the passed injsonObject
was not in the expected format.org.eclipse.ditto.model.things.ThingIdInvalidException
- if the parsed thing ID did not comply toRegexPatterns.ID_REGEX
.
-
getFeatures
public org.eclipse.ditto.model.things.Features getFeatures()
Returns the newFeatures
to modify.- Returns:
- the Features to modify.
-
getThingEntityId
public org.eclipse.ditto.model.things.ThingId getThingEntityId()
- Specified by:
getThingEntityId
in interfaceorg.eclipse.ditto.model.things.WithThingId
-
getEntity
public Optional<org.eclipse.ditto.json.JsonValue> getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
- Specified by:
getEntity
in interfaceorg.eclipse.ditto.signals.base.WithOptionalEntity
-
getResourcePath
public org.eclipse.ditto.json.JsonPointer getResourcePath()
- Specified by:
getResourcePath
in interfaceorg.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 classorg.eclipse.ditto.signals.commands.base.AbstractCommand<ModifyFeatures>
-
getCategory
public org.eclipse.ditto.signals.commands.base.Command.Category getCategory()
- Specified by:
getCategory
in interfaceorg.eclipse.ditto.signals.commands.base.Command<ModifyFeatures>
-
setDittoHeaders
public ModifyFeatures setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.signals.commands.base.Command<ModifyFeatures>
- Specified by:
setDittoHeaders
in interfaceThingCommand<ModifyFeatures>
- Specified by:
setDittoHeaders
in interfaceThingModifyCommand<ModifyFeatures>
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.model.base.headers.WithDittoHeaders<ModifyFeatures>
-
changesAuthorization
public boolean changesAuthorization()
Description copied from interface:ThingModifyCommand
Checks whether this command may change authorization of the Thing.- Specified by:
changesAuthorization
in interfaceThingModifyCommand<ModifyFeatures>
- Returns:
true
if authorization would change,false
otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<ModifyFeatures>
-
equals
public boolean equals(@Nullable Object obj)
- Overrides:
equals
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<ModifyFeatures>
-
canEqual
protected boolean canEqual(@Nullable Object other)
- Overrides:
canEqual
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<ModifyFeatures>
-
toString
public String toString()
- Overrides:
toString
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<ModifyFeatures>
-
-