@AllValuesAreNonnullByDefault

Package org.eclipse.ditto.things.model

Contains the Things framework around the cornerstone of this package: Thing. A Thing can consist of

• Attributes for describing the Thing in more details,
• and Features for managing all data and functionality of the Thing.

Furthermore a Thing can have a ThingLifecycle and a ThingRevision which is incremented with each change of the Thing.

Object creation

ThingsModelFactory is the main entry point for obtaining objects of this package's interfaces to work with.

Interface Summary

Interface	Description
Attributes	Attributes describe other entities (e.
AttributesBuilder	A mutable builder for a Attributes with a fluent API.
DefinitionIdentifier	This interface represents a single fully qualified Identifier of a Definition both used for Thing and Feature.
Feature	A Feature is used to manage all data and functionality of a Thing that can be clustered in an outlined technical context.
FeatureBuilder	A mutable builder for for a Feature which uses Object Scoping and Method Chaining to provide a fluent API.
FeatureBuilder.FeatureBuildable	This interface eventually allows create a new Feature object.
FeatureBuilder.FromCopyBuildable	A mutable builder with a fluent API for an immutable Feature.
FeatureBuilder.FromJsonBuildable	This interface enables the creation of a Feature object from JSON.
FeatureBuilder.FromScratchBuildable	This interface enables the creation of a Feature object from scratch.
FeatureDefinition	A FeatureDefinition is a list of fully qualified DefinitionIdentifiers.
FeatureDefinitionBuilder	A mutable builder with a fluent API for an immutable FeatureDefinition.
FeatureProperties	Represents data related to Features.
FeaturePropertiesBuilder	A mutable builder for a FeatureProperties with a fluent API.
Features	A collection of a Thing's Features.
FeaturesBuilder	A mutable builder for a Feature with a fluent API.
Thing	A generic entity which can be used as a "handle" for multiple Features belonging to this Thing.
ThingBuilder	Builder for instances of Thing which uses Object Scoping and Method Chaining to provide a convenient usage experience.
ThingBuilder.FromCopy	A mutable builder with a fluent API for an immutable Thing.
ThingBuilder.FromScratch	A mutable builder with a fluent API for an immutable Thing from scratch.
ThingDefinition	A ThingDefinition represents a single fully qualified DefinitionIdentifier.
ThingException	Aggregates all DittoRuntimeExceptions which are related to a Thing.
ThingRevision	Represents the current revision of a Thing.
WithThingId	Implementations of this interface are associated to a Thing identified by the value returned from WithThingId.getEntityId() ()}.

Class Summary

Class	Description
AttributesModelFactory	Factory that creates new attributes objects.
DefinitionIdentifierInvalidException.Builder	A mutable builder with a fluent API for an immutable DefinitionIdentifierInvalidException.
Feature.JsonFields	An enumeration of the known JsonFields of a Feature.
FeatureDefinitionEmptyException.Builder	A mutable builder with a fluent API for an immutable FeatureDefinitionEmptyException.
InvalidThingFieldSelectionException.Builder	A mutable builder with a fluent API for an immutable FeatureDefinitionEmptyException.
PolicyIdMissingException.Builder	A mutable builder with a fluent API for a PolicyIdMissingException.
Thing.JsonFields	An enumeration of the known JsonFields of a Thing.
ThingConstants	Constants to support working with Thing.
ThingFieldSelector	A Json field selector which validates that only valid fields of a thing can be selected.
ThingId	Java representation of a validated Thing ID.
ThingIdInvalidException.Builder	A mutable builder with a fluent API for a ThingIdInvalidException.
ThingsModelFactory	Factory that creates new things objects.
ThingTooLargeException.Builder	A mutable builder with a fluent API for a ThingTooLargeException.

Enum Summary

Enum	Description
ThingLifecycle	An enumeration of a Thing's lifecycle.

Exception Summary

Exception	Description
DefinitionIdentifierInvalidException	This exception is thrown if an Identifier of a Feature Definition has an invalid structure.
FeatureDefinitionEmptyException	This exception is thrown if a Feature Definition was set to an empty array.
InvalidThingFieldSelectionException	Thrown when a ThingFieldSelector was not valid.
PolicyIdMissingException	This exception indicates that a Thing's JsonSchemaVersion requires a policyId.
ThingIdInvalidException	Thrown if the Thing's ID is not valid (for example if it does not comply to the Thing ID REGEX).
ThingTooLargeException	This exception indicates the content of a Thing is too large to be processed by a backend.