View Source

Class ConcurrentHashSet<T>

A thread-safe representation of a System.Collections.Generic.HashSet<T>. Enumerating this collection is thread-safe and will only operate on a clone that is generated before returning the enumerator.

Inheritance

System.Object

Namespace: Umbraco.Core.Collections

Assembly: Umbraco.Core.dll

Syntax

[Serializable]
public class ConcurrentHashSet<T> : ICollection<T>, IEnumerable<T>, IEnumerable

Type Parameters

Name	Description
T

Properties

Count

Gets the number of elements contained in the System.Collections.ICollection.

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32	The number of elements contained in the System.Collections.ICollection.

IsReadOnly

Gets a value indicating whether the System.Collections.Generic.ICollection<T> is read-only.

Declaration

public bool IsReadOnly { get; }

Property Value

Type	Description
System.Boolean	true if the System.Collections.Generic.ICollection<T> is read-only; otherwise, false.

Methods

Add(T)

Adds an item to the System.Collections.Generic.ICollection<T>.

Declaration

public void Add(T item)

Parameters

Type	Name	Description
T	item	The object to add to the System.Collections.Generic.ICollection<T>.

Exceptions

Type	Condition
System.NotSupportedException	The System.Collections.Generic.ICollection<T> is read-only.

Clear()

Removes all items from the System.Collections.Generic.ICollection<T>.

Declaration

public void Clear()

Exceptions

Type	Condition
System.NotSupportedException	The System.Collections.Generic.ICollection<T> is read-only.

Contains(T)

Determines whether the System.Collections.Generic.ICollection<T> contains a specific value.

Declaration

public bool Contains(T item)

Parameters

Type	Name	Description
T	item	The object to locate in the System.Collections.Generic.ICollection<T>.

Returns

Type	Description
System.Boolean	true if item is found in the System.Collections.Generic.ICollection<T>; otherwise, false.

CopyTo(T[], Int32)

Copies the elements of the System.Collections.Concurrent.IProducerConsumerCollection`1 to an System.Array, starting at a specified index.

Declaration

public void CopyTo(T[] array, int index)

Parameters

Type	Name	Description
T[]	array	The one-dimensional System.Array that is the destination of the elements copied from the System.Collections.Concurrent.IProducerConsumerCollection`1. The array must have zero-based indexing.
System.Int32	index	The zero-based index in array at which copying begins.

Exceptions

Type	Condition
System.ArgumentNullException	array is a null reference (Nothing in Visual Basic).
System.ArgumentOutOfRangeException	index is less than zero.
System.ArgumentException	index is equal to or greater than the length of the array -or- The number of elements in the source System.Collections.Concurrent.ConcurrentQueue`1 is greater than the available space from index to the end of the destination array.

CopyTo(Array, Int32)

Copies the elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index.

Declaration

public void CopyTo(Array array, int index)

Parameters

Type	Name	Description
System.Array	array	The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing.
System.Int32	index	The zero-based index in array at which copying begins.

Exceptions

Type	Condition
System.ArgumentNullException	array is null.
System.ArgumentOutOfRangeException	index is less than zero.
System.ArgumentException	array is multidimensional.-or- The number of elements in the source System.Collections.ICollection is greater than the available space from index to the end of the destination array.
System.ArgumentException	The type of the source System.Collections.ICollection cannot be cast automatically to the type of the destination array.

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

public IEnumerator<T> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<T>	A System.Collections.Generic.IEnumerator<T> that can be used to iterate through the collection.

Remove(T)

Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection<T>.

Declaration

public bool Remove(T item)

Parameters

Type	Name	Description
T	item	The object to remove from the System.Collections.Generic.ICollection<T>.

Returns

Type	Description
System.Boolean	true if item was successfully removed from the System.Collections.Generic.ICollection<T>; otherwise, false. This method also returns false if item is not found in the original System.Collections.Generic.ICollection<T>.

Exceptions

Type	Condition
System.NotSupportedException	The System.Collections.Generic.ICollection<T> is read-only.

TryAdd(T)

Attempts to add an item to the collection

Declaration

public bool TryAdd(T item)

Parameters

Type	Name	Description
T	item

Returns

Type	Description
System.Boolean