Package org.apache.lucene.analysis

Class CharArrayMap<V>

java.lang.Object

java.util.AbstractMap<java.lang.Object,V>

org.apache.lucene.analysis.CharArrayMap<V>

All Implemented Interfaces:

java.util.Map<java.lang.Object,V>

Direct Known Subclasses:

CharArrayMap.UnmodifiableCharArrayMap

public class CharArrayMap<V>
extends java.util.AbstractMap<java.lang.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
private static class	CharArrayMap.EmptyCharArrayMap<V>	Empty CharArrayMap.UnmodifiableCharArrayMap optimized for speed.
class	CharArrayMap.EntryIterator	public iterator class so efficient methods are exposed to users
class	CharArrayMap.EntrySet	public EntrySet class so efficient methods are exposed to users
private class	CharArrayMap.MapEntry
(package private) static class	CharArrayMap.UnmodifiableCharArrayMap<V>

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

java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,V extends java.lang.Object>

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

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
private int	count
private static CharArrayMap<?>	EMPTY_MAP
private CharArrayMap.EntrySet	entrySet
private boolean	ignoreCase
private static int	INIT_SIZE
(package private) char[][]	keys
private CharArraySet	keySet
(package private) V[]	values

Constructor Summary

Constructors

Modifier	Constructor	Description
	CharArrayMap(int startSize, boolean ignoreCase)	Create map with enough capacity to hold startSize terms
	CharArrayMap(java.util.Map<?,? extends V> c, boolean ignoreCase)	Creates a map from the mappings in another map.
private	CharArrayMap(CharArrayMap<V> toCopy)	Create set from the supplied map (used internally for readonly maps...)

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(java.lang.CharSequence cs)	true if the CharSequence is in the keySet()
boolean	containsKey(java.lang.Object o)
static <V> CharArrayMap<V>	copy(java.util.Map<?,? extends V> map)	Returns a copy of the given map as a CharArrayMap.
(package private) CharArrayMap.EntrySet	createEntrySet()
static <V> CharArrayMap<V>	emptyMap()	Returns an empty, unmodifiable map.
CharArrayMap.EntrySet	entrySet()
private boolean	equals(char[] text1, int off, int len, char[] text2)
private boolean	equals(java.lang.CharSequence text1, char[] text2)
V	get(char[] text, int off, int len)	returns the value of the mapping of len chars of text starting at off
V	get(java.lang.CharSequence cs)	returns the value of the mapping of the chars inside this CharSequence
V	get(java.lang.Object o)
private int	getHashCode(char[] text, int offset, int len)
private int	getHashCode(java.lang.CharSequence text)
private int	getSlot(char[] text, int off, int len)
private int	getSlot(java.lang.CharSequence text)	Returns true if the String is in the set
CharArraySet	keySet()	Returns an CharArraySet view on the map's keys.
(package private) java.util.Set<java.lang.Object>	originalKeySet()
V	put(char[] text, V value)	Add the given mapping.
V	put(java.lang.CharSequence text, V value)	Add the given mapping.
V	put(java.lang.Object o, V value)
V	put(java.lang.String text, V value)	Add the given mapping.
private void	rehash()
V	remove(java.lang.Object key)
int	size()
java.lang.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

Field Detail

EMPTY_MAP

private static final CharArrayMap<?> EMPTY_MAP

INIT_SIZE

private static final int INIT_SIZE

See Also:

Constant Field Values

ignoreCase

private boolean ignoreCase

count

private int count

keys

char[][] keys

values

V[] values

entrySet

private CharArrayMap.EntrySet entrySet

keySet

private CharArraySet keySet

Constructor Detail

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(java.util.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.

CharArrayMap

private CharArrayMap(CharArrayMap<V> toCopy)

Create set from the supplied map (used internally for readonly maps...)

Method Detail

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 java.util.Map<java.lang.Object,V>

Overrides:

clear in class java.util.AbstractMap<java.lang.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(java.lang.CharSequence cs)

true if the CharSequence is in the keySet()

containsKey

public boolean containsKey(java.lang.Object o)

Specified by:

containsKey in interface java.util.Map<java.lang.Object,V>

Overrides:

containsKey in class java.util.AbstractMap<java.lang.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(java.lang.CharSequence cs)

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

get

public V get(java.lang.Object o)

Specified by:

get in interface java.util.Map<java.lang.Object,V>

Overrides:

get in class java.util.AbstractMap<java.lang.Object,V>

getSlot

private int getSlot(char[] text,
                    int off,
                    int len)

getSlot

private int getSlot(java.lang.CharSequence text)

Returns true if the String is in the set

put

public V put(java.lang.CharSequence text,
             V value)

Add the given mapping.

put

public V put(java.lang.Object o,
             V value)

Specified by:

put in interface java.util.Map<java.lang.Object,V>

Overrides:

put in class java.util.AbstractMap<java.lang.Object,V>

put

public V put(java.lang.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.

rehash

private void rehash()

equals

private boolean equals(char[] text1,
                       int off,
                       int len,
                       char[] text2)

equals

private boolean equals(java.lang.CharSequence text1,
                       char[] text2)

getHashCode

private int getHashCode(char[] text,
                        int offset,
                        int len)

getHashCode

private int getHashCode(java.lang.CharSequence text)

remove

public V remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.Object,V>

Overrides:

remove in class java.util.AbstractMap<java.lang.Object,V>

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.Object,V>

Overrides:

size in class java.util.AbstractMap<java.lang.Object,V>

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractMap<java.lang.Object,V>

createEntrySet

CharArrayMap.EntrySet createEntrySet()

entrySet

public final CharArrayMap.EntrySet entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.Object,V>

Specified by:

entrySet in class java.util.AbstractMap<java.lang.Object,V>

originalKeySet

final java.util.Set<java.lang.Object> originalKeySet()

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 java.util.Map<java.lang.Object,V>

Overrides:

keySet in class java.util.AbstractMap<java.lang.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:

java.lang.NullPointerException - if the given map is null.

copy

public static <V> CharArrayMap<V> copy(java.util.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.