ImmutableListT Class

A list that can be modified until IsReadOnly is set to true. Once this occurs, the list itself can no longer be modified. Remember, this does not cause objects contained in this class to be Immutable unless they implement IImmutableObject.

Inheritance Hierarchy

SystemObject
GSF.ImmutableImmutableObjectBaseImmutableListT
GSF.ImmutableImmutableListT

Namespace: GSF.Immutable
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.218-beta+101eee949414e414795e55a6e73d88938f0177b8

Syntax

C++

JavaScript

Copy

public class ImmutableList<T> : ImmutableObjectBase<ImmutableList<T>>, 
	IList<T>, ICollection<T>, IEnumerable<T>, IEnumerable

Public Class ImmutableList(Of T)
	Inherits ImmutableObjectBase(Of ImmutableList(Of T))
	Implements IList(Of T), ICollection(Of T), 
	IEnumerable(Of T), IEnumerable

generic<typename T>
public ref class ImmutableList : public ImmutableObjectBase<ImmutableList<T>^>, 
	IList<T>, ICollection<T>, IEnumerable<T>, IEnumerable

type ImmutableList<'T> = 
    class
        inherit ImmutableObjectBase<ImmutableList<'T>>
        interface IList<'T>
        interface ICollection<'T>
        interface IEnumerable<'T>
        interface IEnumerable
    end

JavaScript does not support generic types or methods.

View Source

Type Parameters

T

The ImmutableListT type exposes the following members.

Constructors

	Name	Description
	ImmutableListT(FuncT, T)	Creates a new ImmutableListT.
	ImmutableListT(Int32, FuncT, T)	Creates a new ImmutableListT.

Top

Properties

	Name	Description
	Count	Gets the number of elements contained in the ICollectionT.
	IsReadOnly	Gets/Sets if this class is immutable and thus read only. Once setting to readonly, the class becomes immutable. (Inherited from ImmutableObjectBaseT)
	Item	Gets or sets the element at the specified index.

Top

Methods

	Name	Description
	Add	Adds an item to the ICollectionT.
	AddRange	Adds the elements of the specified collection to the end of the ListT.
	Clear	Removes all items from the collection.
	Clone	Returns a clone of this class. If the class is marked as readonly, it returns the current instance. (Inherited from ImmutableObjectBaseT)
	CloneEditable	Creates a clone of this class that is editable. A clone is always created, even if this class is already editable. (Inherited from ImmutableObjectBaseT)
	CloneMembersAsEditable	Request that member fields be cloned and marked as editable. (Overrides ImmutableObjectBaseTCloneMembersAsEditable)
	CloneReadonly	Makes a readonly clone of the object. If the class is currently marked as readonly, the current instance is returned. (Inherited from ImmutableObjectBaseT)
	Contains	Determines whether the ICollectionT contains a specific value.
	CopyTo	Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IndexOf	Determines the index of a specific item in the IListT.
	Insert	Inserts an item to the IListT at the specified index.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	Remove	Removes the first occurrence of a specific object from the ICollectionT.
	RemoveAt	Removes the IListT item at the specified index.
	SetMembersAsReadOnly	Requests that member fields be set to readonly. (Overrides ImmutableObjectBaseTSetMembersAsReadOnly)
	TestForEditable	Test if the class has been marked as readonly. Throws an exception if editing cannot occur. (Inherited from ImmutableObjectBaseT)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	AddRangeT	Adds the specified items to the collection. (Defined by CollectionExtensions)
	AllParallelT	Determines whether all elements of a sequence satisfy a condition with each item being tested in parallel. (Defined by CollectionExtensions)
	DistinctByT, TKey	Returns only the elements whose keys are distinct. (Defined by CollectionExtensions)
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetRangeT	Returns elements in the specified range from the collection. (Defined by CollectionExtensions)
	IndexOfT	Returns the index of the first element of the sequence that satisfies a condition or -1 if no such element is found. (Defined by CollectionExtensions)
	LoadDelimitedStringT	Appends items parsed from delimited string, created with ToDelimitedString, using the default delimiter ("\|") into the given list. (Defined by CollectionExtensions)
	LoadDelimitedStringT	Appends items parsed from delimited string, created with ToDelimitedString, into the given list. (Defined by CollectionExtensions)
	LoadDelimitedStringT	Appends items parsed from delimited string, created with ToDelimitedString, into the given list. (Defined by CollectionExtensions)
	MajorityT	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityT	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByT, TKey	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByT, TKey	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MaxT	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxT	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxByT, TKey	Selects the largest item from the enumeration. (Defined by CollectionExtensions)
	MedianT	Gets the median item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	MiddleT	Gets the middle item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	MinT	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinT	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinByT, TKey	Selects the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinorityT	Returns the minority value in the collection, or default type value if no item represents the minority. (Defined by CollectionExtensions)
	MinorityT	Returns the minority value in the collection, or defaultValue if no item represents the minority. (Defined by CollectionExtensions)
	MinorityByT, TKey	Returns the minority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MinorityByT, TKey	Returns the minority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	ScrambleT	Rearranges all the elements in the list into a highly-random order. (Defined by CollectionExtensions)
	ScrambleT	Rearranges all the elements in the list into a repeatable pseudo-random order. (Defined by CollectionExtensions)
	StandardDeviationT	Computes the standard deviation over a sequence of Double values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationT	Computes the standard deviation over a sequence of Decimal values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationT	Computes the standard deviation over a sequence of Single values. (Defined by NumericalAnalysisExtensions)
	ToDelimitedStringT	Converts an enumeration to a string, using the default delimiter ("\|") that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringT	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringT	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToPagedListT	Gets a PagedListT to paginate source enumeration for a given page and specified pageSize. (Defined by CollectionExtensions)
	UnscrambleT	Rearranges all the elements in the list previously scrambled with ScrambleTSource(IListTSource, Int32) back into their original order. (Defined by CollectionExtensions)
	UpdateRangeT	Updates collection starting at the index with the specified items. (Defined by CollectionExtensions)

Top

Reference

GSF.Immutable Namespace