Class RetrieveAttribute
- java.lang.Object
-
- org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveAttribute>
-
- org.eclipse.ditto.signals.commands.things.query.RetrieveAttribute
-
- All Implemented Interfaces:
org.eclipse.ditto.model.base.entity.type.WithEntityType
,org.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveAttribute>
,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<RetrieveAttribute>
,org.eclipse.ditto.signals.base.WithId
,org.eclipse.ditto.signals.base.WithName
,org.eclipse.ditto.signals.base.WithResource
,org.eclipse.ditto.signals.base.WithType
,org.eclipse.ditto.signals.commands.base.Command<RetrieveAttribute>
,ThingQueryCommand<RetrieveAttribute>
,ThingCommand<RetrieveAttribute>
@Immutable public final class RetrieveAttribute extends org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveAttribute> implements ThingQueryCommand<RetrieveAttribute>
Command which retrieves a single attribute of aThing
based on the passed in ID and a JSON pointer.
-
-
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 retrieve "Retrieve Thing Attribute" 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
equals(Object obj)
static RetrieveAttribute
fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newRetrieveAttribute
from a JSON string.static RetrieveAttribute
fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newRetrieveAttribute
from a JSON object.org.eclipse.ditto.json.JsonPointer
getAttributePointer()
Returns the JSON pointer of the attribute to retrieve.org.eclipse.ditto.json.JsonPointer
getResourcePath()
org.eclipse.ditto.model.things.ThingId
getThingEntityId()
int
hashCode()
static RetrieveAttribute
of(String thingId, org.eclipse.ditto.json.JsonPointer attributeJsonPointer, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Deprecated.Thing ID is now typed.static RetrieveAttribute
of(org.eclipse.ditto.model.things.ThingId thingId, org.eclipse.ditto.json.JsonPointer attributeJsonPointer, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Returns a command for retrieving an attribute of a Thing with the given ID.RetrieveAttribute
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
-
Methods inherited from interface org.eclipse.ditto.signals.commands.things.query.ThingQueryCommand
getCategory, getSelectedFields
-
-
-
-
Field Detail
-
NAME
public static final String NAME
Name of the retrieve "Retrieve Thing Attribute" 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 RetrieveAttribute of(String thingId, org.eclipse.ditto.json.JsonPointer attributeJsonPointer, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Deprecated.Thing ID is now typed. Useof(org.eclipse.ditto.model.things.ThingId, org.eclipse.ditto.json.JsonPointer, org.eclipse.ditto.model.base.headers.DittoHeaders)
instead.Returns a command for retrieving an attribute of a Thing with the given ID.- Parameters:
thingId
- the ID of a single Thing from which a single attribute will be retrieved by this command.attributeJsonPointer
- defines one JSON pointer of the attribute to retrieve.dittoHeaders
- the headers of the command.- Returns:
- a Command for retrieving a single attribute of the Thing with the
thingId
as its ID which is readable from the passed authorization context. - Throws:
NullPointerException
- if any argument butthingId
isnull
.org.eclipse.ditto.json.JsonKeyInvalidException
- if keys ofattributeJsonPointer
are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
of
public static RetrieveAttribute of(org.eclipse.ditto.model.things.ThingId thingId, org.eclipse.ditto.json.JsonPointer attributeJsonPointer, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Returns a command for retrieving an attribute of a Thing with the given ID.- Parameters:
thingId
- the ID of a single Thing from which a single attribute will be retrieved by this command.attributeJsonPointer
- defines one JSON pointer of the attribute to retrieve.dittoHeaders
- the headers of the command.- Returns:
- a Command for retrieving a single attribute of the Thing with the
thingId
as its ID which is readable from the passed authorization context. - Throws:
NullPointerException
- if any argument butthingId
isnull
.org.eclipse.ditto.json.JsonKeyInvalidException
- if keys ofattributeJsonPointer
are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
fromJson
public static RetrieveAttribute fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newRetrieveAttribute
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
.org.eclipse.ditto.json.JsonKeyInvalidException
- if keys of attribute pointer are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
fromJson
public static RetrieveAttribute fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newRetrieveAttribute
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
.org.eclipse.ditto.json.JsonKeyInvalidException
- if keys of attribute pointer are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
getAttributePointer
public org.eclipse.ditto.json.JsonPointer getAttributePointer()
Returns the JSON pointer of the attribute to retrieve.- Returns:
- the JSON pointer.
-
getThingEntityId
public org.eclipse.ditto.model.things.ThingId getThingEntityId()
- Specified by:
getThingEntityId
in interfaceorg.eclipse.ditto.model.things.WithThingId
-
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<RetrieveAttribute>
-
setDittoHeaders
public RetrieveAttribute setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.signals.commands.base.Command<RetrieveAttribute>
- Specified by:
setDittoHeaders
in interfaceThingCommand<RetrieveAttribute>
- Specified by:
setDittoHeaders
in interfaceThingQueryCommand<RetrieveAttribute>
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveAttribute>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveAttribute>
-
equals
public boolean equals(@Nullable Object obj)
- Overrides:
equals
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveAttribute>
-
canEqual
protected boolean canEqual(@Nullable Object other)
- Overrides:
canEqual
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveAttribute>
-
toString
public String toString()
- Overrides:
toString
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveAttribute>
-
-