Class ReadOnlyFieldDefinitionCollection

Namespace

Examine

Assembly

Examine.Core.dll

Manages the mappings between a field name and it's index type

public class ReadOnlyFieldDefinitionCollection : IEnumerable<FieldDefinition>, IEnumerable

Inheritance

object

ReadOnlyFieldDefinitionCollection

Implements

IEnumerable<FieldDefinition>

IEnumerable

Derived

FieldDefinitionCollection

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ReadOnlyFieldDefinitionCollection()

Initializes a new instance of the object class.

public ReadOnlyFieldDefinitionCollection()

ReadOnlyFieldDefinitionCollection(params FieldDefinition[])

public ReadOnlyFieldDefinitionCollection(params FieldDefinition[] definitions)

Parameters

definitions FieldDefinition[]

ReadOnlyFieldDefinitionCollection(IEnumerable<FieldDefinition>)

public ReadOnlyFieldDefinitionCollection(IEnumerable<FieldDefinition> definitions)

Parameters

definitions IEnumerable<FieldDefinition>

Properties

Count

Gets the ammount of key/value paris in the Definitions collection

public int Count { get; }

Property Value

int

Definitions

A collection of field definitions

protected ConcurrentDictionary<string, FieldDefinition> Definitions { get; }

Property Value

ConcurrentDictionary<string, FieldDefinition>

Methods

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<FieldDefinition> GetEnumerator()

Returns

IEnumerator<FieldDefinition>

An enumerator that can be used to iterate through the collection.

TryGetValue(string, out FieldDefinition)

Tries to get a FieldDefinition by field name

public virtual bool TryGetValue(string fieldName, out FieldDefinition fieldDefinition)

Parameters

fieldName string

fieldDefinition FieldDefinition

Returns

bool

returns true if one was found otherwise false

Remarks

Marked as virtual so developers can inherit this class and override this method in case field definitions are dynamic.