Class CharArrayMap<TValue>

A simple class that stores key System.Strings as char[]'s in a hash table. Note that this is not a general purpose class. For example, it cannot remove items from the map, nor does it resize its hash table to be smaller, etc. It is designed to be quick to retrieve items by char[] keys without the necessity of converting to a System.String first.

You must specify the required Lucene.Net.Util.LuceneVersion compatibility when creating CharArrayMap:

  • As of 3.1, supplementary characters are properly lowercased.
Before 3.1 supplementary characters could not be lowercased correctly due to the lack of Unicode 4 support in JDK 1.4. To use instances of CharArrayMap with the behavior before Lucene 3.1 pass a Lucene.Net.Util.LuceneVersion < 3.1 to the constructors.

Inheritance
System.Object
CharArrayMap<TValue>
Implements
System.Collections.Generic.IDictionary<System.String, TValue>
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, TValue>>
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, TValue>>
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Analysis.Util
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public class CharArrayMap<TValue> : ICharArrayMap, IDictionary<string, TValue>, ICollection<KeyValuePair<string, TValue>>, IEnumerable<KeyValuePair<string, TValue>>, IEnumerable
Type Parameters
Name Description
TValue

Constructors

| Improve this Doc View Source

CharArrayMap(LuceneVersion, IDictionary<String, TValue>, Boolean)

Creates a map from the mappings in another map.

Declaration
public CharArrayMap(LuceneVersion matchVersion, IDictionary<string, TValue> c, bool ignoreCase)
Parameters
Type Name Description
Lucene.Net.Util.LuceneVersion matchVersion

compatibility match version see Version note above for details.

System.Collections.Generic.IDictionary<System.String, TValue> c

a map () whose mappings to be copied

System.Boolean ignoreCase

false if and only if the set should be case sensitive; otherwise true.

| Improve this Doc View Source

CharArrayMap(LuceneVersion, Int32, Boolean)

Create map with enough capacity to hold startSize terms

Declaration
public CharArrayMap(LuceneVersion matchVersion, int startSize, bool ignoreCase)
Parameters
Type Name Description
Lucene.Net.Util.LuceneVersion matchVersion

lucene compatibility version - see CharArrayMap<TValue> for details.

System.Int32 startSize

the initial capacity

System.Boolean ignoreCase

false if and only if the set should be case sensitive; otherwise true.

Properties

| Improve this Doc View Source

Count

Gets the number of key/value pairs contained in the CharArrayMap<TValue>.

Declaration
public virtual int Count { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

IsReadOnly

true if the CharArrayMap<TValue> is read-only; otherwise false.

Declaration
public virtual bool IsReadOnly { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Item[ICharSequence]

Gets or sets the value associated with the specified key.

Declaration
public virtual TValue this[ICharSequence key] { get; set; }
Parameters
Type Name Description
J2N.Text.ICharSequence key

The key of the value to get or set.
Property Value
Type Description
TValue
| Improve this Doc View Source

Item[Char[]]

Gets or sets the value associated with the specified key.

Declaration
public virtual TValue this[char[] key] { get; set; }
Parameters
Type Name Description
System.Char[] key

The key of the value to get or set.
Property Value
Type Description
TValue
| Improve this Doc View Source

Item[Char[], Int32, Int32]

Gets or sets the value associated with the specified key.

Declaration
public virtual TValue this[char[] key, int offset, int length] { get; set; }
Parameters
Type Name Description
System.Char[] key

The key of the value to get or set.
System.Int32 offset

The position of the key where the target key begins.
System.Int32 length

The total length of the key.
Property Value
Type Description
TValue
| Improve this Doc View Source

Item[Object]

Gets or sets the value associated with the specified key.

Declaration
public virtual TValue this[object key] { get; set; }
Parameters
Type Name Description
System.Object key

The key of the value to get or set.
Property Value
Type Description
TValue
| Improve this Doc View Source

Item[String]

Gets or sets the value associated with the specified key.

Declaration
public virtual TValue this[string key] { get; set; }
Parameters
Type Name Description
System.String key

The key of the value to get or set.
Property Value
Type Description
TValue
| Improve this Doc View Source

Keys

Gets a collection containing the keys in the CharArrayMap<TValue>.

Declaration
public virtual ICollection<string> Keys { get; }
Property Value
Type Description
System.Collections.Generic.ICollection<System.String>
| Improve this Doc View Source

MatchVersion

The Lucene version corresponding to the compatibility behavior that this instance emulates

Declaration
public virtual LuceneVersion MatchVersion { get; }
Property Value
Type Description
Lucene.Net.Util.LuceneVersion
| Improve this Doc View Source

Values

Gets a collection containing the values in the CharArrayMap<TValue>. This specialized collection can be enumerated in order to read its values and overrides System.Object.ToString() in order to display a string representation of the values.

Declaration
public ICollection<TValue> Values { get; }
Property Value
Type Description
System.Collections.Generic.ICollection<TValue>

Methods

| Improve this Doc View Source

Add(KeyValuePair<String, TValue>)

Adds the for the passed in . Note that the instance is not added to the dictionary.

Declaration
public virtual void Add(KeyValuePair<string, TValue> item)
Parameters
Type Name Description
System.Collections.Generic.KeyValuePair<System.String, TValue> item

A whose will be added for the corresponding .

| Improve this Doc View Source

Add(String, TValue)

Adds the value for the passed in key.

Declaration
public virtual void Add(string key, TValue value)
Parameters
Type Name Description
System.String key

The string-able type to be added/updated in the dictionary.
TValue value

The corresponding value for the given key.
| Improve this Doc View Source

Clear()

Clears all entries in this map. This method is supported for reusing, but not System.Collections.Generic.IDictionary`2.Remove(`0).

Declaration
public virtual void Clear()
| Improve this Doc View Source

ContainsKey(ICharSequence)

true if the text J2N.Text.ICharSequence is in the Keys; otherwise false

Declaration
public virtual bool ContainsKey(ICharSequence text)
Parameters
Type Name Description
J2N.Text.ICharSequence text
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ContainsKey(Char[])

true if the entire Keys is the same as the text char[] being passed in; otherwise false.

Declaration
public virtual bool ContainsKey(char[] text)
Parameters
Type Name Description
System.Char[] text
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ContainsKey(Char[], Int32, Int32)

true if the length chars of text starting at offset are in the Keys

Declaration
public virtual bool ContainsKey(char[] text, int offset, int length)
Parameters
Type Name Description
System.Char[] text
System.Int32 offset
System.Int32 length
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ContainsKey(Object)

true if the o System.Object.ToString() is in the Keys; otherwise false

Declaration
public virtual bool ContainsKey(object o)
Parameters
Type Name Description
System.Object o
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ContainsKey(String)

true if the text System.String is in the Keys; otherwise false

Declaration
public virtual bool ContainsKey(string text)
Parameters
Type Name Description
System.String text
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CopyTo(CharArrayMap<TValue>)

Copies all items in the current CharArrayMap<TValue> to the passed in CharArrayMap<TValue>.

Declaration
public virtual void CopyTo(CharArrayMap<TValue> map)
Parameters
Type Name Description
CharArrayMap<TValue> map
| Improve this Doc View Source

CopyTo(KeyValuePair<String, TValue>[], Int32)

Copies all items in the current dictionary the array starting at the arrayIndex. The array is assumed to already be dimensioned to fit the elements in this dictionary; otherwise a System.ArgumentOutOfRangeException will be thrown.

Declaration
public virtual void CopyTo(KeyValuePair<string, TValue>[] array, int arrayIndex)
Parameters
Type Name Description
System.Collections.Generic.KeyValuePair<System.String, TValue>[] array

The array to copy the items into.
System.Int32 arrayIndex

A 32-bit integer that represents the index in array at which copying begins.
| Improve this Doc View Source

EmptyMap()

Returns an empty, unmodifiable map.

Declaration
public static CharArrayMap<TValue> EmptyMap()
Returns
Type Description
CharArrayMap<TValue>
| Improve this Doc View Source

EntrySet()

Declaration
public CharArrayMap<TValue>.EntrySet_ EntrySet()
Returns
Type Description
CharArrayMap.EntrySet_<>
| Improve this Doc View Source

Equals(Object)

LUCENENET Specific - test for value equality similar to how it is done in Java

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

Another dictionary to test the values of
Returns
Type Description
System.Boolean

true if the given object is an that contains the same key value pairs as the current map
Overrides
System.Object.Equals(System.Object)
| Improve this Doc View Source

Get(ICharSequence)

returns the value of the mapping of the chars inside this J2N.Text.ICharSequence

Declaration
public virtual TValue Get(ICharSequence text)
Parameters
Type Name Description
J2N.Text.ICharSequence text
Returns
Type Description
TValue
| Improve this Doc View Source

Get(Char[])

returns the value of the mapping of the chars inside this text

Declaration
public virtual TValue Get(char[] text)
Parameters
Type Name Description
System.Char[] text
Returns
Type Description
TValue
| Improve this Doc View Source

Get(Char[], Int32, Int32)

returns the value of the mapping of length chars of text starting at offset

Declaration
public virtual TValue Get(char[] text, int offset, int length)
Parameters
Type Name Description
System.Char[] text
System.Int32 offset
System.Int32 length
Returns
Type Description
TValue
| Improve this Doc View Source

Get(Object)

returns the value of the mapping of the chars inside this System.Object.ToString()

Declaration
public virtual TValue Get(object o)
Parameters
Type Name Description
System.Object o
Returns
Type Description
TValue
| Improve this Doc View Source

Get(String)

returns the value of the mapping of the chars inside this System.String

Declaration
public virtual TValue Get(string text)
Parameters
Type Name Description
System.String text
Returns
Type Description
TValue
| Improve this Doc View Source

GetEnumerator()

Returns an enumerator that iterates through the CharArrayMap<TValue>.

Declaration
public virtual IEnumerator<KeyValuePair<string, TValue>> GetEnumerator()
Returns
Type Description
System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<System.String, TValue>>
| Improve this Doc View Source

GetHashCode()

LUCENENET Specific - override required by .NET because we override Equals to simulate Java's value equality checking.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()
| Improve this Doc View Source

Put(ICharSequence)

Adds a placeholder with the given text as the key. Primarily for internal use by CharArraySet.

Declaration
public virtual bool Put(ICharSequence text)
Parameters
Type Name Description
J2N.Text.ICharSequence text
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Put(ICharSequence, TValue)

Add the given mapping.

Declaration
public virtual TValue Put(ICharSequence text, TValue value)
Parameters
Type Name Description
J2N.Text.ICharSequence text
TValue value
Returns
Type Description
TValue
| Improve this Doc View Source

Put(Char[])

Adds a placeholder with the given text as the key. Primarily for internal use by CharArraySet.

Declaration
public virtual bool Put(char[] text)
Parameters
Type Name Description
System.Char[] text
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Put(Char[], TValue)

Add the given mapping. If ignoreCase is true for this Set, the text array will be directly modified. The user should never modify this text array after calling this method.

Declaration
public virtual TValue Put(char[] text, TValue value)
Parameters
Type Name Description
System.Char[] text
TValue value
Returns
Type Description
TValue
| Improve this Doc View Source

Put(Object)

Adds a placeholder with the given o as the key. Primarily for internal use by CharArraySet.

Declaration
public virtual bool Put(object o)
Parameters
Type Name Description
System.Object o
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Put(Object, TValue)

Add the given mapping using the System.Object.ToString() representation of o in the System.Globalization.CultureInfo.InvariantCulture.

Declaration
public virtual TValue Put(object o, TValue value)
Parameters
Type Name Description
System.Object o
TValue value
Returns
Type Description
TValue
| Improve this Doc View Source

Put(String)

Adds a placeholder with the given text as the key. Primarily for internal use by CharArraySet.

Declaration
public virtual bool Put(string text)
Parameters
Type Name Description
System.String text
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Put(String, TValue)

Add the given mapping.

Declaration
public virtual TValue Put(string text, TValue value)
Parameters
Type Name Description
System.String text
TValue value
Returns
Type Description
TValue
| Improve this Doc View Source

PutAll(IDictionary<ICharSequence, TValue>)

This implementation enumerates over the specified IDictionary{ICharSequence,TValue}'s entries, and calls this map's Put(ICharSequence, TValue) operation once for each entry.

Declaration
public virtual void PutAll(IDictionary<ICharSequence, TValue> collection)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<J2N.Text.ICharSequence, TValue> collection

A dictionary of values to add/update in the current map.
| Improve this Doc View Source

PutAll(IDictionary<Char[], TValue>)

This implementation enumerates over the specified IDictionary{char[],TValue}'s entries, and calls this map's Put(Char[], TValue) operation once for each entry.

Declaration
public virtual void PutAll(IDictionary<char[], TValue> collection)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.Char[], TValue> collection

A dictionary of values to add/update in the current map.
| Improve this Doc View Source

PutAll(IDictionary<Object, TValue>)

This implementation enumerates over the specified IDictionary{object,TValue}'s entries, and calls this map's Put(Object, TValue) operation once for each entry.

Declaration
public virtual void PutAll(IDictionary<object, TValue> collection)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.Object, TValue> collection

A dictionary of values to add/update in the current map.
| Improve this Doc View Source

PutAll(IDictionary<String, TValue>)

This implementation enumerates over the specified IDictionary{string,TValue}'s entries, and calls this map's Put(String, TValue) operation once for each entry.

Declaration
public virtual void PutAll(IDictionary<string, TValue> collection)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, TValue> collection

A dictionary of values to add/update in the current map.
| Improve this Doc View Source

PutAll(IEnumerable<KeyValuePair<ICharSequence, TValue>>)

This implementation enumerates over the specified IEnumerable{KeyValuePair{ICharSequence,TValue}}'s entries, and calls this map's Put(ICharSequence, TValue) operation once for each entry.

Declaration
public virtual void PutAll(IEnumerable<KeyValuePair<ICharSequence, TValue>> collection)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<J2N.Text.ICharSequence, TValue>> collection

The values to add/update in the current map.
| Improve this Doc View Source

PutAll(IEnumerable<KeyValuePair<Char[], TValue>>)

This implementation enumerates over the specified IEnumerable{KeyValuePair{char[],TValue}}'s entries, and calls this map's Put(Char[], TValue) operation once for each entry.

Declaration
public virtual void PutAll(IEnumerable<KeyValuePair<char[], TValue>> collection)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.Char[], TValue>> collection

The values to add/update in the current map.
| Improve this Doc View Source

PutAll(IEnumerable<KeyValuePair<Object, TValue>>)

This implementation enumerates over the specified IEnumerable{KeyValuePair{object,TValue}}'s entries, and calls this map's Put(Object, TValue) operation once for each entry.

Declaration
public virtual void PutAll(IEnumerable<KeyValuePair<object, TValue>> collection)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.Object, TValue>> collection

The values to add/update in the current map.
| Improve this Doc View Source

PutAll(IEnumerable<KeyValuePair<String, TValue>>)

This implementation enumerates over the specified IEnumerable{KeyValuePair{string,TValue}}'s entries, and calls this map's Put(String, TValue) operation once for each entry.

Declaration
public virtual void PutAll(IEnumerable<KeyValuePair<string, TValue>> collection)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, TValue>> collection

The values to add/update in the current map.
| Improve this Doc View Source

ToString()

Returns a string that represents the current object. (Inherited from System.Object.)

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()
| Improve this Doc View Source

TryGetValue(ICharSequence, out TValue)

Gets the value associated with the specified key.

Declaration
public virtual bool TryGetValue(ICharSequence key, out TValue value)
Parameters
Type Name Description
J2N.Text.ICharSequence key

The key of the value to get.
TValue value

When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.
Returns
Type Description
System.Boolean

true if the CharArrayMap<TValue> contains an element with the specified key; otherwise, false.
| Improve this Doc View Source

TryGetValue(Char[], out TValue)

Gets the value associated with the specified key.

Declaration
public virtual bool TryGetValue(char[] key, out TValue value)
Parameters
Type Name Description
System.Char[] key

The key of the value to get.
TValue value

When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.
Returns
Type Description
System.Boolean

true if the CharArrayMap<TValue> contains an element with the specified key; otherwise, false.
| Improve this Doc View Source

TryGetValue(Char[], Int32, Int32, out TValue)

Gets the value associated with the specified key.

Declaration
public virtual bool TryGetValue(char[] key, int offset, int length, out TValue value)
Parameters
Type Name Description
System.Char[] key

The key of the value to get.
System.Int32 offset

The position of the key where the target key begins.
System.Int32 length

The total length of the key.
TValue value

When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.
Returns
Type Description
System.Boolean

true if the CharArrayMap<TValue> contains an element with the specified key; otherwise, false.
| Improve this Doc View Source

TryGetValue(Object, out TValue)

Gets the value associated with the specified key.

Declaration
public virtual bool TryGetValue(object key, out TValue value)
Parameters
Type Name Description
System.Object key

The key of the value to get.
TValue value

When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.
Returns
Type Description
System.Boolean

true if the CharArrayMap<TValue> contains an element with the specified key; otherwise, false.
| Improve this Doc View Source

TryGetValue(String, out TValue)

Gets the value associated with the specified key.

Declaration
public virtual bool TryGetValue(string key, out TValue value)
Parameters
Type Name Description
System.String key

The key of the value to get.
TValue value

When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.
Returns
Type Description
System.Boolean

true if the CharArrayMap<TValue> contains an element with the specified key; otherwise, false.

Explicit Interface Implementations

| Improve this Doc View Source

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through the CharArrayMap<TValue>.

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

Implements

System.Collections.Generic.IDictionary<TKey, TValue>
System.Collections.Generic.ICollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable

Extension Methods