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

Class RetrieveAttribute

  • 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<RetrieveAttribute>, 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<RetrieveAttribute>, org.eclipse.ditto.base.model.signals.Signal<RetrieveAttribute>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<RetrieveAttribute>, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType, ThingQueryCommand<RetrieveAttribute>, ThingCommand<RetrieveAttribute>, WithSelectedFields, WithThingId
    @Immutable
public final class RetrieveAttribute
extends org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveAttribute>
implements ThingQueryCommand<RetrieveAttribute>
    Command which retrieves a single attribute of a Thing based on the passed in ID and a JSON pointer.

    • 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 java.lang.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 java.lang.Object>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String NAME
      Name of the retrieve "Retrieve Thing Attribute" command.
      static java.lang.String TYPE
      Type of this command.

      • Fields inherited from interface org.eclipse.ditto.base.model.signals.commands.Command

        TYPE_QUALIFIER

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void appendPayload​(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion, java.util.function.Predicate<org.eclipse.ditto.json.JsonField> thePredicate)  
      protected boolean canEqual​(java.lang.Object other)  
      boolean equals​(java.lang.Object obj)  
      static RetrieveAttribute fromJson​(java.lang.String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new RetrieveAttribute from a JSON string.
      static RetrieveAttribute fromJson​(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new RetrieveAttribute from a JSON object.
      org.eclipse.ditto.json.JsonPointer getAttributePointer()
      Returns the JSON pointer of the attribute to retrieve.
      ThingId getEntityId()  
      org.eclipse.ditto.json.JsonPointer getResourcePath()  
      int hashCode()  
      static RetrieveAttribute of​(ThingId thingId, org.eclipse.ditto.json.JsonPointer attributeJsonPointer, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Returns a command for retrieving an attribute of a Thing with the given ID.
      RetrieveAttribute setDittoHeaders​(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)  
      java.lang.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.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.WithType

        getType

    • Field Detail

      • NAME

        public static final java.lang.String NAME
        Name of the retrieve "Retrieve Thing Attribute" command.
        See Also:
        Constant Field Values

    • Method Detail

      • of

        public static RetrieveAttribute of​(ThingId thingId,
                                   org.eclipse.ditto.json.JsonPointer attributeJsonPointer,
                                   org.eclipse.ditto.base.model.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:
        java.lang.NullPointerException - if any argument but thingId is null.
        org.eclipse.ditto.json.JsonKeyInvalidException - if keys of attributeJsonPointer are not valid according to pattern RegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN.

      • fromJson

        public static RetrieveAttribute fromJson​(java.lang.String jsonString,
                                         org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Creates a new RetrieveAttribute 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:
        java.lang.NullPointerException - if any argument is null.
        java.lang.IllegalArgumentException - if jsonString is empty.
        org.eclipse.ditto.json.JsonParseException - if the passed in jsonString was not in the expected format.
        ThingIdInvalidException - if the parsed thing ID did not comply to RegexPatterns.ID_REGEX.
        org.eclipse.ditto.json.JsonKeyInvalidException - if keys of attribute pointer are not valid according to pattern RegexPatterns.NO_CONTROL_CHARS_NO_SLASHES_PATTERN.

      • fromJson

        public static RetrieveAttribute fromJson​(org.eclipse.ditto.json.JsonObject jsonObject,
                                         org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Creates a new RetrieveAttribute 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:
        java.lang.NullPointerException - if any argument is null.
        org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected format.
        ThingIdInvalidException - if the parsed thing ID did not comply to RegexPatterns.ID_REGEX.
        org.eclipse.ditto.json.JsonKeyInvalidException - if keys of attribute pointer are not valid according to pattern RegexPatterns.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.

      • getEntityId

        public ThingId getEntityId()
        Specified by:
        getEntityId in interface org.eclipse.ditto.base.model.entity.id.WithEntityId
        Specified by:
        getEntityId in interface WithThingId

      • 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,
                             java.util.function.Predicate<org.eclipse.ditto.json.JsonField> thePredicate)
        Specified by:
        appendPayload in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveAttribute>

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveAttribute>

      • equals

        public boolean equals​(@Nullable
                      java.lang.Object obj)
        Overrides:
        equals in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveAttribute>

      • canEqual

        protected boolean canEqual​(@Nullable
                           java.lang.Object other)
        Overrides:
        canEqual in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveAttribute>

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveAttribute>