Package org.eclipse.collections.api.map.primitive

Interface PrimitiveObjectMap<V>

    • Method Detail

      • containsValue

        boolean containsValue​(Object value)

      • forEachValue

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

      • toString

        String toString()
        Returns a string with the keys and values of this map separated by commas with spaces and enclosed in curly braces. Each key and value is separated by an equals sign. 
         Assert.assertEquals(
     "{1=1, 2=2, 3=3}",
     IntObjectMaps.mutable.empty().withKeyValue(1, 1).withKeyValue(2, 2).withKeyValue(3, 3).toString());
        Specified by:
        toString in interface RichIterable<V>
        Overrides:
        toString in class Object
        Returns:
        a string representation of this PrimitiveObjectMap
        See Also:
        AbstractMap.toString()

      • select

        Bag<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.

        Example using a Java 8 lambda expression: 

         RichIterable<Person> selected =
     people.select(person -> person.getAddress().getCity().equals("London"));
        Specified by:
        select in interface RichIterable<V>

      • selectWith

        <P> Bag<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.

        E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

        Example using a Java 8 lambda expression: 

         RichIterable<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18));
        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

        Bag<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)).

        Example using a Java 8 lambda expression: 

         RichIterable<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("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

      • rejectWith

        <P> Bag<V> rejectWith​(Predicate2<? super V,​? super P> predicate,
                      P parameter)
        Description copied from interface: RichIterable
        Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

        E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

        Example using a Java 8 lambda expression: 

         RichIterable<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
        Specified by:
        rejectWith 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)

      • partition

        PartitionBag<V> partition​(Predicate<? super V> predicate)
        Description copied from interface: RichIterable
        Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

        Example using a Java 8 lambda expression: 

         PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(person -> person.getAddress().getState().getName().equals("New York"));
        Specified by:
        partition in interface RichIterable<V>

      • partitionWith

        <P> PartitionBag<V> partitionWith​(Predicate2<? super V,​? super P> predicate,
                                  P parameter)
        Description copied from interface: RichIterable
        Filters a collection into a PartitionIterable based on the evaluation of the predicate.

        Example using a Java 8 lambda expression: 

         PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
        Specified by:
        partitionWith in interface RichIterable<V>

      • selectInstancesOf

        <S> Bag<S> selectInstancesOf​(Class<S> clazz)
        Description copied from interface: RichIterable
        Returns all elements of the source collection that are instances of the Class clazz. 
         RichIterable<Integer> integers =
     List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
        Specified by:
        selectInstancesOf in interface RichIterable<V>

      • collect

        <VV> Bag<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.

        Example using a Java 8 lambda expression: 

         RichIterable<String> names =
     people.collect(person -> person.getFirstName() + " " + person.getLastName());
        Specified by:
        collect in interface RichIterable<V>

      • collectBoolean

        BooleanBag 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.

        Example using a Java 8 lambda expression: 

         BooleanIterable licenses =
     people.collectBoolean(person -> person.hasDrivingLicense());
        Specified by:
        collectBoolean in interface RichIterable<V>

      • collectByte

        ByteBag 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.

        Example using a Java 8 lambda expression: 

         ByteIterable bytes =
     people.collectByte(person -> person.getCode());
        Specified by:
        collectByte in interface RichIterable<V>

      • collectChar

        CharBag 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.

        Example using a Java 8 lambda expression: 

         CharIterable chars =
     people.collectChar(person -> person.getMiddleInitial());
        Specified by:
        collectChar in interface RichIterable<V>

      • collectDouble

        DoubleBag 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.

        Example using a Java 8 lambda expression: 

         DoubleIterable doubles =
     people.collectDouble(person -> person.getMilesFromNorthPole());
        Specified by:
        collectDouble in interface RichIterable<V>

      • collectFloat

        FloatBag 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.

        Example using a Java 8 lambda expression: 

         FloatIterable floats =
     people.collectFloat(person -> person.getHeightInInches());
        Specified by:
        collectFloat in interface RichIterable<V>

      • collectInt

        IntBag 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.

        Example using a Java 8 lambda expression: 

         IntIterable ints =
     people.collectInt(person -> person.getAge());
        Specified by:
        collectInt in interface RichIterable<V>

      • collectLong

        LongBag 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.

        Example using a Java 8 lambda expression: 

         LongIterable longs =
     people.collectLong(person -> person.getGuid());
        Specified by:
        collectLong in interface RichIterable<V>

      • collectShort

        ShortBag 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.

        Example using a Java 8 lambda expression: 

         ShortIterable shorts =
     people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
        Specified by:
        collectShort in interface RichIterable<V>

      • collectWith

        <P,​VV> Bag<VV> collectWith​(Function2<? super V,​? super P,​? extends VV> function,
                                 P parameter)
        Description copied from interface: RichIterable
        Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.

        Example using a Java 8 lambda expression: 

         RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, 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)

      • collectIf

        <VV> Bag<VV> collectIf​(Predicate<? super V> predicate,
                       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, but only for those elements which return true upon evaluation of the predicate. This is the optimized equivalent of calling iterable.select(predicate).collect(function).

        Example using a Java 8 lambda and method reference: 

         RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);

        Example using Predicates factory: 

         RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
        Specified by:
        collectIf in interface RichIterable<V>

      • flatCollect

        <VV> Bag<VV> flatCollect​(Function<? super V,​? extends Iterable<VV>> function)
        Description copied from interface: RichIterable
        flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

        Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function: 

         Function<Person, List<Address>> addressFunction = Person::getAddresses;
 RichIterable<Person> people = ...;
        Using collect returns a collection of collections of addresses. 
         RichIterable<List<Address>> addresses = people.collect(addressFunction);
        Using flatCollect returns a single flattened list of addresses. 
         RichIterable<Address> addresses = people.flatCollect(addressFunction);
        Specified by:
        flatCollect in interface RichIterable<V>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function

      • groupBy

        <VV> BagMultimap<VV,​V> groupBy​(Function<? super V,​? extends VV> function)
        Description copied from interface: RichIterable
        For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.

        Example using a Java 8 method reference: 

         Multimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName);
        Specified by:
        groupBy in interface RichIterable<V>

      • groupByUniqueKey

        <VV> UnsortedMapIterable<VV,​V> groupByUniqueKey​(Function<? super V,​? extends VV> function)
        Description copied from interface: RichIterable
        For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.
        Specified by:
        groupByUniqueKey in interface RichIterable<V>
        See Also:
        RichIterable.groupBy(Function)

      • zip

        @Deprecated
<S> Bag<Pair<V,​S>> zip​(Iterable<S> that)
        Deprecated.
        in 6.0. Use OrderedIterable.zip(Iterable) instead.
        Description copied from interface: RichIterable
        Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.
        Specified by:
        zip in interface RichIterable<V>
        Type Parameters:
        S - the type of the second half of the returned pairs
        Parameters:
        that - The RichIterable providing the second half of each result pair
        Returns:
        A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.

      • stream

        default Stream<V> stream()
        Since:
        9.0

      • parallelStream

        default Stream<V> parallelStream()
        Since:
        9.0