Package org.apache.lucene.analysis

# Class CharArrayMap<V>

java.lang.Object
java.util.AbstractMap<Object,V>
org.apache.lucene.analysis.CharArrayMap<V>

All Implemented Interfaces:
  `Map<Object,V>`

public class CharArrayMap<V> extends AbstractMap<Object,V>
A simple class that stores key 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 String first.

## Nested Class Summary

Nested Classes
Modifier and Type
Class
Description
`class`
`CharArrayMap.EntryIterator`
public iterator class so efficient methods are exposed to users
`final class`
`CharArrayMap.EntrySet`
public EntrySet class so efficient methods are exposed to users

## Nested classes/interfaces inherited from class java.util.AbstractMap

`AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>`

## Nested classes/interfaces inherited from interface java.util.Map

`Map.Entry<K,V>`

## Constructor Summary

Constructors
Constructor
Description
`CharArrayMap(int startSize, boolean ignoreCase)`
Create map with enough capacity to hold startSize terms
`CharArrayMap(Map<?,? extends V> c, boolean ignoreCase)`
Creates a map from the mappings in another map.

## Method Summary

Modifier and Type
Method
Description
`void`
`clear()`
Clears all entries in this map.
`boolean`
`containsKey(char[] text, int off, int len)`
true if the `len` chars of `text` starting at `off` are in the `keySet()`
`boolean`
`containsKey(CharSequence cs)`
true if the `CharSequence` is in the `keySet()`
`boolean`
`containsKey(Object o)`
`static <V> CharArrayMap<V>`
`copy(Map<?,? extends V> map)`
Returns a copy of the given map as a `CharArrayMap`.
`static <V> CharArrayMap<V>`
`emptyMap()`
Returns an empty, unmodifiable map.
`final CharArrayMap<V>.EntrySet`
`entrySet()`
`V`
`get(char[] text, int off, int len)`
returns the value of the mapping of `len` chars of `text` starting at `off`
`V`
`get(CharSequence cs)`
returns the value of the mapping of the chars inside this `CharSequence`
`V`
`get(Object o)`
`final CharArraySet`
`keySet()`
Returns an `CharArraySet` view on the map's keys.
`V`
`put(char[] text, V value)`
Add the given mapping.
`V`
`put(CharSequence text, V value)`
Add the given mapping.
`V`
`put(Object o, V value)`
`V`
`put(String text, V value)`
Add the given mapping.
`V`
`remove(Object key)`
`int`
`size()`
`String`
`toString()`
`static <V> CharArrayMap<V>`
`unmodifiableMap(CharArrayMap<V> map)`
Returns an unmodifiable `CharArrayMap`.

### Methods inherited from class java.util.AbstractMap

`clone, containsValue, equals, hashCode, isEmpty, putAll, values`

### Methods inherited from class java.lang.Object

`finalize, getClass, notify, notifyAll, wait, wait, wait`

### Methods inherited from interface java.util.Map

`compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll`

## Constructor Details

### CharArrayMap

public CharArrayMap(int startSize, boolean ignoreCase)
Create map with enough capacity to hold startSize terms

Parameters:
  `startSize` - the initial capacity
  `ignoreCase` - `false` if and only if the set should be case sensitive otherwise `true`.

### CharArrayMap

public CharArrayMap(Map<?,? extends V> c, boolean ignoreCase)
Creates a map from the mappings in another map.

Parameters:
  `c` - a map whose mappings to be copied
  `ignoreCase` - `false` if and only if the set should be case sensitive otherwise `true`.

## Method Details

### clear

public void clear()
Clears all entries in this map. This method is supported for reusing, but not `Map.remove(java.lang.Object)`.

Specified by:
  `clear` in interface `Map<Object,V>`
Overrides:
  `clear` in class `AbstractMap<Object,V>`

### containsKey

public boolean containsKey(char[] text, int off, int len)
true if the `len` chars of `text` starting at `off` are in the `keySet()`

### containsKey

public boolean containsKey(CharSequence cs)
true if the `CharSequence` is in the `keySet()`

### containsKey

public boolean containsKey(Object o)

Specified by:
  `containsKey` in interface `Map<Object,V>`
Overrides:
  `containsKey` in class `AbstractMap<Object,V>`

### get

public V get(char[] text, int off, int len)
returns the value of the mapping of `len` chars of `text` starting at `off`

### get

public V get(CharSequence cs)
returns the value of the mapping of the chars inside this `CharSequence`

### get

public V get(Object o)

Specified by:
  `get` in interface `Map<Object,V>`
Overrides:
  `get` in class `AbstractMap<Object,V>`

### put

public V put(CharSequence text, V value)
Add the given mapping.

### put

public V put(Object o, V value)

Specified by:
  `put` in interface `Map<Object,V>`
Overrides:
  `put` in class `AbstractMap<Object,V>`

### put

public V put(String text, V value)
Add the given mapping.

### put

public V put(char[] text, V value)
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.

### remove

public V remove(Object key)

Specified by:
  `remove` in interface `Map<Object,V>`
Overrides:
  `remove` in class `AbstractMap<Object,V>`

### size

public int size()

Specified by:
  `size` in interface `Map<Object,V>`
Overrides:
  `size` in class `AbstractMap<Object,V>`

### toString

public String toString()

Overrides:
  `toString` in class `AbstractMap<Object,V>`

### entrySet

public final CharArrayMap<V>.EntrySet entrySet()

Specified by:
  `entrySet` in interface `Map<Object,V>`
Specified by:
  `entrySet` in class `AbstractMap<Object,V>`

### keySet

public final CharArraySet keySet()
Returns an `CharArraySet` view on the map's keys. The set will use the same `matchVersion` as this map.

Specified by:
  `keySet` in interface `Map<Object,V>`
Overrides:
  `keySet` in class `AbstractMap<Object,V>`

### unmodifiableMap

public static <V> CharArrayMap<V> unmodifiableMap(CharArrayMap<V> map)
Returns an unmodifiable `CharArrayMap`. This allows to provide unmodifiable views of internal map for "read-only" use.

Parameters:
  `map` - a map for which the unmodifiable map is returned.
Returns:
  an new unmodifiable `CharArrayMap`.
Throws:
  `NullPointerException` - if the given map is `null`.

### copy

public static <V> CharArrayMap<V> copy(Map<?,? extends V> map)
Returns a copy of the given map as a `CharArrayMap`. If the given map is a `CharArrayMap` the ignoreCase property will be preserved.

Parameters:
  `map` - a map to copy
Returns:
  a copy of the given map as a `CharArrayMap`. If the given map is a `CharArrayMap` the ignoreCase property as well as the matchVersion will be of the given map will be preserved.

### emptyMap

public static <V> CharArrayMap<V> emptyMap()
Returns an empty, unmodifiable map.