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

Class ModifyPolicyId

java.lang.Object

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

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

All Implemented Interfaces:

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

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

This command modifies the Policy ID of a 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 "Modify Policy ID" 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 ModifyPolicyId	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new ModifyPolicyId from a JSON object.
static ModifyPolicyId	fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new ModifyPolicyId from a JSON string.
Optional<org.eclipse.ditto.json.JsonValue>	getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
String	getPolicyId() Returns the new Policy ID.
org.eclipse.ditto.json.JsonPointer	getResourcePath()
org.eclipse.ditto.model.base.json.JsonSchemaVersion[]	getSupportedSchemaVersions() ModifyPolicyId is only available in JsonSchemaVersion V_2.
String	getThingId()
int	hashCode()
static ModifyPolicyId	of(String thingId, String policyId, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Returns a command for modifying an attribute which is passed as argument.
ModifyPolicyId	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, 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 Policy ID" command.

See Also:

Constant Field Values

TYPE

public static final String TYPE

Type of this command.

See Also:

Constant Field Values

Method Detail

getSupportedSchemaVersions

public org.eclipse.ditto.model.base.json.JsonSchemaVersion[] getSupportedSchemaVersions()

ModifyPolicyId is only available in JsonSchemaVersion V_2.

Specified by:

getSupportedSchemaVersions in interface org.eclipse.ditto.model.base.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>

Returns:

the supported JsonSchemaVersions.

of

public static ModifyPolicyId of(String thingId,
                                String policyId,
                                org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Returns a command for modifying an attribute which is passed as argument.

Parameters:

thingId - the ID of the thing on which to modify the Policy ID.

policyId - the Policy ID to set.

dittoHeaders - the headers of the command.

Returns:

a command for modifying the provided new attribute.

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 ModifyPolicyId fromJson(String jsonString,
                                      org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a new ModifyPolicyId 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 ModifyPolicyId fromJson(org.eclipse.ditto.json.JsonObject jsonObject,
                                      org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

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

getPolicyId

public String getPolicyId()

Returns the new Policy ID.

Returns:

the new Policy ID.

getThingId

public String getThingId()

Specified by:

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

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

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

setDittoHeaders

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

Specified by:

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

Specified by:

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

Specified by:

setDittoHeaders in interface ThingModifyCommand<ModifyPolicyId>

Specified by:

setDittoHeaders in interface ThingCommand<ModifyPolicyId>

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

Returns:

true if authorization would change, false otherwise.

hashCode

public int hashCode()

Overrides:

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

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

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

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

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

toString

public String toString()

Overrides:

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