Interface ICollectionVariable<TKey, TElement, TValidationResult>

Namespace

LfrlAnvil.Reactive.State

Assembly

LfrlAnvil.Reactive.State.dll

Represents a generic collection variable.

public interface ICollectionVariable<TKey, TElement, TValidationResult> : IReadOnlyCollectionVariable<TKey, TElement, TValidationResult>, IReadOnlyCollectionVariable<TKey, TElement>, IReadOnlyCollectionVariable, IVariableNode where TKey : notnull where TElement : notnull

Type Parameters

TKey

Key type.

TElement

Element type.

TValidationResult

Validation result type.

Inherited Members

IReadOnlyCollectionVariable<TKey, TElement, TValidationResult>.Errors

IReadOnlyCollectionVariable<TKey, TElement, TValidationResult>.Warnings

IReadOnlyCollectionVariable<TKey, TElement, TValidationResult>.Elements

IReadOnlyCollectionVariable<TKey, TElement, TValidationResult>.ErrorsValidator

IReadOnlyCollectionVariable<TKey, TElement, TValidationResult>.WarningsValidator

IReadOnlyCollectionVariable<TKey, TElement, TValidationResult>.OnChange

IReadOnlyCollectionVariable<TKey, TElement, TValidationResult>.OnValidate

IReadOnlyCollectionVariable<TKey, TElement>.KeySelector

IReadOnlyCollectionVariable<TKey, TElement>.Elements

IReadOnlyCollectionVariable<TKey, TElement>.InitialElements

IReadOnlyCollectionVariable<TKey, TElement>.OnChange

IReadOnlyCollectionVariable.KeyType

IReadOnlyCollectionVariable.ElementType

IReadOnlyCollectionVariable.ValidationResultType

IReadOnlyCollectionVariable.Elements

IReadOnlyCollectionVariable.InitialElements

IReadOnlyCollectionVariable.Errors

IReadOnlyCollectionVariable.Warnings

IReadOnlyCollectionVariable.OnChange

IReadOnlyCollectionVariable.OnValidate

IVariableNode.Parent

IVariableNode.State

IVariableNode.GetChildren()

Extension Methods

VariableNodeExtensions.IsChanged(IVariableNode)

VariableNodeExtensions.IsDirty(IVariableNode)

VariableNodeExtensions.IsDisposed(IVariableNode)

VariableNodeExtensions.IsInvalid(IVariableNode)

VariableNodeExtensions.IsReadOnly(IVariableNode)

VariableNodeExtensions.IsWarning(IVariableNode)

Methods

Add(IEnumerable<TElement>)

Adds a collection of elements to this collection.

VariableChangeResult Add(IEnumerable<TElement> elements)

Parameters

elements IEnumerable<TElement>

Collection of elements to add.

Returns

VariableChangeResult

Result of this change attempt.

Add(TElement)

Adds an element to this collection.

VariableChangeResult Add(TElement element)

Parameters

element TElement

Element to add.

Returns

VariableChangeResult

Result of this change attempt.

AddOrReplace(IEnumerable<TElement>)

Adds or replaces a collection of elements in this collection.

VariableChangeResult AddOrReplace(IEnumerable<TElement> elements)

Parameters

elements IEnumerable<TElement>

Collection of elements to add or to replace with.

Returns

VariableChangeResult

Result of this change attempt.

AddOrReplace(TElement)

Adds or replaces an element in this collection.

VariableChangeResult AddOrReplace(TElement element)

Parameters

element TElement

Element to add or to replace with.

Returns

VariableChangeResult

Result of this change attempt.

AddOrTryReplace(IEnumerable<TElement>)

Adds or attempts to replace a collection of elements in this collection. Existing elements will not be replaced when they and their replacements are considered to be equal.

VariableChangeResult AddOrTryReplace(IEnumerable<TElement> elements)

Parameters

elements IEnumerable<TElement>

Collection of elements to add or to replace with.

Returns

VariableChangeResult

Result of this change attempt.

AddOrTryReplace(TElement)

Adds or attempts to replace an element in this collection. Existing elements will not be replaced when they and their replacements are considered to be equal.

VariableChangeResult AddOrTryReplace(TElement element)

Parameters

element TElement

Element to add or to replace with.

Returns

VariableChangeResult

Result of this change attempt.

Change(IEnumerable<TElement>)

Changes the Elements. Elements that exist and are considered equal are registered as replaced.

VariableChangeResult Change(IEnumerable<TElement> elements)

Parameters

elements IEnumerable<TElement>

Elements to set.

Returns

VariableChangeResult

Result of this change attempt.

Clear()

Removes all elements from this collection.

VariableChangeResult Clear()

Returns

VariableChangeResult

Result of this change attempt.

ClearValidation()

Removes all errors and warnings from this variable.

void ClearValidation()

ClearValidation(IEnumerable<TKey>)

Clears validation of elements associated with the provided collection keys.

void ClearValidation(IEnumerable<TKey> keys)

Parameters

keys IEnumerable<TKey>

Collection of keys to refresh.

ClearValidation(TKey)

Clears validation of an element associated with the provided key.

void ClearValidation(TKey key)

Parameters

key TKey

Key to refresh.

Refresh()

Refreshes this variable.

void Refresh()

Refresh(IEnumerable<TKey>)

Refreshes elements associated with the provided collection keys.

void Refresh(IEnumerable<TKey> keys)

Parameters

keys IEnumerable<TKey>

Collection of keys to refresh.

Refresh(TKey)

Refreshes an element associated with the provided key.

void Refresh(TKey key)

Parameters

key TKey

Key to refresh.

RefreshValidation()

Refreshes this variable's validation.

void RefreshValidation()

RefreshValidation(IEnumerable<TKey>)

Refreshes validation of elements associated with the provided collection keys.

void RefreshValidation(IEnumerable<TKey> keys)

Parameters

keys IEnumerable<TKey>

Collection of keys to refresh.

RefreshValidation(TKey)

Refreshes validation of an element associated with the provided key.

void RefreshValidation(TKey key)

Parameters

key TKey

Key to refresh.

Remove(IEnumerable<TKey>)

Removes elements associated with the provided collection of keys.

VariableChangeResult Remove(IEnumerable<TKey> keys)

Parameters

keys IEnumerable<TKey>

Collection of keys to remove.

Returns

VariableChangeResult

Result of this change attempt.

Remove(TKey)

Removes an element associated with the provided key.

VariableChangeResult Remove(TKey key)

Parameters

key TKey

Key to remove.

Returns

VariableChangeResult

Result of this change attempt.

Replace(IEnumerable<TElement>)

Replaces a collection of existing elements in this collection.

VariableChangeResult Replace(IEnumerable<TElement> elements)

Parameters

elements IEnumerable<TElement>

Collection of element replacements.

Returns

VariableChangeResult

Result of this change attempt.

Replace(TElement)

Replaces an existing element in this collection.

VariableChangeResult Replace(TElement element)

Parameters

element TElement

Element's replacement.

Returns

VariableChangeResult

Result of this change attempt.

TryChange(IEnumerable<TElement>)

Attempts to change the Elements. Elements that exist and are considered equal are registered as refreshed.

VariableChangeResult TryChange(IEnumerable<TElement> elements)

Parameters

elements IEnumerable<TElement>

Elements to set.

Returns

VariableChangeResult

Result of this change attempt.

TryReplace(IEnumerable<TElement>)

Replaces a collection of existing elements in this collection, unless they and their replacements are considered to be equal.

VariableChangeResult TryReplace(IEnumerable<TElement> elements)

Parameters

elements IEnumerable<TElement>

Collection of element replacements.

Returns

VariableChangeResult

Result of this change attempt.

TryReplace(TElement)

Attempts to replace an existing element in this collection, unless it and its replacement are considered to be equal.

VariableChangeResult TryReplace(TElement element)

Parameters

element TElement

Element's replacement.

Returns

VariableChangeResult

Result of this change attempt.