ClassToValueDecorator Class

Base class for Context-based decoration, specifically where the instance being decorated (InstanceT ) is a class type, but the data being used as a decoration (DecorationT ) is not.

Automatically removes decorations when the decorated instance is cleaned up.

Others

InstanceT

The type of the instance being decorated

DecorationT

The type of the decoration being added to instances

As with the ClassToClassDecorator<InstanceT, DecorationT>, decorating instances using a ClassToValueDecorator is a non-invasive operation which will not alter the lifespan or other behavior of the decorated instance.

Protected Functions

ClassToValueDecorator ( )

Member Functions

void AddDecoration

( InstanceT instance,

DecorationT decoration )

Associates an instance with a decoration.

If this instance was already decorated, the old decoration is removed. If there were any outstanding asynchronous requests for the decoration of this instance (from prior calls to GetDecorationAsync(InstanceT), those requests will be fulfilled as part of this operation.

Parameters

instance

The instance to be decorated

decoration

The decoration to be added to this instance

void RemoveDecoration

( InstanceT instance )

Removes the association between an instance and a decoration.

If this instance had no decoration, this does nothing. If a decoration was removed, note that GetDecorationAsync(InstanceT) will resume returning uncompleted tasks for this instance, which will be completed if and when the instance is decorated again.

Parameters

instance

The instance from which decoration should be removed

bool TryGetDecoration

( InstanceT instance,

out DecorationT decoration )

Synchronously retrieves the decoration associated with an instance, if one is available.

Parameters

instance

The instance for which to retrieve the decoration

decoration

Out parameter to be populated with the decoration if one exists, otherwise null

Returns

True if decoration was populated with a valid decoration, otherwise false

Task< DecorationT > GetDecorationAsync

( InstanceT instance )

Asynchronously retrieves the decoration associated with an instance.

If the instance already has a decoration, the returned task is immediately completed with the currently-available decoration. If no decoration is yet available for this instance, the returned task will only be completed during the call to AddDecoration(InstanceT, DecorationT) for the instance in question.

Parameters

instance

The instance for which to retrieve the decoration

Returns

A task resulting in the decoration associated with instance

Did you find this page helpful?