Class RetrieveFeatureProperty
- java.lang.Object
-
- org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveFeatureProperty>
-
- org.eclipse.ditto.signals.commands.things.query.RetrieveFeatureProperty
-
- All Implemented Interfaces:
org.eclipse.ditto.model.base.entity.type.WithEntityType
,org.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveFeatureProperty>
,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<RetrieveFeatureProperty>
,org.eclipse.ditto.signals.base.WithFeatureId
,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<RetrieveFeatureProperty>
,ThingQueryCommand<RetrieveFeatureProperty>
,ThingCommand<RetrieveFeatureProperty>
@Immutable public final class RetrieveFeatureProperty extends org.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveFeatureProperty> implements ThingQueryCommand<RetrieveFeatureProperty>, org.eclipse.ditto.signals.base.WithFeatureId
This command retrieves aFeature
's property.
-
-
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 Feature Property" 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 RetrieveFeatureProperty
fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newRetrieveFeatureProperty
from a JSON string.static RetrieveFeatureProperty
fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newRetrieveFeatureProperty
from a JSON object.String
getFeatureId()
org.eclipse.ditto.json.JsonPointer
getPropertyPointer()
Returns the JSON pointer of the Property to retrieve.org.eclipse.ditto.json.JsonPointer
getResourcePath()
org.eclipse.ditto.model.things.ThingId
getThingEntityId()
int
hashCode()
static RetrieveFeatureProperty
of(String thingId, String featureId, org.eclipse.ditto.json.JsonPointer propertyJsonPointer, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Deprecated.Thing ID is now typed.static RetrieveFeatureProperty
of(org.eclipse.ditto.model.things.ThingId thingId, String featureId, org.eclipse.ditto.json.JsonPointer propertyJsonPointer, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Returns a Command for retrieving a Feature's Property on a Thing.RetrieveFeatureProperty
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 Feature Property" 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 RetrieveFeatureProperty of(String thingId, String featureId, org.eclipse.ditto.json.JsonPointer propertyJsonPointer, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Deprecated.Thing ID is now typed. Useof(org.eclipse.ditto.model.things.ThingId, String, org.eclipse.ditto.json.JsonPointer, org.eclipse.ditto.model.base.headers.DittoHeaders)
instead.Returns a Command for retrieving a Feature's Property on a Thing.- Parameters:
thingId
- theThing
's ID whoseFeature
's Property to retrieve.featureId
- theFeature
's ID whose Property to retrieve.propertyJsonPointer
- the JSON pointer of the Property key to retrieve.dittoHeaders
- the headers of the command.- Returns:
- a Command for retrieving the Property at the specified Pointer.
- Throws:
NullPointerException
- if any argument butthingId
isnull
.org.eclipse.ditto.json.JsonKeyInvalidException
- if keys ofpropertyJsonPointer
are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
of
public static RetrieveFeatureProperty of(org.eclipse.ditto.model.things.ThingId thingId, String featureId, org.eclipse.ditto.json.JsonPointer propertyJsonPointer, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Returns a Command for retrieving a Feature's Property on a Thing.- Parameters:
thingId
- theThing
's ID whoseFeature
's Property to retrieve.featureId
- theFeature
's ID whose Property to retrieve.propertyJsonPointer
- the JSON pointer of the Property key to retrieve.dittoHeaders
- the headers of the command.- Returns:
- a Command for retrieving the Property at the specified Pointer.
- Throws:
NullPointerException
- if any argument butthingId
isnull
.org.eclipse.ditto.json.JsonKeyInvalidException
- if keys ofpropertyJsonPointer
are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
fromJson
public static RetrieveFeatureProperty fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newRetrieveFeatureProperty
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 property pointer are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
fromJson
public static RetrieveFeatureProperty fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
Creates a newRetrieveFeatureProperty
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 property pointer are not valid according to patternRegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN
.
-
getPropertyPointer
public org.eclipse.ditto.json.JsonPointer getPropertyPointer()
Returns the JSON pointer of the Property to retrieve.- Returns:
- the JSON pointer of the Property to retrieve.
-
getThingEntityId
public org.eclipse.ditto.model.things.ThingId getThingEntityId()
- Specified by:
getThingEntityId
in interfaceorg.eclipse.ditto.model.things.WithThingId
-
getFeatureId
public String getFeatureId()
- Specified by:
getFeatureId
in interfaceorg.eclipse.ditto.signals.base.WithFeatureId
-
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<RetrieveFeatureProperty>
-
setDittoHeaders
public RetrieveFeatureProperty setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.signals.commands.base.Command<RetrieveFeatureProperty>
- Specified by:
setDittoHeaders
in interfaceThingCommand<RetrieveFeatureProperty>
- Specified by:
setDittoHeaders
in interfaceThingQueryCommand<RetrieveFeatureProperty>
- Specified by:
setDittoHeaders
in interfaceorg.eclipse.ditto.model.base.headers.WithDittoHeaders<RetrieveFeatureProperty>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveFeatureProperty>
-
equals
public boolean equals(@Nullable Object obj)
- Overrides:
equals
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveFeatureProperty>
-
canEqual
protected boolean canEqual(@Nullable Object other)
- Overrides:
canEqual
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveFeatureProperty>
-
toString
public String toString()
- Overrides:
toString
in classorg.eclipse.ditto.signals.commands.base.AbstractCommand<RetrieveFeatureProperty>
-
-