ImmutableCharObjectMap (Goldman Sachs Collections API

All Superinterfaces:

CharObjectMap<V>, InternalIterable<V>, java.lang.Iterable<V>, RichIterable<V>
```
public interface ImmutableCharObjectMap<V>
extends CharObjectMap<V>
```
This file was automatically generated from template file immutablePrimitiveObjectMap.stg.

Since:

3.0.

Method Summary

Methods
Modifier and Type	Method and Description
`<VV> ImmutableCollection<VV>`	`collect(Function<? super V,? extends VV> function)` Returns a new collection with the results of applying the specified function on each element of the source collection.
`ImmutableBooleanCollection`	`collectBoolean(BooleanFunction<? super V> booleanFunction)` Returns a new primitive `boolean` iterable with the results of applying the specified function on each element of the source collection.
`ImmutableByteCollection`	`collectByte(ByteFunction<? super V> byteFunction)` Returns a new primitive `byte` iterable with the results of applying the specified function on each element of the source collection.
`ImmutableCharCollection`	`collectChar(CharFunction<? super V> charFunction)` Returns a new primitive `char` iterable with the results of applying the specified function on each element of the source collection.
`ImmutableDoubleCollection`	`collectDouble(DoubleFunction<? super V> doubleFunction)` Returns a new primitive `double` iterable with the results of applying the specified function on each element of the source collection.
`ImmutableFloatCollection`	`collectFloat(FloatFunction<? super V> floatFunction)` Returns a new primitive `float` iterable with the results of applying the specified function on each element of the source collection.
`ImmutableIntCollection`	`collectInt(IntFunction<? super V> intFunction)` Returns a new primitive `int` iterable with the results of applying the specified function on each element of the source collection.
`ImmutableLongCollection`	`collectLong(LongFunction<? super V> longFunction)` Returns a new primitive `long` iterable with the results of applying the specified function on each element of the source collection.
`ImmutableShortCollection`	`collectShort(ShortFunction<? super V> ShortFunction)` Returns a new primitive `short` iterable with the results of applying the specified function on each element of the source collection.
`<P,VV> ImmutableCollection<VV>`	`collectWith(Function2<? super V,? super P,? extends VV> function, P parameter)` Same as collect with a `Function2` and specified parameter which is passed to the block
`ImmutableCharObjectMap<V>`	`newWithKeyValue(char key, V value)`
`ImmutableCharObjectMap<V>`	`newWithoutAllKeys(CharIterable keys)`
`ImmutableCharObjectMap<V>`	`newWithoutKey(char key)`
`ImmutableCharObjectMap<V>`	`reject(CharObjectPredicate<? super V> predicate)`
`ImmutableCollection<V>`	`reject(Predicate<? super V> predicate)` Returns all elements of the source collection that return false when evaluating of the predicate.
`ImmutableCharObjectMap<V>`	`select(CharObjectPredicate<? super V> predicate)`
`ImmutableCollection<V>`	`select(Predicate<? super V> predicate)` Returns all elements of the source collection that return true when evaluating the predicate.
`<P> ImmutableCollection<V>`	`selectWith(Predicate2<? super V,? super P> predicate, P parameter)` Similar to `RichIterable.select(Predicate)`, except with an evaluation parameter for the second generic argument in `Predicate2`.

Methods inherited from interface com.gs.collections.api.map.primitive.CharObjectMap
containsKey, containsValue, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, hashCode, keySet, keysView, keyValuesView, toImmutable, toString, values

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

Methods inherited from interface com.gs.collections.api.InternalIterable
forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable
iterator

- Method Detail
  - select
```
ImmutableCharObjectMap<V> select(CharObjectPredicate<? super V> predicate)
```
    Specified by:
    
    select in interface CharObjectMap<V>
  - reject
```
ImmutableCharObjectMap<V> reject(CharObjectPredicate<? super V> predicate)
```
    Specified by:
    
    reject in interface CharObjectMap<V>
  - select
```
ImmutableCollection<V> select(Predicate<? super V> predicate)
```
    Description copied from interface: RichIterable
    Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.
```
e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.getAddress().getCity().equals("Metuchen");
     }
 });
 
```
    Specified by:
    
    select in interface RichIterable<V>
  - selectWith
```
<P> ImmutableCollection<V> selectWith(Predicate2<? super V,? super P> predicate,
                                    P parameter)
```
    Description copied from interface: RichIterable
    
    Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
    
    Specified by:
    
    selectWith in interface RichIterable<V>
    
    Parameters:
    predicate - a Predicate2 to use as the select criteria
    parameter - a parameter to pass in for evaluation of the second argument P in predicate
    See Also:
    RichIterable.select(Predicate)
  - reject
```
ImmutableCollection<V> reject(Predicate<? super V> predicate)
```
    Description copied from interface: RichIterable
    Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).
```
e.g.
 return people.reject(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 });
 
```
```
e.g.
 return people.reject(Predicates.attributeEqual("lastName", "Smith"));
 
```
    Specified by:
    
    reject in interface RichIterable<V>
    
    Parameters:
    predicate - a Predicate to use as the reject criteria
    
    Returns:
    a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false
  - collect
```
<VV> ImmutableCollection<VV> collect(Function<? super V,? extends VV> function)
```
    Description copied from interface: RichIterable
    Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collect(new Function<Person, String>()
 {
     public String valueOf(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 
```
    Specified by:
    
    collect in interface RichIterable<V>
  - collectBoolean
```
ImmutableBooleanCollection collectBoolean(BooleanFunction<? super V> booleanFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectBoolean(new BooleanFunction<Person>()
 {
     public boolean booleanValueOf(Person person)
     {
         return person.hasDrivingLicense();
     }
 });
 
```
    Specified by:
    
    collectBoolean in interface RichIterable<V>
  - collectByte
```
ImmutableByteCollection collectByte(ByteFunction<? super V> byteFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectByte(new ByteFunction<Person>()
 {
     public byte byteValueOf(Person person)
     {
         return person.getCode();
     }
 });
 
```
    Specified by:
    
    collectByte in interface RichIterable<V>
  - collectChar
```
ImmutableCharCollection collectChar(CharFunction<? super V> charFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectChar(new CharFunction<Person>()
 {
     public char charValueOf(Person person)
     {
         return person.getMiddleInitial();
     }
 });
 
```
    Specified by:
    
    collectChar in interface RichIterable<V>
  - collectDouble
```
ImmutableDoubleCollection collectDouble(DoubleFunction<? super V> doubleFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectDouble(new DoubleFunction<Person>()
 {
     public double doubleValueOf(Person person)
     {
         return person.getMilesFromNorthPole();
     }
 });
 
```
    Specified by:
    
    collectDouble in interface RichIterable<V>
  - collectFloat
```
ImmutableFloatCollection collectFloat(FloatFunction<? super V> floatFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectFloat(new FloatFunction<Person>()
 {
     public float floatValueOf(Person person)
     {
         return person.getHeightInInches();
     }
 });
 
```
    Specified by:
    
    collectFloat in interface RichIterable<V>
  - collectInt
```
ImmutableIntCollection collectInt(IntFunction<? super V> intFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectInt(new IntFunction<Person>()
 {
     public int intValueOf(Person person)
     {
         return person.getAge();
     }
 });
 
```
    Specified by:
    
    collectInt in interface RichIterable<V>
  - collectLong
```
ImmutableLongCollection collectLong(LongFunction<? super V> longFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectLong(new LongFunction<Person>()
 {
     public long longValueOf(Person person)
     {
         return person.getGuid();
     }
 });
 
```
    Specified by:
    
    collectLong in interface RichIterable<V>
  - collectShort
```
ImmutableShortCollection collectShort(ShortFunction<? super V> ShortFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return people.collectShort(new ShortFunction<Person>()
 {
     public short shortValueOf(Person person)
     {
         return person.getNumberOfJunkMailItemsReceivedPerMonth();
     }
 });
 
```
    Specified by:
    
    collectShort in interface RichIterable<V>
  - collectWith
```
<P,VV> ImmutableCollection<VV> collectWith(Function2<? super V,? super P,? extends VV> function,
                                         P parameter)
```
    Description copied from interface: RichIterable
    Same as collect with a Function2 and specified parameter which is passed to the block
```
e.g.
 Function2 addParameterFunction =
 new Function2()
 {
      public Integer value(final Integer each, final Integer parameter)
      {
          return each + parameter;
      }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 
```
    Specified by:
    
    collectWith in interface RichIterable<V>
    
    Parameters:
    function - A Function2 to use as the collect transformation function
    parameter - A parameter to pass in for evaluation of the second argument P in function
    
    Returns:
    A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)
    See Also:
    RichIterable.collect(Function)
  - newWithKeyValue
```
ImmutableCharObjectMap<V> newWithKeyValue(char key,
                                        V value)
```
  - newWithoutKey
```
ImmutableCharObjectMap<V> newWithoutKey(char key)
```
  - newWithoutAllKeys
```
ImmutableCharObjectMap<V> newWithoutAllKeys(CharIterable keys)
```

Interface ImmutableCharObjectMap<V>

Method Summary

Methods inherited from interface com.gs.collections.api.map.primitive.CharObjectMap

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

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

Methods inherited from interface java.lang.Iterable

Method Detail

select

reject

select

selectWith

reject

collect

collectBoolean

collectByte

collectChar

collectDouble

collectFloat

collectInt

collectLong

collectShort

collectWith

newWithKeyValue

newWithoutKey

newWithoutAllKeys