org.kitteh.irc.client.library.util

Class CIKeyMap<Value>

java.lang.Object

org.kitteh.irc.client.library.util.CIKeyMap<Value>

All Implemented Interfaces:

Map<String,Value>

public class CIKeyMap<Value>
extends Object
implements Map<String,Value>

A thread-safe hash map with case insensitive keys tied to Client's CaseMapping. Note that some methods do not behave like all maps.

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CIKeyMap(@NonNull Client client) Constructs a map tied to a client.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(@Nullable Object key)
boolean	containsValue(@Nullable Object value)
@NonNull Set<Map.Entry<String,Value>>	entrySet() Gets an UNCHANGING representation of the entries.
Value	get(@Nullable Object key)
boolean	isEmpty()
@NonNull Set<String>	keySet() Gets an UNCHANGING representation of the keys.
Value	put(@NonNull String key, Value value)
void	putAll(@NonNull Map<? extends String,? extends Value> m)
Value	remove(@Nullable Object key)
int	size()
protected @NonNull String	toLowerCase(@NonNull String input) Converts a given input to lower case based on the current CaseMapping.
@NonNull String	toString()
@NonNull Collection<Value>	values() Gets an UNCHANGING representation of the values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CIKeyMap

public CIKeyMap(@NonNull Client client)

Constructs a map tied to a client.

Parameters:

client - the client to which this map is tied

Method Detail

toLowerCase

protected final @NonNull String toLowerCase(@NonNull String input)

Converts a given input to lower case based on the current CaseMapping.

Parameters:

input - input to convert

Returns:

lower cased input

size

public int size()

Specified by:

size in interface Map<String,Value>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Value>

containsKey

public boolean containsKey(@Nullable Object key)

Specified by:

containsKey in interface Map<String,Value>

containsValue

public boolean containsValue(@Nullable Object value)

Specified by:

containsValue in interface Map<String,Value>

get

public Value get(@Nullable Object key)

Specified by:

get in interface Map<String,Value>

put

public Value put(@NonNull String key,
                 Value value)

Specified by:

put in interface Map<String,Value>

remove

public Value remove(@Nullable Object key)

Specified by:

remove in interface Map<String,Value>

putAll

public void putAll(@NonNull Map<? extends String,? extends Value> m)

Specified by:

putAll in interface Map<String,Value>

clear

public void clear()

Specified by:

clear in interface Map<String,Value>

keySet

public @NonNull Set<String> keySet()

Gets an UNCHANGING representation of the keys.

Specified by:

keySet in interface Map<String,Value>

Returns:

set of keys

values

public @NonNull Collection<Value> values()

Gets an UNCHANGING representation of the values.

Specified by:

values in interface Map<String,Value>

Returns:

list of values

entrySet

public @NonNull Set<Map.Entry<String,Value>> entrySet()

Gets an UNCHANGING representation of the entries.

Specified by:

entrySet in interface Map<String,Value>

Returns:

set of entries

toString

public @NonNull String toString()

Overrides:

toString in class Object