com.wedeploy.api.sdk

Interface MultiMap<V>

All Superinterfaces:

java.lang.Iterable<java.util.Map.Entry<java.lang.String,V>>

public interface MultiMap<V>
extends java.lang.Iterable<java.util.Map.Entry<java.lang.String,V>>

Multi-map.

Method Summary

Modifier and Type	Method and Description
MultiMap<V>	add(java.lang.String name, V value) Adds a new value with the specified name and value.
MultiMap<V>	addAll(java.util.Map<java.lang.String,V> map) Adds all values from the map.
MultiMap<V>	addAll(java.lang.String name, java.lang.Iterable<V> values) Adds new values under the specified name.
MultiMap<V>	clear() Removes all values.
boolean	contains(java.lang.String name) Checks to see if there is a value with the specified name.
java.util.List<java.util.Map.Entry<java.lang.String,V>>	entries() Returns all entries in the multi-map.
V	get(java.lang.String name) Get the String value associated with a key.
java.util.List<V>	getAll(java.lang.String name) Returns the values with the specified name.
boolean	isCaseSensitive() Returns true if this map is case sensitive.
boolean	isEmpty() Returns true if empty.
java.util.Set<java.lang.String>	names() Gets a immutable Set of all names
static <T> MultiMap<T>	newCaseSensitiveMultiMap() Creates new case-sensitive implementation of the multi-map.
static <T> MultiMap<T>	newMultiMap() Creates new default implementation of the multi-map.
MultiMap<V>	remove(java.lang.String name) Removes the value with the given name
MultiMap<V>	set(java.lang.String name, V value) Sets a value under the specified name.
MultiMap<V>	setAll(java.util.Map<java.lang.String,V> map) Sets values from given map.
MultiMap<V>	setAll(java.lang.String name, java.lang.Iterable<V> values) Sets values for the specified name.
int	size() Return the number of keys.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

newCaseSensitiveMultiMap

static <T> MultiMap<T> newCaseSensitiveMultiMap()

Creates new case-sensitive implementation of the multi-map.

newMultiMap

static <T> MultiMap<T> newMultiMap()

Creates new default implementation of the multi-map.

add

MultiMap<V> add(java.lang.String name,
                V value)

Adds a new value with the specified name and value.

Parameters:

name - The name

value - The value being added

Returns:

a reference to this, so the API can be used fluently

addAll

MultiMap<V> addAll(java.util.Map<java.lang.String,V> map)

Adds all values from the map.

Parameters:

map - source map

Returns:

a reference to this, so the API can be used fluently

addAll

MultiMap<V> addAll(java.lang.String name,
                   java.lang.Iterable<V> values)

Adds new values under the specified name.

Parameters:

name - The name being set

values - The values

Returns:

a reference to this, so the API can be used fluently

clear

MultiMap<V> clear()

Removes all values.

Returns:

a reference to this, so the API can be used fluently

contains

boolean contains(java.lang.String name)

Checks to see if there is a value with the specified name.

Parameters:

name - The name to search for

Returns:

true if at least one entry is found

entries

java.util.List<java.util.Map.Entry<java.lang.String,V>> entries()

Returns all entries in the multi-map.

Returns:

A immutable List of the name-value entries, which will be empty if no pairs are found

get

V get(java.lang.String name)

Get the String value associated with a key.

getAll

java.util.List<V> getAll(java.lang.String name)

Returns the values with the specified name.

Parameters:

name - The name to search

Returns:

A immutable List of values which will be empty if no values are found

isCaseSensitive

boolean isCaseSensitive()

Returns true if this map is case sensitive.

isEmpty

boolean isEmpty()

Returns true if empty.

names

java.util.Set<java.lang.String> names()

Gets a immutable Set of all names

Returns:

A Set of all names

remove

MultiMap<V> remove(java.lang.String name)

Removes the value with the given name

Parameters:

name - The name of the value to remove

Returns:

a reference to this, so the API can be used fluently

set

MultiMap<V> set(java.lang.String name,
                V value)

Sets a value under the specified name.

If there is an existing key with the same name, it is removed.

Parameters:

name - The name

value - The value

Returns:

a reference to this, so the API can be used fluently

setAll

MultiMap<V> setAll(java.util.Map<java.lang.String,V> map)

Sets values from given map.

Parameters:

map - The source map

Returns:

a reference to this, so the API can be used fluently

setAll

MultiMap<V> setAll(java.lang.String name,
                   java.lang.Iterable<V> values)

Sets values for the specified name.

Parameters:

name - The name being set

values - The values being set

Returns:

a reference to this, so the API can be used fluently

size

int size()

Return the number of keys.