ImmutableUnifiedMapWithHashingStrategy (Goldman Sachs Collections

java.lang.Object
- com.gs.collections.impl.map.AbstractMapIterable<K,V>
- - com.gs.collections.impl.map.immutable.AbstractImmutableMap<K,V>
  - - com.gs.collections.impl.map.strategy.immutable.ImmutableUnifiedMapWithHashingStrategy<K,V>

All Implemented Interfaces:

com.gs.collections.api.InternalIterable<V>, com.gs.collections.api.map.ImmutableMap<K,V>, com.gs.collections.api.map.MapIterable<K,V>, com.gs.collections.api.map.UnsortedMapIterable<K,V>, com.gs.collections.api.RichIterable<V>, BatchIterable<V>, java.io.Serializable, java.lang.Iterable<V>, java.util.Map<K,V>
```
@Immutable
public class ImmutableUnifiedMapWithHashingStrategy<K,V>
extends AbstractImmutableMap<K,V>
implements BatchIterable<V>, java.io.Serializable
```
See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description
`ImmutableUnifiedMapWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, com.gs.collections.api.tuple.Pair<K,V>... pairs)`
`ImmutableUnifiedMapWithHashingStrategy(UnifiedMapWithHashingStrategy<K,V> delegate)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`batchForEach(com.gs.collections.api.block.procedure.Procedure<? super V> procedure, int sectionIndex, int sectionCount)`
`<R> com.gs.collections.api.map.ImmutableMap<K,R>`	`collectValues(com.gs.collections.api.block.function.Function2<? super K,? super V,? extends R> function)` For each key and value of the map the function is evaluated.
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set<java.util.Map.Entry<K,V>>`	`entrySet()`
`boolean`	`equals(java.lang.Object o)` Follows the same general contract as `Map.equals(Object)`.
`void`	`forEachKey(com.gs.collections.api.block.procedure.Procedure<? super K> procedure)` Calls the `procedure` with each key of the map.
`void`	`forEachKeyValue(com.gs.collections.api.block.procedure.Procedure2<? super K,? super V> procedure)` Calls the `procedure` with each key-value pair of the map.
`void`	`forEachValue(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)` Calls the procedure with each value of the map.
`<P> void`	`forEachWith(com.gs.collections.api.block.procedure.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(com.gs.collections.api.block.procedure.primitive.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(java.lang.Object key)`
`int`	`getBatchCount(int batchSize)`
`int`	`hashCode()` Follows the same general contract as `Map.hashCode()`.
`java.util.Set<K>`	`keySet()`
`com.gs.collections.api.RichIterable<K>`	`keysView()` Returns an unmodifiable lazy iterable wrapped around the keySet for the map
`com.gs.collections.api.RichIterable<com.gs.collections.api.tuple.Pair<K,V>>`	`keyValuesView()` Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map
`com.gs.collections.api.map.ImmutableMap<K,V>`	`newWithAllKeyValueArguments(com.gs.collections.api.tuple.Pair<? extends K,? extends V>... keyValuePairs)`
`com.gs.collections.api.map.ImmutableMap<K,V>`	`newWithAllKeyValues(java.lang.Iterable<? extends com.gs.collections.api.tuple.Pair<? extends K,? extends V>> keyValues)`
`com.gs.collections.api.map.ImmutableMap<K,V>`	`newWithKeyValue(K key, V value)`
`com.gs.collections.api.map.ImmutableMap<K,V>`	`newWithoutAllKeys(java.lang.Iterable<? extends K> keys)`
`com.gs.collections.api.map.ImmutableMap<K,V>`	`newWithoutKey(K key)`
`com.gs.collections.api.map.ImmutableMap<K,V>`	`reject(com.gs.collections.api.block.predicate.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.
`com.gs.collections.api.map.ImmutableMap<K,V>`	`select(com.gs.collections.api.block.predicate.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.
`java.lang.String`	`toString()` Returns a string representation of this MapIterable.
`java.util.Collection<V>`	`values()`
`com.gs.collections.api.RichIterable<V>`	`valuesView()` Returns an unmodifiable lazy iterable wrapped around the values for the map
`protected java.lang.Object`	`writeReplace()`

Methods inherited from class com.gs.collections.impl.map.immutable.AbstractImmutableMap
aggregateBy, aggregateInPlaceBy, castToMap, clear, collect, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, detect, flatCollect, flip, flipUniqueValues, groupBy, groupByEach, groupByUniqueKey, iterator, partition, partitionWith, put, putAll, reject, remove, select, selectInstancesOf, toImmutable, toMap, zip, zipWithIndex

Methods inherited from class com.gs.collections.impl.map.AbstractMapIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, forEach, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, groupBy, groupByEach, ifPresentApply, injectInto, injectInto, injectInto, injectInto, injectInto, isAbsent, isEmpty, keyAndValueEquals, keyAndValueHashCode, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, rejectWith, select, selectWith, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gs.collections.impl.parallel.BatchIterable
forEach

Methods inherited from interface com.gs.collections.api.map.MapIterable
getIfAbsent, getIfAbsentValue, getIfAbsentWith, ifPresentApply

Methods inherited from interface com.gs.collections.api.RichIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, rejectWith, select, selectWith, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable
forEach

Methods inherited from interface java.util.Map
isEmpty

- Constructor Detail
  - ImmutableUnifiedMapWithHashingStrategy
```
public ImmutableUnifiedMapWithHashingStrategy(UnifiedMapWithHashingStrategy<K,V> delegate)
```
  - ImmutableUnifiedMapWithHashingStrategy
```
public ImmutableUnifiedMapWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                                      com.gs.collections.api.tuple.Pair<K,V>... pairs)
```
- Method Detail
  - equals
```
public boolean equals(java.lang.Object o)
```
    Description copied from interface: com.gs.collections.api.map.MapIterable
    
    Follows the same general contract as Map.equals(Object).
    
    Specified by:
    
    equals in interface com.gs.collections.api.map.MapIterable<K,V>
    
    Specified by:
    
    equals in interface java.util.Map<K,V>
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Description copied from interface: com.gs.collections.api.map.MapIterable
    
    Follows the same general contract as Map.hashCode().
    
    Specified by:
    
    hashCode in interface com.gs.collections.api.map.MapIterable<K,V>
    
    Specified by:
    
    hashCode in interface java.util.Map<K,V>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Description copied from interface: com.gs.collections.api.map.MapIterable
    
    Returns a string representation of this MapIterable. The string representation consists of a list of the map's key-value pairs in the order they are returned by its iterator. The key and value in each key-value pair are separated by a colon (":") and each pair is enclosed in square brackets ("[]"). Adjacent key-value pairs are separated by the characters ", " (comma and space). Keys and values are converted to strings as by String.valueOf(Object).
    
    Specified by:
    
    toString in interface com.gs.collections.api.map.MapIterable<K,V>
    
    Specified by:
    
    toString in interface com.gs.collections.api.RichIterable<V>
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    a string representation of this MapIterable
  - size
```
public int size()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the number of items in this iterable.
    
    Specified by:
    
    size in interface com.gs.collections.api.RichIterable<V>
    
    Specified by:
    
    size in interface BatchIterable<V>
    
    Specified by:
    
    size in interface java.util.Map<K,V>
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface com.gs.collections.api.map.MapIterable<K,V>
    
    Specified by:
    
    containsKey in interface java.util.Map<K,V>
    
    See Also:
    Map.containsKey(Object)
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface com.gs.collections.api.map.MapIterable<K,V>
    
    Specified by:
    
    containsValue in interface java.util.Map<K,V>
    
    See Also:
    Map.containsValue(Object)
  - get
```
public V get(java.lang.Object key)
```
    Specified by:
    
    get in interface com.gs.collections.api.map.MapIterable<K,V>
    
    Specified by:
    
    get in interface java.util.Map<K,V>
    
    See Also:
    Map.get(Object)
  - getBatchCount
```
public int getBatchCount(int batchSize)
```
    Specified by:
    
    getBatchCount in interface BatchIterable<V>
  - batchForEach
```
public void batchForEach(com.gs.collections.api.block.procedure.Procedure<? super V> procedure,
                int sectionIndex,
                int sectionCount)
```
    Specified by:
    
    batchForEach in interface BatchIterable<V>
  - forEachValue
```
public void forEachValue(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)
```
    Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.MapIterable<K,V>
    
    Overrides:
    
    forEachValue in class AbstractMapIterable<K,V>
  - forEachKey
```
public void forEachKey(com.gs.collections.api.block.procedure.Procedure<? super K> procedure)
```
    Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.MapIterable<K,V>
    
    Overrides:
    
    forEachKey in class AbstractMapIterable<K,V>
  - forEachKeyValue
```
public void forEachKeyValue(com.gs.collections.api.block.procedure.Procedure2<? super K,? super V> procedure)
```
    Description copied from interface: com.gs.collections.api.map.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(new Procedure2<Integer, String>()
     {
         public void value(final Integer key, final String value)
         {
             collection.add(String.valueOf(key) + value);
         }
     });
     Verify.assertContainsAll(collection, "1One", "2Two", "3Three");
 
```
    Specified by:
    
    forEachKeyValue in interface com.gs.collections.api.map.MapIterable<K,V>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<K,V>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<K,V>
    
    Overrides:
    
    entrySet in class AbstractImmutableMap<K,V>
  - keySet
```
public java.util.Set<K> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<K,V>
  - values
```
public java.util.Collection<V> values()
```
    Specified by:
    
    values in interface java.util.Map<K,V>
  - keysView
```
public com.gs.collections.api.RichIterable<K> keysView()
```
    Description copied from interface: com.gs.collections.api.map.MapIterable
    
    Returns an unmodifiable lazy iterable wrapped around the keySet for the map
    
    Specified by:
    
    keysView in interface com.gs.collections.api.map.MapIterable<K,V>
  - valuesView
```
public com.gs.collections.api.RichIterable<V> valuesView()
```
    Description copied from interface: com.gs.collections.api.map.MapIterable
    
    Returns an unmodifiable lazy iterable wrapped around the values for the map
    
    Specified by:
    
    valuesView in interface com.gs.collections.api.map.MapIterable<K,V>
  - keyValuesView
```
public com.gs.collections.api.RichIterable<com.gs.collections.api.tuple.Pair<K,V>> keyValuesView()
```
    Description copied from interface: com.gs.collections.api.map.MapIterable
    
    Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map
    
    Specified by:
    
    keyValuesView in interface com.gs.collections.api.map.MapIterable<K,V>
  - forEachWithIndex
```
public void forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super V> objectIntProcedure)
```
    Description copied from interface: com.gs.collections.api.InternalIterable
    Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
```
e.g.
 people.forEachWithIndex(new ObjectIntProcedure()
 {
     public void value(Person person, int index)
     {
         LOGGER.info("Index: " + index + " person: " + person.getName());
     }
 });
 
```
    Specified by:
    
    forEachWithIndex in interface com.gs.collections.api.InternalIterable<V>
    
    Overrides:
    
    forEachWithIndex in class AbstractMapIterable<K,V>
  - forEachWith
```
public <P> void forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super V,? super P> procedure,
                   P parameter)
```
    Description copied from interface: com.gs.collections.api.InternalIterable
    The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
```
e.g.
 people.forEachWith(new Procedure2()
 {
     public void value(Person person, Person other)
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }
 }, fred);
 
```
    Specified by:
    
    forEachWith in interface com.gs.collections.api.InternalIterable<V>
    
    Overrides:
    
    forEachWith in class AbstractMapIterable<K,V>
  - newWithKeyValue
```
public com.gs.collections.api.map.ImmutableMap<K,V> newWithKeyValue(K key,
                                                           V value)
```
    Specified by:
    
    newWithKeyValue in interface com.gs.collections.api.map.ImmutableMap<K,V>
    
    Overrides:
    
    newWithKeyValue in class AbstractImmutableMap<K,V>
  - newWithAllKeyValues
```
public com.gs.collections.api.map.ImmutableMap<K,V> newWithAllKeyValues(java.lang.Iterable<? extends com.gs.collections.api.tuple.Pair<? extends K,? extends V>> keyValues)
```
    Specified by:
    
    newWithAllKeyValues in interface com.gs.collections.api.map.ImmutableMap<K,V>
    
    Overrides:
    
    newWithAllKeyValues in class AbstractImmutableMap<K,V>
  - newWithAllKeyValueArguments
```
public com.gs.collections.api.map.ImmutableMap<K,V> newWithAllKeyValueArguments(com.gs.collections.api.tuple.Pair<? extends K,? extends V>... keyValuePairs)
```
    Specified by:
    
    newWithAllKeyValueArguments in interface com.gs.collections.api.map.ImmutableMap<K,V>
    
    Overrides:
    
    newWithAllKeyValueArguments in class AbstractImmutableMap<K,V>
  - newWithoutKey
```
public com.gs.collections.api.map.ImmutableMap<K,V> newWithoutKey(K key)
```
    Specified by:
    
    newWithoutKey in interface com.gs.collections.api.map.ImmutableMap<K,V>
    
    Overrides:
    
    newWithoutKey in class AbstractImmutableMap<K,V>
  - newWithoutAllKeys
```
public com.gs.collections.api.map.ImmutableMap<K,V> newWithoutAllKeys(java.lang.Iterable<? extends K> keys)
```
    Specified by:
    
    newWithoutAllKeys in interface com.gs.collections.api.map.ImmutableMap<K,V>
    
    Overrides:
    
    newWithoutAllKeys in class AbstractImmutableMap<K,V>
  - collectValues
```
public <R> com.gs.collections.api.map.ImmutableMap<K,R> collectValues(com.gs.collections.api.block.function.Function2<? super K,? super V,? extends R> function)
```
    Description copied from interface: com.gs.collections.api.map.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.
```
e.g.
 peopleByCity.collectValues(new Function2<City, Person, String>()
 {
     public String value(City city, Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 
```
    Specified by:
    
    collectValues in interface com.gs.collections.api.map.ImmutableMap<K,V>
    
    Specified by:
    
    collectValues in interface com.gs.collections.api.map.MapIterable<K,V>
    
    Specified by:
    
    collectValues in interface com.gs.collections.api.map.UnsortedMapIterable<K,V>
    
    Overrides:
    
    collectValues in class AbstractImmutableMap<K,V>
  - select
```
public com.gs.collections.api.map.ImmutableMap<K,V> select(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)
```
    Description copied from interface: com.gs.collections.api.map.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.
```
e.g.
 peopleByCity.select(new Predicate2<City, Person>()
 {
     public boolean accept(City city, Person person)
     {
         return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
     }
 });
 
```
    Specified by:
    
    select in interface com.gs.collections.api.map.ImmutableMap<K,V>
    
    Specified by:
    
    select in interface com.gs.collections.api.map.MapIterable<K,V>
    
    Specified by:
    
    select in interface com.gs.collections.api.map.UnsortedMapIterable<K,V>
    
    Overrides:
    
    select in class AbstractImmutableMap<K,V>
  - reject
```
public com.gs.collections.api.map.ImmutableMap<K,V> reject(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)
```
    Description copied from interface: com.gs.collections.api.map.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.
```
e.g.
 peopleByCity.reject(new Predicate2<City, Person>()
 {
     public boolean accept(City city, Person person)
     {
         return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
     }
 });
 
```
    Specified by:
    
    reject in interface com.gs.collections.api.map.ImmutableMap<K,V>
    
    Specified by:
    
    reject in interface com.gs.collections.api.map.MapIterable<K,V>
    
    Specified by:
    
    reject in interface com.gs.collections.api.map.UnsortedMapIterable<K,V>
    
    Overrides:
    
    reject in class AbstractImmutableMap<K,V>
  - writeReplace
```
protected java.lang.Object writeReplace()
```

Class ImmutableUnifiedMapWithHashingStrategy<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.gs.collections.impl.map.immutable.AbstractImmutableMap

Methods inherited from class com.gs.collections.impl.map.AbstractMapIterable

Methods inherited from class java.lang.Object

Methods inherited from interface com.gs.collections.impl.parallel.BatchIterable

Methods inherited from interface com.gs.collections.api.map.MapIterable

Methods inherited from interface com.gs.collections.api.RichIterable

Methods inherited from interface com.gs.collections.api.InternalIterable

Methods inherited from interface java.util.Map

Constructor Detail

ImmutableUnifiedMapWithHashingStrategy

ImmutableUnifiedMapWithHashingStrategy

Method Detail

equals

hashCode

toString

size

containsKey

containsValue

get

getBatchCount

batchForEach

forEachValue

forEachKey

forEachKeyValue

entrySet

keySet

values

keysView

valuesView

keyValuesView

forEachWithIndex

forEachWith

newWithKeyValue

newWithAllKeyValues

newWithAllKeyValueArguments

newWithoutKey

newWithoutAllKeys

collectValues

select

reject

writeReplace