be.SIRAPRISE.util

Class MyMap

java.lang.Object

be.SIRAPRISE.util.MyMap

public class MyMap
extends java.lang.Object

MyMap provides utility methods relating to Maps.

Author:

Erwin

Method Summary

Modifier and Type	Method and Description
static <K,V> java.util.Map<K,V>	intersect(java.util.Map<K,V> map1, K[] keysToBeIncluded) Returns a Map that holds only the entries from map1 whose keys also occur in keys-to-be-included.
static <K,V> java.util.Map<K,V>	intersect(java.util.Map<K,V> map1, K[] keysToBeIncluded, java.lang.Class<? extends java.util.Map<K,V>> resultClass) Returns a Map that holds only the entries of map1 whose keys also occur in keys-to-be-included
static <K,V> java.util.Map<K,V>	intersect(java.util.Map<K,V> map1, java.util.Set<K> keysToBeIncluded) Returns a Map that holds only the entries from map1 whose keys also occur in keys-to-be-included.
static <K,V> java.util.Map<K,V>	intersect(java.util.Map<K,V> map1, java.util.Set<K> keysToBeIncluded, java.lang.Class<? extends java.util.Map<K,V>> resultClass) Returns a Map that holds only the entries of map1 whose keys also occur in keys-to-be-included
static <K,V> void	intersectIntoMap(java.util.Map<K,V> map1, K[] keysToBeIncluded, java.util.Map<? super K,? super V> result) Puts all entries that appear either in map1 in the result map, iff its key appears in the given set of keys-to-be-included.
static <K,V> void	intersectIntoMap(java.util.Map<K,V> map1, java.util.Set<K> keysToBeIncluded, java.util.Map<? super K,? super V> result) Puts all entries that appear either in map1 in the result map, iff its key appears in the given set of keys-to-be-included.
static <K,V> java.util.Map<K,V>	minus(java.util.Map<K,V> map1, java.util.Collection<K> keysToBeExcluded) Returns a Map that holds only the entries whose keys do not occur in the given set of keys-to-be-excluded
static <K,V> java.util.Map<K,V>	minus(java.util.Map<K,V> map1, java.util.Collection<K> keysToBeExcluded, java.lang.Class<? extends java.util.Map<K,V>> resultClass) Returns a Map that holds only the entries whose keys do not occur in the given set of keys-to-be-excluded
static <K,V> void	minusIntoMap(java.util.Map<K,V> map1, java.util.Collection<K> keysToBeExcluded, java.util.Map<? super K,? super V> result) Puts all entries that appear either in map1 in the result map, iff its key does not appear in the given set of keys-to-be-excluded.
static <K,V> java.util.Map<K,V>	union(java.util.Map<K,V> map1, java.util.Map<K,V> map2) Returns a Map that holds all the entries that appear either in map1 or map2
static <K,V> java.util.Map<K,V>	union(java.util.Map<K,V> map1, java.util.Map<K,V> map2, java.lang.Class<? extends java.util.Map<K,V>> resultClass) Returns a Map that holds all the entries that appear either in map1 or map2
static <K,V> void	unionIntoMap(java.util.Map<K,V> map1, java.util.Map<K,V> map2, java.util.Map<? super K,? super V> result) Puts all entries that appear either in map1 or map2 in the result map.

Methods inherited from class java.lang.Object

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

Method Detail

intersect

public static <K,V> java.util.Map<K,V> intersect(java.util.Map<K,V> map1,
                                                 K[] keysToBeIncluded)

Returns a Map that holds only the entries from map1 whose keys also occur in keys-to-be-included.

Type Parameters:

K - the key type

V - the value type

Parameters:

map1 - A map whose entries are to be copied into the result, iff the entry's key value appears in keysToBeExcluded

keysToBeIncluded - The set of keys that are to appear in the resulting map

Returns:

a Map that holds only the entries from map1 whose keys also occur in keys-to-be-included.

intersect

public static <K,V> java.util.Map<K,V> intersect(java.util.Map<K,V> map1,
                                                 K[] keysToBeIncluded,
                                                 java.lang.Class<? extends java.util.Map<K,V>> resultClass)
                                          throws java.lang.InstantiationException,
                                                 java.lang.IllegalAccessException

Returns a Map that holds only the entries of map1 whose keys also occur in keys-to-be-included

Type Parameters:

K - the key type

V - the value type

Parameters:

map1 - The map to be copied from / 'intersected' with the given set of keys-to-be-included

keysToBeIncluded - the keys that are to appear in the resulting map

resultClass - the Class that the result object must be. This class must implement the Map interface and have a public no-arg constructor.

Returns:

a Map that holds only the entries of map1 whose keys also occur in keys-to-be-included

Throws:

java.lang.IllegalAccessException - if the class or its nullary constructor is not accessible.

java.lang.InstantiationException - if this Class represents an abstract class, an interface, an array class, a primitive type, or void; or if the class has no nullary constructor; or if the instantiation fails for some other reason.

intersect

public static <K,V> java.util.Map<K,V> intersect(java.util.Map<K,V> map1,
                                                 java.util.Set<K> keysToBeIncluded)

Returns a Map that holds only the entries from map1 whose keys also occur in keys-to-be-included.

Type Parameters:

K - the key type

V - the value type

Parameters:

map1 - A map whose entries are to be copied into the result, iff the entry's key value appears in keysToBeExcluded

keysToBeIncluded - The set of keys that are to appear in the resulting map

Returns:

a Map that holds only the entries from map1 whose keys also occur in keys-to-be-included.

intersect

public static <K,V> java.util.Map<K,V> intersect(java.util.Map<K,V> map1,
                                                 java.util.Set<K> keysToBeIncluded,
                                                 java.lang.Class<? extends java.util.Map<K,V>> resultClass)
                                          throws java.lang.InstantiationException,
                                                 java.lang.IllegalAccessException

Returns a Map that holds only the entries of map1 whose keys also occur in keys-to-be-included

Type Parameters:

K - the key type

V - the value type

Parameters:

map1 - The map to be copied from / 'intersected' with the given set of keys-to-be-included

keysToBeIncluded - the keys that are to appear in the resulting map

resultClass - the Class that the result object must be. This class must implement the Map interface and have a public no-arg constructor.

Returns:

a Map that holds only the entries of map1 whose keys also occur in keys-to-be-included

Throws:

java.lang.IllegalAccessException - if the class or its nullary constructor is not accessible.

java.lang.InstantiationException - if this Class represents an abstract class, an interface, an array class, a primitive type, or void; or if the class has no nullary constructor; or if the instantiation fails for some other reason.

intersectIntoMap

public static <K,V> void intersectIntoMap(java.util.Map<K,V> map1,
                                          K[] keysToBeIncluded,
                                          java.util.Map<? super K,? super V> result)

Puts all entries that appear either in map1 in the result map, iff its key appears in the given set of keys-to-be-included.

Type Parameters:

K - the key type

V - the value type

Parameters:

map1 - A map whose entries are to be copied into the result, iff the entry's key value appears in keysToBeExcluded

keysToBeIncluded - The set of keys that are to appear in the resulting map

result - A map to put the result in. The map is cleared first.

intersectIntoMap

public static <K,V> void intersectIntoMap(java.util.Map<K,V> map1,
                                          java.util.Set<K> keysToBeIncluded,
                                          java.util.Map<? super K,? super V> result)

Puts all entries that appear either in map1 in the result map, iff its key appears in the given set of keys-to-be-included.

Type Parameters:

K - the key type

V - the value type

Parameters:

map1 - A map whose entries are to be copied into the result, iff the entry's key value appears in keysToBeExcluded

keysToBeIncluded - The set of keys that are to appear in the resulting map

result - A map to put the result in. The map is cleared first.

minus

public static <K,V> java.util.Map<K,V> minus(java.util.Map<K,V> map1,
                                             java.util.Collection<K> keysToBeExcluded)

Returns a Map that holds only the entries whose keys do not occur in the given set of keys-to-be-excluded

Type Parameters:

K - the key type

V - the value type

Parameters:

map1 - A map whose entries are to be copied into the result, but for the entries whose key value appears in keysToBeExcluded

keysToBeExcluded - The set of keys that are not to appear in the resulting map

Returns:

A map holding map1's entries whose keys do not occur in keys-to-be-excluded

minus

public static <K,V> java.util.Map<K,V> minus(java.util.Map<K,V> map1,
                                             java.util.Collection<K> keysToBeExcluded,
                                             java.lang.Class<? extends java.util.Map<K,V>> resultClass)
                                      throws java.lang.InstantiationException,
                                             java.lang.IllegalAccessException

Returns a Map that holds only the entries whose keys do not occur in the given set of keys-to-be-excluded

Type Parameters:

K - the key type

V - the value type

Parameters:

map1 - A map whose entries are to be copied into the result, but for the entries whose key value appears in keysToBeExcluded

keysToBeExcluded - The set of keys that are not to appear in the resulting map

resultClass - the Class that the result object must be

Returns:

A map holding map1's entries whose keys do not occur in keys-to-be-excluded

Throws:

java.lang.IllegalAccessException - if the class or its nullary constructor is not accessible.

java.lang.InstantiationException - if this Class represents an abstract class, an interface, an array class, a primitive type, or void; or if the class has no nullary constructor; or if the instantiation fails for some other reason.

minusIntoMap

public static <K,V> void minusIntoMap(java.util.Map<K,V> map1,
                                      java.util.Collection<K> keysToBeExcluded,
                                      java.util.Map<? super K,? super V> result)

Puts all entries that appear either in map1 in the result map, iff its key does not appear in the given set of keys-to-be-excluded.

Type Parameters:

K - the key type

V - the value type

Parameters:

map1 - A map whose entries are to be copied into the result, but for the entries whose key value appears in keysToBeExcluded

keysToBeExcluded - The set of keys that are not to appear in the resulting map

result - A map to put the result in. The map is cleared first.

union

public static <K,V> java.util.Map<K,V> union(java.util.Map<K,V> map1,
                                             java.util.Map<K,V> map2)
                                      throws EqualKeyUnequalValuesException

Returns a Map that holds all the entries that appear either in map1 or map2

Type Parameters:

K - the key type

V - the value type

Parameters:

map1 - A map to be 'unioned' with map2

map2 - A map to be 'unioned' with map1

Returns:

a Map that holds all the entries that appear either in map1 or map2

Throws:

EqualKeyUnequalValuesException - If some key value appears in both map1 and map2, and that key maps to two unequal values that are both non-null.

union

public static <K,V> java.util.Map<K,V> union(java.util.Map<K,V> map1,
                                             java.util.Map<K,V> map2,
                                             java.lang.Class<? extends java.util.Map<K,V>> resultClass)
                                      throws EqualKeyUnequalValuesException,
                                             java.lang.InstantiationException,
                                             java.lang.IllegalAccessException

Returns a Map that holds all the entries that appear either in map1 or map2

Type Parameters:

K - the key type

V - the value type

Parameters:

map1 - the map to be unioned with map2

map2 - the map to be unioned with map1

resultClass - the Class that the result object must be. This class must implement the Map interface, and have a public no-arg constructor.

Returns:

A map that holds all the entries that appear either in map1 or map2

Throws:

EqualKeyUnequalValuesException - If some key value appears in both map1 and map2, and that key maps to two unequal values that are both non-null.

java.lang.IllegalAccessException - if the class or its nullary constructor is not accessible.

java.lang.InstantiationException - if this Class represents an abstract class, an interface, an array class, a primitive type, or void; or if the class has no nullary constructor; or if the instantiation fails for some other reason.

unionIntoMap

public static <K,V> void unionIntoMap(java.util.Map<K,V> map1,
                                      java.util.Map<K,V> map2,
                                      java.util.Map<? super K,? super V> result)
                               throws EqualKeyUnequalValuesException

Puts all entries that appear either in map1 or map2 in the result map.

Type Parameters:

K - the key type

V - the value type

Parameters:

map1 - A map to be 'unioned' with map2

map2 - A map to be 'unioned' with map1

result - A map wherein all entries of map1 and map2 are placed. The map is cleared first.

Throws:

EqualKeyUnequalValuesException - If some key value appears in both map1 and map2, and that key maps to two unequal values that are both non-null.