org.eclipse.scada.utils.collection

Class MapBuilder<Key,Value>

java.lang.Object

org.eclipse.scada.utils.collection.MapBuilder<Key,Value>

Type Parameters:

Key - The key type

Value - The value type

public class MapBuilder<Key,Value>
extends Object

A map builder which can create a HashMap by chained calls.

Author:

Jens Reimann <jens.reimann@th4-systems.com>

Constructor Summary

Constructors

Constructor and Description
MapBuilder()
MapBuilder(Map<Key,Value> map) Create a new map builder with the provided map as input

Method Summary

Modifier and Type	Method and Description
Map<Key,Value>	build() Return a new map which is separated from this map builder
MapBuilder<Key,Value>	clear() Clean the map held by the map builder
Map<Key,Value>	getMap() Get the map of the map builder.
MapBuilder<Key,Value>	put(Key key, Value value) Put a pair into the map held by the map builder
MapBuilder<Key,Value>	putAll(Map<Key,Value> values) Add all entries from the provided map
static <Key,Value> Map<Key,Value>	toMap(Map<Key,Value> map, Pair<Key,Value> pair) Return a new map containing the provided pair, or add the pair to an already existing map.
static <Key,Value> Map<Key,Value>	toMap(Pair<Key,Value> pair) Return a new map the containing only the provided value pair

Methods inherited from class java.lang.Object

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

Constructor Detail

MapBuilder

public MapBuilder(Map<Key,Value> map)

Create a new map builder with the provided map as input

Parameters:

map - the content that should be used as initial content. The provided map will not be modified.

MapBuilder

public MapBuilder()

Method Detail

put

public final MapBuilder<Key,Value> put(Key key,
                                       Value value)

Put a pair into the map held by the map builder

Parameters:

key - The key

value - The value

Returns:

the current instance of the map builder

putAll

public final MapBuilder<Key,Value> putAll(Map<Key,Value> values)

Add all entries from the provided map

Parameters:

values - the values to add

Returns:

the current instance of the map builder

clear

public final MapBuilder<Key,Value> clear()

Clean the map held by the map builder

Returns:

the current instance of the map builder

getMap

public final Map<Key,Value> getMap()

Get the map of the map builder.

Note that no copy is returned of the map. So further modifications using the this MapBuilder instance will change the returned map.

Returns:

The map

build

public Map<Key,Value> build()

Return a new map which is separated from this map builder

Returns:

a new and independent map

toMap

public static <Key,Value> Map<Key,Value> toMap(Pair<Key,Value> pair)

Return a new map the containing only the provided value pair

Type Parameters:

Key - The key type

Value - The value type

Parameters:

pair - The pair to add

Returns:

the new map containing the pair

toMap

public static <Key,Value> Map<Key,Value> toMap(Map<Key,Value> map,
                                               Pair<Key,Value> pair)

Return a new map containing the provided pair, or add the pair to an already existing map.

Type Parameters:

Key - The key type

Value - The value type

Parameters:

map - The map to which the pair should be added (may be null)

pair - The pair to add (may not be null)

Returns:

The (new) map.