Class CollectionValueBase<T>

Base class for classes implementing ICollectionValue[T]

Inheritance

System.Object

EnumerableBase<T>

CollectionValueBase<T>

CollectionBase<T>

DictionaryBase<K, V>

DirectedCollectionValueBase<T>

Implements

ICollectionValue<T>

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable

IShowable

System.IFormattable

Inherited Members

EnumerableBase<T>.GetEnumerator()

EnumerableBase<T>.countItems(IEnumerable<T>)

EnumerableBase<T>.IEnumerable.GetEnumerator()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Lucene.Net.Support.C5

Assembly: Lucene.Net.dll

Syntax

public abstract class CollectionValueBase<T> : EnumerableBase<T>, ICollectionValue<T>, IEnumerable<T>, IEnumerable, IShowable, IFormattable

Type Parameters

Name	Description
T

Properties

| Improve this Doc View Source

ActiveEvents

A flag bitmap of the events currently subscribed to by this collection.

Declaration

public virtual EventTypeEnum ActiveEvents { get; }

Property Value

Type	Description
EventTypeEnum

| Improve this Doc View Source

Count

The number of items in this collection.

Declaration

public abstract int Count { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

CountSpeed

The value is symbolic indicating the type of asymptotic complexity in terms of the size of this collection (worst-case or amortized as relevant).

Declaration

public abstract Speed CountSpeed { get; }

Property Value

Type	Description
Speed	A characterization of the speed of the `Count` property in this collection.

| Improve this Doc View Source

IsEmpty

Check if collection is empty.

Declaration

public abstract bool IsEmpty { get; }

Property Value

Type	Description
System.Boolean	True if empty

| Improve this Doc View Source

ListenableEvents

Declaration

public virtual EventTypeEnum ListenableEvents { get; }

Property Value

Type	Description
EventTypeEnum

Methods

| Improve this Doc View Source

All(Func<T, Boolean>)

Check if all items in this collection satisfies a specific predicate.

Declaration

public virtual bool All(Func<T, bool> predicate)

Parameters

Type	Name	Description
System.Func<T, System.Boolean>	predicate	A delegate (Func`2 with `R = bool` ) defining the predicate

Returns

Type	Description
System.Boolean	True if all items satisfies the predicate

| Improve this Doc View Source

Apply(Action<T>)

Apply an single argument action, Action`1 to this enumerable

Declaration

public virtual void Apply(Action<T> action)

Parameters

Type	Name	Description
System.Action<T>	action	The action delegate

| Improve this Doc View Source

Choose()

Choose some item of this collection.

Declaration

public abstract T Choose()

Returns

Type	Description
T

Exceptions

Type	Condition
NoSuchItemException	if collection is empty.

| Improve this Doc View Source

CopyTo(T[], Int32)

Copy the items of this collection to part of an array.

Declaration

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

Parameters

Type	Name	Description
T[]	array	The array to copy to.
System.Int32	index	The starting index.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	if `index` is not a valid index into the array (i.e. negative or greater than the size of the array) or the array does not have room for the items.

| Improve this Doc View Source

Exists(Func<T, Boolean>)

Check if there exists an item that satisfies a specific predicate in this collection.

Declaration

public virtual bool Exists(Func<T, bool> predicate)

Parameters

Type	Name	Description
System.Func<T, System.Boolean>	predicate	A delegate (Func`2 with `R = bool` ) defining the predicate

Returns

Type	Description
System.Boolean	True if such an item exists

| Improve this Doc View Source

Filter(Func<T, Boolean>)

Create an enumerable, enumerating the items of this collection that satisfies a certain condition.

Declaration

public virtual IEnumerable<T> Filter(Func<T, bool> predicate)

Parameters

Type	Name	Description
System.Func<T, System.Boolean>	predicate	A delegate (Func`2 with `R = bool` ) defining the predicate

Returns

Type	Description
System.Collections.Generic.IEnumerable<T>	The filtered enumerable

| Improve this Doc View Source

Find(Func<T, Boolean>, out T)

Check if there exists an item that satisfies a specific predicate in this collection and return the first one in enumeration order.

Declaration

public virtual bool Find(Func<T, bool> predicate, out T item)

Parameters

Type	Name	Description
System.Func<T, System.Boolean>	predicate	A delegate (Func`2 with `R == bool` ) defining the predicate
T	item

Returns

Type	Description
System.Boolean	True is such an item exists

| Improve this Doc View Source

raiseCollectionChanged()

Fire the CollectionChanged event

Declaration

protected virtual void raiseCollectionChanged()

| Improve this Doc View Source

raiseCollectionCleared(Boolean, Int32)

Fire the CollectionCleared event

Declaration

protected virtual void raiseCollectionCleared(bool full, int count)

Parameters

Type	Name	Description
System.Boolean	full
System.Int32	count

| Improve this Doc View Source

raiseCollectionCleared(Boolean, Int32, Nullable<Int32>)

Fire the CollectionCleared event

Declaration

protected virtual void raiseCollectionCleared(bool full, int count, int? offset)

Parameters

Type	Name	Description
System.Boolean	full
System.Int32	count
System.Nullable<System.Int32>	offset

| Improve this Doc View Source

raiseForAdd(T)

Declaration

protected virtual void raiseForAdd(T item)

Parameters

Type	Name	Description
T	item

| Improve this Doc View Source

raiseForInsert(Int32, T)

Declaration

protected virtual void raiseForInsert(int i, T item)

Parameters

Type	Name	Description
System.Int32	i
T	item

| Improve this Doc View Source

raiseForRemove(T)

Declaration

protected void raiseForRemove(T item)

Parameters

Type	Name	Description
T	item

| Improve this Doc View Source

raiseForRemove(T, Int32)

Declaration

protected void raiseForRemove(T item, int count)

Parameters

Type	Name	Description
T	item
System.Int32	count

| Improve this Doc View Source

raiseForRemoveAll(ICollectionValue<T>)

Declaration

protected virtual void raiseForRemoveAll(ICollectionValue<T> wasRemoved)

Parameters

Type	Name	Description
ICollectionValue<T>	wasRemoved

| Improve this Doc View Source

raiseForRemoveAt(Int32, T)

Declaration

protected void raiseForRemoveAt(int index, T item)

Parameters

Type	Name	Description
System.Int32	index
T	item

| Improve this Doc View Source

raiseForSetThis(Int32, T, T)

Declaration

protected virtual void raiseForSetThis(int index, T value, T item)

Parameters

Type	Name	Description
System.Int32	index
T	value
T	item

| Improve this Doc View Source

raiseForUpdate(T, T)

Declaration

protected virtual void raiseForUpdate(T newitem, T olditem)

Parameters

Type	Name	Description
T	newitem
T	olditem

| Improve this Doc View Source

raiseForUpdate(T, T, Int32)

Declaration

protected virtual void raiseForUpdate(T newitem, T olditem, int count)

Parameters

Type	Name	Description
T	newitem
T	olditem
System.Int32	count

| Improve this Doc View Source

raiseItemInserted(T, Int32)

Fire the ItemInserted event

Declaration

protected virtual void raiseItemInserted(T item, int index)

Parameters

Type	Name	Description
T	item	The item that was added
System.Int32	index

| Improve this Doc View Source

raiseItemRemovedAt(T, Int32)

Fire the ItemRemovedAt event

Declaration

protected virtual void raiseItemRemovedAt(T item, int index)

Parameters

Type	Name	Description
T	item	The item that was removed
System.Int32	index

| Improve this Doc View Source

raiseItemsAdded(T, Int32)

Fire the ItemsAdded event

Declaration

protected virtual void raiseItemsAdded(T item, int count)

Parameters

Type	Name	Description
T	item	The item that was added
System.Int32	count

| Improve this Doc View Source

raiseItemsRemoved(T, Int32)

Fire the ItemsRemoved event

Declaration

protected virtual void raiseItemsRemoved(T item, int count)

Parameters

Type	Name	Description
T	item	The item that was removed
System.Int32	count

| Improve this Doc View Source

Show(StringBuilder, ref Int32, IFormatProvider)

Declaration

public virtual bool Show(StringBuilder stringbuilder, ref int rest, IFormatProvider formatProvider)

Parameters

Type	Name	Description
System.Text.StringBuilder	stringbuilder
System.Int32	rest
System.IFormatProvider	formatProvider

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

ToArray()

Create an array with the items of this collection (in the same order as an enumerator would output them).

Declaration

public virtual T[] ToArray()

Returns

Type	Description
T[]	The array

| Improve this Doc View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

| Improve this Doc View Source

ToString(String, IFormatProvider)

Declaration

public virtual string ToString(string format, IFormatProvider formatProvider)

Parameters

Type	Name	Description
System.String	format
System.IFormatProvider	formatProvider

Returns

Type	Description
System.String

Events

| Improve this Doc View Source

CollectionChanged

The change event. Will be raised for every change operation on the collection.

Declaration

public virtual event CollectionChangedHandler<T> CollectionChanged

Event Type

Type	Description
CollectionChangedHandler<T>

| Improve this Doc View Source

CollectionCleared

The clear event. Will be raised for every Clear operation on the collection.

Declaration

public virtual event CollectionClearedHandler<T> CollectionCleared

Event Type

Type	Description
CollectionClearedHandler<T>

| Improve this Doc View Source

ItemInserted

The item added event. Will be raised for every individual addition to the collection.

Declaration

public virtual event ItemInsertedHandler<T> ItemInserted

Event Type

Type	Description
ItemInsertedHandler<T>

| Improve this Doc View Source

ItemRemovedAt

The item removed event. Will be raised for every individual removal from the collection.

Declaration

public virtual event ItemRemovedAtHandler<T> ItemRemovedAt

Event Type

Type	Description
ItemRemovedAtHandler<T>

| Improve this Doc View Source

ItemsAdded

The item added event. Will be raised for every individual addition to the collection.

Declaration

public virtual event ItemsAddedHandler<T> ItemsAdded

Event Type

Type	Description
ItemsAddedHandler<T>

| Improve this Doc View Source

ItemsRemoved

The item removed event. Will be raised for every individual removal from the collection.

Declaration

public virtual event ItemsRemovedHandler<T> ItemsRemoved

Event Type

Type	Description
ItemsRemovedHandler<T>

Implements

ICollectionValue<T>

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable

IShowable

System.IFormattable

Extension Methods

EnumerableExtensions.InPairs<T, TOut>(IEnumerable<T>, Func<T, T, TOut>)

Number.IsNumber(Object)