Class DoubletonMap<K,V>

java.lang.Object

org.eclipse.collections.impl.AbstractRichIterable<V>

org.eclipse.collections.impl.map.AbstractMapIterable<K,V>

org.eclipse.collections.impl.map.mutable.AbstractMutableMapIterable<K,V>

org.eclipse.collections.impl.map.mutable.AbstractMutableMap<K,V>

org.eclipse.collections.impl.map.fixed.AbstractMemoryEfficientMutableMap<K,V>

org.eclipse.collections.impl.map.fixed.DoubletonMap<K,V>

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Iterable<V>, Map<K,V>, InternalIterable<V>, FixedSizeMap<K,V>, MapIterable<K,V>, MutableMap<K,V>, MutableMapIterable<K,V>, UnsortedMapIterable<K,V>, RichIterable<V>

final class DoubletonMap<K,V>
extends AbstractMemoryEfficientMutableMap<K,V>
implements Externalizable

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMutableMap

AbstractMutableMap.ValuesCollectionCommon<V>

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
private K	key1
private K	key2
private static final long	serialVersionUID
private V	value1
private V	value2

Constructor Summary

Constructors

Constructor	Description
DoubletonMap()
DoubletonMap(K key1, V value1, K key2, V value2)

Method Summary

Modifier and Type	Method	Description
DoubletonMap<K,V>	clone()
<K2,V2> FixedSizeMap<K2,V2>	collect(Function2<? super K, ? super V, Pair<K2,V2>> function)	For each key and value of the map the function is evaluated.
<R> FixedSizeMap<R,V>	collectKeysUnique(Function2<? super K, ? super V, ? extends R> function)	For each key and value of the map the function is evaluated.
<R> FixedSizeMap<K,R>	collectValues(Function2<? super K, ? super V, ? extends R> function)	For each key and value of the map the function is evaluated.
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Pair<K,V>	detect(Predicate2<? super K, ? super V> predicate)	Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments.
MutableSet<Map.Entry<K,V>>	entrySet()
boolean	equals(Object other)	Follows the same general contract as Map.equals(Object).
private FixedSizeMap<K,V>	filter(Predicate2<? super K, ? super V> predicate)
MutableMap<V,K>	flipUniqueValues()	Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEachKey(Procedure<? super K> procedure)	Calls the procedure with each key of the map.
void	forEachKeyValue(Procedure2<? super K, ? super V> procedure)	Calls the procedure with each key-value pair of the map.
void	forEachValue(Procedure<? super V> procedure)	Calls the procedure with each value of the map.
<P> void	forEachWith(Procedure2<? super V, ? super P> procedure, P parameter)	The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
void	forEachWithIndex(ObjectIntProcedure<? super V> objectIntProcedure)	Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.
V	get(Object key)
(package private) K	getKey1()
(package private) K	getKey2()
V	getOnly()	Returns the element if the iterable has exactly one element.
int	hashCode()	Follows the same general contract as Map.hashCode().
Set<K>	keySet()
void	readExternal(ObjectInput in)
FixedSizeMap<K,V>	reject(Predicate2<? super K, ? super V> predicate)	For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.
FixedSizeMap<K,V>	select(Predicate2<? super K, ? super V> predicate)	For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.
int	size()	Returns the number of items in this iterable.
ImmutableMap<K,V>	toImmutable()	Returns an immutable copy of this map.
String	toString()	Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets.
Collection<V>	values()
MutableMap<K,V>	withKeyValue(K addKey, V addValue)	This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.
MutableMap<K,V>	withoutKey(K key)	This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.
void	writeExternal(ObjectOutput out)

Methods inherited from class AbstractMemoryEfficientMutableMap

clear, collectKeysAndValues, merge, newEmpty, newEmpty, put, putAll, remove, removeAllKeys, removeIf, removeKey, tap, updateValue, updateValueWith, withAllKeyValueArguments, withAllKeyValues, withoutAllKeys

Methods inherited from class AbstractMutableMap

asSynchronized, asUnmodifiable, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, flatCollect, flip, groupBy, groupByEach, groupByUniqueKey, partition, partitionWith, reject, rejectWith, replaceAll, select, selectInstancesOf, selectWith, zip, zipWithIndex

Methods inherited from class AbstractMutableMapIterable

aggregateBy, countBy, countByEach, countByWith, detectOptional, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWith, getIfAbsentPutWithKey, iterator, keysView, keyValuesView, reduceBy, sumByDouble, sumByFloat, sumByInt, sumByLong, valuesView

Methods inherited from class AbstractMapIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, asLazy, chunk, contains, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, getOrDefault, ifPresentApply, isAbsent, keyAndValueEquals, keyAndValueHashCode, noneSatisfy, noneSatisfyWith, toArray, toArray

Methods inherited from class AbstractRichIterable

appendString, appendString, collect, collectIf, collectWith, containsAll, containsAllArguments, containsAllIterable, count, countWith, flatCollect, forEach, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, max, max, maxBy, min, min, minBy, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toBiMap, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface FixedSizeMap

putAllMapIterable, withMap, withMapIterable

Methods inherited from interface InternalIterable

forEach

Methods inherited from interface Iterable

iterator

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, isEmpty, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface MapIterable

detectOptional, getIfAbsent, getIfAbsentValue, getIfAbsentWith, ifPresentApply, injectIntoKeyValue, keysView, keyValuesView, parallelStream, spliterator, stream, valuesView

Methods inherited from interface MutableMap

aggregateBy, aggregateBy, aggregateInPlaceBy, asSynchronized, asUnmodifiable, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, flatCollect, flatCollectWith, flip, groupBy, groupByEach, groupByUniqueKey, partition, partitionWith, reduceBy, reject, rejectWith, select, selectInstancesOf, selectWith, zip, zipWithIndex

Methods inherited from interface MutableMapIterable

add, countBy, countByEach, countByWith, forEach, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWith, getIfAbsentPutWithKey, getOrDefault, putPair, sumByDouble, sumByFloat, sumByInt, sumByLong

Methods inherited from interface RichIterable

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getFirst, getLast, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

key1

private K key1

value1

private V value1

key2

private K key2

value2

private V value2

Constructor Details

DoubletonMap

public DoubletonMap()

DoubletonMap

DoubletonMap(K key1,
 V value1,
 K key2,
 V value2)

Method Details

size

public int size()

Description copied from interface: RichIterable

Returns the number of items in this iterable.

Specified by:

size in interface Map<K,V>

Specified by:

size in interface RichIterable<K>

getKey1

K getKey1()

getKey2

K getKey2()

withKeyValue

public MutableMap<K,V> withKeyValue(K addKey,
 V addValue)

Description copied from interface: MutableMapIterable

This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus the additional key and value. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:

map = map.withKeyValue("new key", "new value");

In the case of FixedSizeMap, a new instance will be returned by withKeyValue, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.

Specified by:

withKeyValue in interface MutableMap<K,V>

Specified by:

withKeyValue in interface MutableMapIterable<K,V>

Overrides:

withKeyValue in class AbstractMutableMap<K,V>

See Also:

• Map.put(Object, Object)

withoutKey

public MutableMap<K,V> withoutKey(K key)

Description copied from interface: MutableMapIterable

This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus the key and value to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:

map = map.withoutKey("key");

In the case of FixedSizeMap, a new instance will be returned by withoutKey, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.

Specified by:

withoutKey in interface MutableMap<K,V>

Specified by:

withoutKey in interface MutableMapIterable<K,V>

Overrides:

withoutKey in class AbstractMutableMap<K,V>

See Also:

• Map.remove(Object)

clone

public DoubletonMap<K,V> clone()

Specified by:

clone in interface MutableMap<K,V>

Specified by:

clone in class AbstractMutableMap<K,V>

toImmutable

public ImmutableMap<K,V> toImmutable()

Description copied from interface: MutableMapIterable

Returns an immutable copy of this map. If the map is immutable, it returns itself.

Specified by:

toImmutable in interface MapIterable<K,V>

Specified by:

toImmutable in interface MutableMapIterable<K,V>

Specified by:

toImmutable in interface UnsortedMapIterable<K,V>

Overrides:

toImmutable in class AbstractMutableMap<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

Specified by:

containsKey in interface MapIterable<K,V>

See Also:

• Map.containsKey(Object)

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

Specified by:

containsValue in interface MapIterable<K,V>

See Also:

• Map.containsValue(Object)

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

Specified by:

get in interface MapIterable<K,V>

See Also:

• Map.get(Object)

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

entrySet

public MutableSet<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

hashCode

public int hashCode()

Description copied from interface: MapIterable

Follows the same general contract as Map.hashCode().

Specified by:

hashCode in interface Map<K,V>

Specified by:

hashCode in interface MapIterable<K,V>

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Description copied from interface: MapIterable

Follows the same general contract as Map.equals(Object).

Specified by:

equals in interface Map<K,V>

Specified by:

equals in interface MapIterable<K,V>

Overrides:

equals in class Object

toString

public String toString()

Description copied from class: AbstractRichIterable

Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets.

Assert.assertEquals("[]", Lists.mutable.empty().toString());
Assert.assertEquals("[1]", Lists.mutable.with(1).toString());
Assert.assertEquals("[1, 2, 3]", Lists.mutable.with(1, 2, 3).toString());

Specified by:

toString in interface MapIterable<K,V>

Specified by:

toString in interface RichIterable<K>

Overrides:

toString in class AbstractRichIterable<V>

Returns:

a string representation of this collection.

See Also:

• AbstractCollection.toString()

flipUniqueValues

public MutableMap<V,K> flipUniqueValues()

Description copied from interface: MapIterable

Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.

    MapIterable<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
    MapIterable<String, Integer> result = map.flipUniqueValues();
    Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));

Specified by:

flipUniqueValues in interface MapIterable<K,V>

Specified by:

flipUniqueValues in interface MutableMap<K,V>

Specified by:

flipUniqueValues in interface MutableMapIterable<K,V>

Specified by:

flipUniqueValues in interface UnsortedMapIterable<K,V>

Overrides:

flipUniqueValues in class AbstractMutableMapIterable<K,V>

forEachKeyValue

public void forEachKeyValue(Procedure2<? super K, ? super V> procedure)

Description copied from interface: MapIterable

Calls the procedure with each key-value pair of the map.

    final Collection<String> collection = new ArrayList<String>();
    MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "One", 2, "Two", 3, "Three");
    map.forEachKeyValue((Integer key, String value) -> collection.add(String.valueOf(key) + value));
    Verify.assertContainsAll(collection, "1One", "2Two", "3Three");

Specified by:

forEachKeyValue in interface MapIterable<K,V>

forEachKey

public void forEachKey(Procedure<? super K> procedure)

Description copied from interface: MapIterable

Calls the procedure with each key of the map.

    final Collection<Integer> result = new ArrayList<Integer>();
    MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
    map.forEachKey(new CollectionAddProcedure<Integer>(result));
    Verify.assertContainsAll(result, 1, 2, 3);

Specified by:

forEachKey in interface MapIterable<K,V>

Overrides:

forEachKey in class AbstractMapIterable<K,V>

forEachValue

public void forEachValue(Procedure<? super V> procedure)

Description copied from interface: MapIterable

Calls the procedure with each value of the map.

    Set<String> result = UnifiedSet.newSet();
    MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "One", 2, "Two", 3, "Three", 4, "Four");
    map.forEachValue(new CollectionAddProcedure<String>(result));
    Verify.assertSetsEqual(UnifiedSet.newSetWith("One", "Two", "Three", "Four"), result);

Specified by:

forEachValue in interface MapIterable<K,V>

Overrides:

forEachValue in class AbstractMapIterable<K,V>

forEachWithIndex

public void forEachWithIndex(ObjectIntProcedure<? super V> objectIntProcedure)

Description copied from interface: InternalIterable

Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.

Example using a Java 8 lambda:

people.forEachWithIndex((Person person, int index) -> LOGGER.info("Index: " + index + " person: " + person.getName()));

Example using an anonymous inner class:

people.forEachWithIndex(new ObjectIntProcedure<Person>()
{
    public void value(Person person, int index)
    {
        LOGGER.info("Index: " + index + " person: " + person.getName());
    }
});

Specified by:

forEachWithIndex in interface InternalIterable<K>

Overrides:

forEachWithIndex in class AbstractMapIterable<K,V>

forEachWith

public <P> void forEachWith(Procedure2<? super V, ? super P> procedure,
 P parameter)

Description copied from interface: InternalIterable

The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.

Example using a Java 8 lambda:

people.forEachWith((Person person, Person other) ->
    {
        if (person.isRelatedTo(other))
        {
             LOGGER.info(person.getName());
        }
    }, fred);

Example using an anonymous inner class:

people.forEachWith(new Procedure2<Person, Person>()
{
    public void value(Person person, Person other)
    {
        if (person.isRelatedTo(other))
        {
             LOGGER.info(person.getName());
        }
    }
}, fred);

Specified by:

forEachWith in interface InternalIterable<K>

Overrides:

forEachWith in class AbstractMapIterable<K,V>

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

select

public FixedSizeMap<K,V> select(Predicate2<? super K, ? super V> predicate)

Description copied from interface: MapIterable

For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.

MapIterable<City, Person> selected =
    peopleByCity.select((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));

Specified by:

select in interface MapIterable<K,V>

Specified by:

select in interface MutableMap<K,V>

Specified by:

select in interface MutableMapIterable<K,V>

Specified by:

select in interface UnsortedMapIterable<K,V>

Specified by:

select in class AbstractMemoryEfficientMutableMap<K,V>

collectValues

public <R> FixedSizeMap<K,R> collectValues(Function2<? super K, ? super V, ? extends R> function)

Description copied from interface: MapIterable

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.

MapIterable<City, String> collected =
    peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName());

Specified by:

collectValues in interface MapIterable<K,V>

Specified by:

collectValues in interface MutableMap<K,V>

Specified by:

collectValues in interface MutableMapIterable<K,V>

Specified by:

collectValues in interface UnsortedMapIterable<K,V>

Specified by:

collectValues in class AbstractMemoryEfficientMutableMap<K,V>

collectKeysUnique

public <R> FixedSizeMap<R,V> collectKeysUnique(Function2<? super K, ? super V, ? extends R> function)

Description copied from interface: MapIterable

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the keys projected from the function rather than the original keys.

Specified by:

collectKeysUnique in interface MapIterable<K,V>

Specified by:

collectKeysUnique in interface MutableMap<K,V>

Specified by:

collectKeysUnique in interface MutableMapIterable<K,V>

Specified by:

collectKeysUnique in class AbstractMemoryEfficientMutableMap<K,V>

collect

public <K2,V2> FixedSizeMap<K2,V2> collect(Function2<? super K, ? super V, Pair<K2,V2>> function)

Description copied from interface: MapIterable

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.

MapIterable<String, String> collected =
    peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity()));

Specified by:

collect in interface MapIterable<K,V>

Specified by:

collect in interface MutableMap<K,V>

Specified by:

collect in interface MutableMapIterable<K,V>

Specified by:

collect in interface UnsortedMapIterable<K,V>

Specified by:

collect in class AbstractMemoryEfficientMutableMap<K,V>

reject

public FixedSizeMap<K,V> reject(Predicate2<? super K, ? super V> predicate)

Description copied from interface: MapIterable

For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.

MapIterable<City, Person> rejected =
    peopleByCity.reject((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));

Specified by:

reject in interface MapIterable<K,V>

Specified by:

reject in interface MutableMap<K,V>

Specified by:

reject in interface MutableMapIterable<K,V>

Specified by:

reject in interface UnsortedMapIterable<K,V>

Specified by:

reject in class AbstractMemoryEfficientMutableMap<K,V>

detect

public Pair<K,V> detect(Predicate2<? super K, ? super V> predicate)

Description copied from interface: MapIterable

Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments. The predicate will only be evaluated until such pair is found or until all the keys and values of the map have been used as arguments. That is, there may be keys and values of the map that are never used as arguments to the predicate. The result is null if predicate does not evaluate to true for any key/value combination.

Pair<City, Person> detected =
    peopleByCity.detect((City city, Person person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));

Specified by:

detect in interface MapIterable<K,V>

Overrides:

detect in class AbstractMutableMapIterable<K,V>

filter

private FixedSizeMap<K,V> filter(Predicate2<? super K, ? super V> predicate)

getOnly

public V getOnly()

Description copied from interface: RichIterable

Returns the element if the iterable has exactly one element. Otherwise, throw IllegalStateException.

Specified by:

getOnly in interface RichIterable<K>

Overrides:

getOnly in class AbstractMapIterable<K,V>

Returns:

an element of an iterable.