Package org.eclipse.ditto.things.model

Interface FeatureProperties

  • All Superinterfaces:
    java.lang.Iterable<org.eclipse.ditto.json.JsonField>, org.eclipse.ditto.base.model.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>, org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelector, org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelectorAndPredicate<org.eclipse.ditto.json.JsonField>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPointer<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.json.JsonObject, org.eclipse.ditto.json.JsonValue, org.eclipse.ditto.json.JsonValueContainer<org.eclipse.ditto.json.JsonField>
    @Immutable
public interface FeatureProperties
extends org.eclipse.ditto.json.JsonObject, org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelectorAndPredicate<org.eclipse.ditto.json.JsonField>
    Represents data related to Features. Properties can be categorized, e. g. to manage the status, the configuration or any fault information. Each property itself can be either a simple (scalar) value or a complex object. Allowed is any JSON object. The FeatureProperties can either represent the desired properties or the actual properties of a Feature.

    • Nested Class Summary

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

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      static FeaturePropertiesBuilder newBuilder()
      Returns a new empty builder for an immutable FeatureProperties.
      FeatureProperties remove​(java.lang.CharSequence key)  
      FeatureProperties set​(org.eclipse.ditto.json.JsonField field)  
      FeatureProperties setAll​(java.lang.Iterable<org.eclipse.ditto.json.JsonField> jsonFields)  
      FeatureProperties setValue​(java.lang.CharSequence key, boolean value)  
      FeatureProperties setValue​(java.lang.CharSequence key, double value)  
      FeatureProperties setValue​(java.lang.CharSequence key, int value)  
      FeatureProperties setValue​(java.lang.CharSequence key, long value)  
      FeatureProperties setValue​(java.lang.CharSequence key, java.lang.String value)  
      FeatureProperties setValue​(java.lang.CharSequence key, org.eclipse.ditto.json.JsonValue value)  
      default FeaturePropertiesBuilder toBuilder()
      Returns a new builder for an immutable FeatureProperties which is initialised with the values of the this FeatureProperties object.
      default org.eclipse.ditto.json.JsonObject toJson​(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion, org.eclipse.ditto.json.JsonFieldSelector fieldSelector)  

      • Methods inherited from interface java.lang.Iterable

        forEach, iterator, spliterator

      • Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable

        getImplementedSchemaVersion, getLatestSchemaVersion, getSupportedSchemaVersions, implementsSchemaVersion, implementsSchemaVersion, toJson, toJsonString

      • Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelector

        toJson, toJson, toJson, toJsonString, toJsonString

      • Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelectorAndPredicate

        toJson, toJson, toJsonString, toJsonString

      • Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable.WithPointer

        toJsonString, toJsonString

      • Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate

        toJson, toJson, toJsonString, toJsonString

      • Methods inherited from interface org.eclipse.ditto.json.JsonObject

        contains, get, get, get, getField, getKeys, getValue, getValue, getValueOrThrow, set

      • Methods inherited from interface org.eclipse.ditto.json.JsonValue

        asArray, asBoolean, asDouble, asInt, asLong, asObject, asString, formatAsString, getUpperBoundForStringSize, isArray, isBoolean, isDouble, isInt, isLong, isNull, isNumber, isObject, isString, toString, writeValue

      • Methods inherited from interface org.eclipse.ditto.json.JsonValueContainer

        getSize, isEmpty, stream

    • Method Detail

      • newBuilder

        static FeaturePropertiesBuilder newBuilder()
        Returns a new empty builder for an immutable FeatureProperties.
        Returns:
        the builder.

      • toBuilder

        default FeaturePropertiesBuilder toBuilder()
        Returns a new builder for an immutable FeatureProperties which is initialised with the values of the this FeatureProperties object.
        Specified by:
        toBuilder in interface org.eclipse.ditto.json.JsonObject
        Returns:
        the new builder.

      • setValue

        FeatureProperties setValue​(java.lang.CharSequence key,
                           int value)
        Specified by:
        setValue in interface org.eclipse.ditto.json.JsonObject

      • setValue

        FeatureProperties setValue​(java.lang.CharSequence key,
                           long value)
        Specified by:
        setValue in interface org.eclipse.ditto.json.JsonObject

      • setValue

        FeatureProperties setValue​(java.lang.CharSequence key,
                           double value)
        Specified by:
        setValue in interface org.eclipse.ditto.json.JsonObject

      • setValue

        FeatureProperties setValue​(java.lang.CharSequence key,
                           boolean value)
        Specified by:
        setValue in interface org.eclipse.ditto.json.JsonObject

      • setValue

        FeatureProperties setValue​(java.lang.CharSequence key,
                           java.lang.String value)
        Specified by:
        setValue in interface org.eclipse.ditto.json.JsonObject

      • setValue

        FeatureProperties setValue​(java.lang.CharSequence key,
                           org.eclipse.ditto.json.JsonValue value)
        Specified by:
        setValue in interface org.eclipse.ditto.json.JsonObject

      • set

        FeatureProperties set​(org.eclipse.ditto.json.JsonField field)
        Specified by:
        set in interface org.eclipse.ditto.json.JsonObject

      • setAll

        FeatureProperties setAll​(java.lang.Iterable<org.eclipse.ditto.json.JsonField> jsonFields)
        Specified by:
        setAll in interface org.eclipse.ditto.json.JsonObject

      • remove

        FeatureProperties remove​(java.lang.CharSequence key)
        Specified by:
        remove in interface org.eclipse.ditto.json.JsonObject

      • toJson

        default org.eclipse.ditto.json.JsonObject toJson​(org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion,
                                                 org.eclipse.ditto.json.JsonFieldSelector fieldSelector)
        Specified by:
        toJson in interface org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelector