MatterTraitFactory

class MatterTraitFactory<T : MatterTrait, A : Any> : InternalTraitFactory

Defines the implementation APIs needed for creating traits. Prevents leaking internal implementation of the traits encoding. Example: MatterTraitFactory(Foo.Id, Foo.Adapter, ::Foo)

Summary

Public constructors
`<T : MatterTrait, A : Any> MatterTraitFactory( clusterId: ClusterId, adapter: StructAdapter<A>, traitDescriptor: StructDescriptor, enumAdapters: Map<String, EnumAdapter<>>, bitmapAdapters: Map<String, BitmapAdapter<>>, creator: (Trait.TraitMetadata, MatterTraitClient, A) -> T, supportedEvents: Map<String, EventFactory<*>>, commands: Map<String, CommandDescriptor> )`

Public functions
`T`	`createTrait( payload: TraitElementPayload, metadata: Trait.TraitMetadata, client: MatterTraitClient )` Creates a trait instance attached to the object id specified.
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`open String`	`toString()`

Public properties
`StructAdapter<A>`	`adapter` the struct adapter to read/write attributes
`Map<String, BitmapAdapter<*>>`	`bitmapAdapters`
`ClusterId`	`clusterId` The cluster id that this factory builds.
`Map<String, CommandDescriptor>`	`commands`
`(Trait.TraitMetadata, MatterTraitClient, A) -> T`	`creator` a lambda to create an instance of the Semantic Cluster
`Map<String, EnumAdapter<*>>`	`enumAdapters`
`open Map<String, EventFactory<*>>`	`supportedEvents`
`StructDescriptor`	`@HomeExperimentalApi traitDescriptor`
`open String`	`traitId`

Public constructors

MatterTraitFactory

<T : MatterTrait, A : Any> MatterTraitFactory(
    clusterId: ClusterId,
    adapter: StructAdapter<A>,
    traitDescriptor: StructDescriptor,
    enumAdapters: Map<String, EnumAdapter<*>>,
    bitmapAdapters: Map<String, BitmapAdapter<*>>,
    creator: (Trait.TraitMetadata, MatterTraitClient, A) -> T,
    supportedEvents: Map<String, EventFactory<*>> = emptyMap(),
    commands: Map<String, CommandDescriptor> = emptyMap()
)

Parameters
`clusterId: ClusterId`	The cluster id that this factory builds.
`adapter: StructAdapter<A>`	the struct adapter to read/write attributes
`creator: (Trait.TraitMetadata, MatterTraitClient, A) -> T`	a lambda to create an instance of the Semantic Cluster

Public functions

createTrait

fun createTrait(
    payload: TraitElementPayload,
    metadata: Trait.TraitMetadata,
    client: MatterTraitClient
): T

Creates a trait instance attached to the object id specified. The core object allows calling commands on the trait itself.

Parameters
`payload: TraitElementPayload`	the object as a json payload
`metadata: Trait.TraitMetadata`	metadata to be attached to the trait instance
`client: MatterTraitClient`	the wrapper the trait will use to send commands and write data

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

adapter

val adapter: StructAdapter<A>

the struct adapter to read/write attributes

bitmapAdapters

val bitmapAdapters: Map<String, BitmapAdapter<*>>

clusterId

val clusterId: ClusterId

The cluster id that this factory builds.

commands

val commands: Map<String, CommandDescriptor>

creator

val creator: (Trait.TraitMetadata, MatterTraitClient, A) -> T

a lambda to create an instance of the Semantic Cluster

enumAdapters

val enumAdapters: Map<String, EnumAdapter<*>>

supportedEvents

open val supportedEvents: Map<String, EventFactory<*>>

traitDescriptor

@HomeExperimentalApi
val traitDescriptor: StructDescriptor

traitId

open val traitId: String