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(Client client) Constructs a map tied to a client.

Method Summary

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

@Nonnull
protected final 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

@Nullable
public Value get(@Nullable
                            Object key)

Specified by:

get in interface Map<String,Value>

put

@Nullable
public Value put(@Nonnull
                            String key,
                            @Nullable
                            Value value)

Specified by:

put in interface Map<String,Value>

remove

@Nullable
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

@Nonnull
public Set<String> keySet()

Gets an UNCHANGING representation of the keys.

Specified by:

keySet in interface Map<String,Value>

Returns:

set of keys

values

@Nonnull
public Collection<Value> values()

Gets an UNCHANGING representation of the values.

Specified by:

values in interface Map<String,Value>

Returns:

list of values

entrySet

@Nonnull
public 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

@Nonnull
public String toString()

Overrides:

toString in class Object