public class

FluentCaseInsensitiveStringsMap

extends Object
implements Iterable<T> Map<K, V>
java.lang.Object
   ↳ com.ning.http.client.FluentCaseInsensitiveStringsMap

Class Overview

An implementation of a String -> List<String> map that adds a fluent interface, i.e. methods that return this instance. This class differs from FluentStringsMap in that keys are treated in an case-insensitive matter, i.e. case of the key doesn't matter when retrieving values or changing the map. However, the map preserves the key case (of the first insert or replace) and returns the keys in their original case in the appropriate methods (e.g. keySet()).

Summary

Public Constructors
FluentCaseInsensitiveStringsMap()
FluentCaseInsensitiveStringsMap(FluentCaseInsensitiveStringsMap src)
FluentCaseInsensitiveStringsMap(Map<String, Collection<String>> src)
Public Methods
FluentCaseInsensitiveStringsMap add(String key, String... values)
Adds the specified values and returns this object.
FluentCaseInsensitiveStringsMap add(String key, Collection<String> values)
Adds the specified values and returns this object.
FluentCaseInsensitiveStringsMap addAll(FluentCaseInsensitiveStringsMap src)
Adds all key-values pairs from the given object to this object and returns this object.
FluentCaseInsensitiveStringsMap addAll(Map<String, Collection<String>> src)
Adds all key-values pairs from the given map to this object and returns this object.
void clear()
boolean containsKey(Object key)
boolean containsValue(Object value)
FluentCaseInsensitiveStringsMap delete(String key)
Removes the values for the given key if present and returns this object.
FluentCaseInsensitiveStringsMap deleteAll(String... keys)
Removes the values for the given keys if present and returns this object.
FluentCaseInsensitiveStringsMap deleteAll(Collection<String> keys)
Removes the values for the given keys if present and returns this object.
Set<Entry<String, List<String>>> entrySet()
boolean equals(Object obj)
List<String> get(Object key)
String getFirstValue(String key)
Returns the value for the given key.
String getJoinedValue(String key, String delimiter)
Returns the values for the given key joined into a single string using the given delimiter.
int hashCode()
boolean isEmpty()
Iterator<Entry<String, List<String>>> iterator()
Set<String> keySet()
List<String> put(String key, List<String> value)
void putAll(Map<? extends String, ? extends List<String>> values)
List<String> remove(Object key)
FluentCaseInsensitiveStringsMap replace(String key, String... values)
Replaces the values for the given key with the given values.
FluentCaseInsensitiveStringsMap replace(String key, Collection<String> values)
Replaces the values for the given key with the given values.
FluentCaseInsensitiveStringsMap replaceAll(FluentCaseInsensitiveStringsMap src)
Replace the values for all keys from the given map that are also present in this object, with the values from the given map.
FluentCaseInsensitiveStringsMap replaceAll(Map<? extends String, ? extends Collection<String>> src)
Replace the values for all keys from the given map that are also present in this object, with the values from the given map.
int size()
String toString()
Collection<List<String>> values()
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.Iterable
From interface java.util.Map

Public Constructors

public FluentCaseInsensitiveStringsMap ()

public FluentCaseInsensitiveStringsMap (FluentCaseInsensitiveStringsMap src)

public FluentCaseInsensitiveStringsMap (Map<String, Collection<String>> src)

Public Methods

public FluentCaseInsensitiveStringsMap add (String key, String... values)

Adds the specified values and returns this object.

Parameters
key The key
values The value(s); if null then this method has no effect. Use the empty string to generate an empty value
Returns
  • This object

public FluentCaseInsensitiveStringsMap add (String key, Collection<String> values)

Adds the specified values and returns this object.

Parameters
key The key
values The value(s); if null then this method has no effect. Use an empty collection to generate an empty value
Returns
  • This object

public FluentCaseInsensitiveStringsMap addAll (FluentCaseInsensitiveStringsMap src)

Adds all key-values pairs from the given object to this object and returns this object.

Parameters
src The source object
Returns
  • This object

public FluentCaseInsensitiveStringsMap addAll (Map<String, Collection<String>> src)

Adds all key-values pairs from the given map to this object and returns this object.

Parameters
src The source map
Returns
  • This object

public void clear ()

public boolean containsKey (Object key)

public boolean containsValue (Object value)

public FluentCaseInsensitiveStringsMap delete (String key)

Removes the values for the given key if present and returns this object.

Parameters
key The key
Returns
  • This object

public FluentCaseInsensitiveStringsMap deleteAll (String... keys)

Removes the values for the given keys if present and returns this object.

Parameters
keys The keys
Returns
  • This object

public FluentCaseInsensitiveStringsMap deleteAll (Collection<String> keys)

Removes the values for the given keys if present and returns this object.

Parameters
keys The keys
Returns
  • This object

public Set<Entry<String, List<String>>> entrySet ()

public boolean equals (Object obj)

public List<String> get (Object key)

public String getFirstValue (String key)

Returns the value for the given key. If there are multiple values for this key, then only the first one will be returned.

Parameters
key The key
Returns
  • The first value

public String getJoinedValue (String key, String delimiter)

Returns the values for the given key joined into a single string using the given delimiter.

Parameters
key The key
Returns
  • The value as a single string

public int hashCode ()

public boolean isEmpty ()

public Iterator<Entry<String, List<String>>> iterator ()

public Set<String> keySet ()

public List<String> put (String key, List<String> value)

public void putAll (Map<? extends String, ? extends List<String>> values)

public List<String> remove (Object key)

public FluentCaseInsensitiveStringsMap replace (String key, String... values)

Replaces the values for the given key with the given values.

Parameters
key The key
values The new values
Returns
  • This object

public FluentCaseInsensitiveStringsMap replace (String key, Collection<String> values)

Replaces the values for the given key with the given values.

Parameters
key The key
values The new values
Returns
  • This object

public FluentCaseInsensitiveStringsMap replaceAll (FluentCaseInsensitiveStringsMap src)

Replace the values for all keys from the given map that are also present in this object, with the values from the given map. All key-values from the given object that are not present in this object, will be added to it.

Parameters
src The source object
Returns
  • This object

public FluentCaseInsensitiveStringsMap replaceAll (Map<? extends String, ? extends Collection<String>> src)

Replace the values for all keys from the given map that are also present in this object, with the values from the given map. All key-values from the given object that are not present in this object, will be added to it.

Parameters
src The source map
Returns
  • This object

public int size ()

public String toString ()

public Collection<List<String>> values ()