Class IntObjectHashMap<V>

    • Constructor Detail

      • IntObjectHashMap

        public IntObjectHashMap()
      • IntObjectHashMap

        public IntObjectHashMap​(int initialCapacity)
      • IntObjectHashMap

        public IntObjectHashMap​(IntObjectMap<? extends V> map)
    • Method Detail

      • smallestPowerOfTwoGreaterThan

        private int smallestPowerOfTwoGreaterThan​(int n)
      • fastCeil

        private int fastCeil​(float v)
      • newWithKeysValues

        public static <V> IntObjectHashMap<V> newWithKeysValues​(int key,
                                                                V value)
      • newWithKeysValues

        public static <V> IntObjectHashMap<V> newWithKeysValues​(int key1,
                                                                V value1,
                                                                int key2,
                                                                V value2)
      • newWithKeysValues

        public static <V> IntObjectHashMap<V> newWithKeysValues​(int key1,
                                                                V value1,
                                                                int key2,
                                                                V value2,
                                                                int key3,
                                                                V value3)
      • newWithKeysValues

        public static <V> IntObjectHashMap<V> newWithKeysValues​(int key1,
                                                                V value1,
                                                                int key2,
                                                                V value2,
                                                                int key3,
                                                                V value3,
                                                                int key4,
                                                                V value4)
      • equals

        public boolean equals​(java.lang.Object obj)
        Description copied from interface: PrimitiveObjectMap
        Follows the same general contract as Map.equals(Object).
        Specified by:
        equals in interface PrimitiveObjectMap<V>
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Description copied from interface: PrimitiveObjectMap
        Follows the same general contract as Map.hashCode().
        Specified by:
        hashCode in interface PrimitiveObjectMap<V>
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Description copied from interface: PrimitiveObjectMap
        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 PrimitiveObjectMap<V>
        Specified by:
        toString in interface RichIterable<V>
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this PrimitiveObjectMap
        See Also:
        AbstractMap.toString()
      • size

        public int size()
        Description copied from interface: RichIterable
        Returns the number of items in this iterable.
        Specified by:
        size in interface RichIterable<V>
      • isEmpty

        public boolean isEmpty()
        Description copied from interface: RichIterable
        Returns true if this iterable has zero items.
        Specified by:
        isEmpty in interface RichIterable<V>
      • notEmpty

        public boolean notEmpty()
        Description copied from interface: RichIterable
        The English equivalent of !this.isEmpty()
        Specified by:
        notEmpty in interface RichIterable<V>
      • makeString

        public java.lang.String makeString()
        Description copied from interface: RichIterable
        Returns a string representation of this collection by delegating to RichIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
        Specified by:
        makeString in interface RichIterable<V>
        Returns:
        a string representation of this collection.
      • makeString

        public java.lang.String makeString​(java.lang.String separator)
        Description copied from interface: RichIterable
        Returns a string representation of this collection by delegating to RichIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
        Specified by:
        makeString in interface RichIterable<V>
        Returns:
        a string representation of this collection.
      • makeString

        public java.lang.String makeString​(java.lang.String start,
                                           java.lang.String separator,
                                           java.lang.String end)
        Description copied from interface: RichIterable
        Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
        Specified by:
        makeString in interface RichIterable<V>
        Returns:
        a string representation of this collection.
      • appendString

        public void appendString​(java.lang.Appendable appendable)
        Description copied from interface: RichIterable
        Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString().
        Specified by:
        appendString in interface RichIterable<V>
      • appendString

        public void appendString​(java.lang.Appendable appendable,
                                 java.lang.String separator)
        Description copied from interface: RichIterable
        Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String).
        Specified by:
        appendString in interface RichIterable<V>
      • iterator

        public java.util.Iterator<V> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<V>
      • toArray

        public java.lang.Object[] toArray()
        Description copied from interface: RichIterable
        Converts this iterable to an array.
        Specified by:
        toArray in interface RichIterable<V>
        See Also:
        Collection.toArray()
      • toArray

        public <T> T[] toArray​(T[] a)
        Description copied from interface: RichIterable
        Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
        Specified by:
        toArray in interface RichIterable<V>
        See Also:
        Collection.toArray(Object[])
      • contains

        public boolean contains​(java.lang.Object object)
        Description copied from interface: RichIterable
        Returns true if the iterable has an element which responds true to element.equals(object).
        Specified by:
        contains in interface RichIterable<V>
      • containsAllIterable

        public boolean containsAllIterable​(java.lang.Iterable<?> source)
        Description copied from interface: RichIterable
        Returns true if all elements in source are contained in this collection.
        Specified by:
        containsAllIterable in interface RichIterable<V>
      • containsAll

        public boolean containsAll​(java.util.Collection<?> source)
        Description copied from interface: RichIterable
        Returns true if all elements in source are contained in this collection.
        Specified by:
        containsAll in interface RichIterable<V>
        See Also:
        Collection.containsAll(Collection)
      • containsAllArguments

        public boolean containsAllArguments​(java.lang.Object... elements)
        Description copied from interface: RichIterable
        Returns true if all elements in the specified var arg array are contained in this collection.
        Specified by:
        containsAllArguments in interface RichIterable<V>
      • each

        public void each​(Procedure<? super V> procedure)
        Description copied from interface: RichIterable
        The procedure is executed for each element in the iterable.

        Example using a Java 8 lambda expression:

         people.each(person -> LOGGER.info(person.getName()));
         

        Example using an anonymous inner class:

         people.each(new Procedure<Person>()
         {
             public void value(Person person)
             {
                 LOGGER.info(person.getName());
             }
         });
         
        This method is a variant of InternalIterable.forEach(Procedure) that has a signature conflict with Iterable.forEach(java.util.function.Consumer).
        Specified by:
        each in interface RichIterable<V>
        See Also:
        InternalIterable.forEach(Procedure), Iterable.forEach(java.util.function.Consumer)
      • 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<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<V>
      • forEachKey

        public void forEachKey​(IntProcedure procedure)
        Description copied from interface: IntObjectMap
        Iterates through each key in the map, invoking the procedure for each.
        Specified by:
        forEachKey in interface IntObjectMap<V>
        Parameters:
        procedure - the procedure to invoke for each key
      • forEachKeyValue

        public void forEachKeyValue​(IntObjectProcedure<? super V> procedure)
        Description copied from interface: IntObjectMap
        Iterates through each key/value pair in the map, invoking the procedure for each.
        Specified by:
        forEachKeyValue in interface IntObjectMap<V>
        Parameters:
        procedure - the procedure to invoke for each key/value pair
      • select

        public IntObjectHashMap<V> select​(IntObjectPredicate<? super V> predicate)
        Description copied from interface: IntObjectMap
        Return a copy of this map containing only the key/value pairs that match the predicate.
        Specified by:
        select in interface IntObjectMap<V>
        Specified by:
        select in interface MutableIntObjectMap<V>
        Parameters:
        predicate - the predicate to determine which key/value pairs in this map should be included in the returned map
        Returns:
        a copy of this map with the matching key/value pairs
      • reject

        public IntObjectHashMap<V> reject​(IntObjectPredicate<? super V> predicate)
        Description copied from interface: IntObjectMap
        Return a copy of this map containing only the key/value pairs that do not match the predicate.
        Specified by:
        reject in interface IntObjectMap<V>
        Specified by:
        reject in interface MutableIntObjectMap<V>
        Parameters:
        predicate - the predicate to determine which key/value pairs in this map should be excluded from the returned map
        Returns:
        a copy of this map without the matching key/value pairs
      • select

        public MutableBag<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"));
         

        Example using an anonymous inner class:

         RichIterable<Person> selected =
             people.select(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.getAddress().getCity().equals("London");
                 }
             });
         
        Specified by:
        select in interface MutablePrimitiveObjectMap<V>
        Specified by:
        select in interface PrimitiveObjectMap<V>
        Specified by:
        select in interface RichIterable<V>
      • select

        public <R extends java.util.Collection<V>> R select​(Predicate<? super V> predicate,
                                                            R target)
        Description copied from interface: RichIterable
        Same as the select method with one parameter but uses the specified target collection for the results.

        Example using a Java 8 lambda expression:

         MutableList<Person> selected =
             people.select(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
         

        Example using an anonymous inner class:

         MutableList<Person> selected =
             people.select(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.person.getLastName().equals("Smith");
                 }
             }, Lists.mutable.empty());
         

        Specified by:
        select in interface RichIterable<V>
        Parameters:
        predicate - a Predicate to use as the select criteria
        target - the Collection to append to for all elements in this RichIterable that meet select criteria predicate
        Returns:
        target, which contains appended elements as a result of the select criteria
        See Also:
        RichIterable.select(Predicate)
      • selectWith

        public <P> MutableBag<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));
         

        Example using an anonymous inner class:

         RichIterable<Person> selected =
             people.selectWith(new Predicate2<Person, Integer>()
             {
                 public boolean accept(Person person, Integer age)
                 {
                     return person.getAge()>= age;
                 }
             }, Integer.valueOf(18));
         
        Specified by:
        selectWith in interface MutablePrimitiveObjectMap<V>
        Specified by:
        selectWith in interface PrimitiveObjectMap<V>
        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)
      • selectWith

        public <P,​R extends java.util.Collection<V>> R selectWith​(Predicate2<? super V,​? super P> predicate,
                                                                        P parameter,
                                                                        R targetCollection)
        Description copied from interface: RichIterable
        Similar to RichIterable.select(Predicate, Collection), 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:

         MutableList<Person> selected =
             people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18), Lists.mutable.empty());
         

        Example using an anonymous inner class:

         MutableList<Person> selected =
             people.selectWith(new Predicate2<Person, Integer>()
             {
                 public boolean accept(Person person, Integer age)
                 {
                     return person.getAge()>= age;
                 }
             }, Integer.valueOf(18), Lists.mutable.empty());
         
        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
        targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria predicate
        Returns:
        targetCollection, which contains appended elements as a result of the select criteria
        See Also:
        RichIterable.select(Predicate), RichIterable.select(Predicate, Collection)
      • reject

        public MutableBag<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"));
         

        Example using an anonymous inner class:

         RichIterable<Person> rejected =
             people.reject(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.person.getLastName().equals("Smith");
                 }
             });
         
        Specified by:
        reject in interface MutablePrimitiveObjectMap<V>
        Specified by:
        reject in interface PrimitiveObjectMap<V>
        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
      • reject

        public <R extends java.util.Collection<V>> R reject​(Predicate<? super V> predicate,
                                                            R target)
        Description copied from interface: RichIterable
        Same as the reject method with one parameter but uses the specified target collection for the results.

        Example using a Java 8 lambda expression:

         MutableList<Person> rejected =
             people.reject(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
         

        Example using an anonymous inner class:

         MutableList<Person> rejected =
             people.reject(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.person.getLastName().equals("Smith");
                 }
             }, Lists.mutable.empty());
         
        Specified by:
        reject in interface RichIterable<V>
        Parameters:
        predicate - a Predicate to use as the reject criteria
        target - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false
        Returns:
        target, which contains appended elements as a result of the reject criteria
      • rejectWith

        public <P> MutableBag<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));
         

        Example using an anonymous inner class:

         MutableList<Person> rejected =
             people.rejectWith(new Predicate2<Person, Integer>()
             {
                 public boolean accept(Person person, Integer age)
                 {
                     return person.getAge() < age;
                 }
             }, Integer.valueOf(18));
         
        Specified by:
        rejectWith in interface MutablePrimitiveObjectMap<V>
        Specified by:
        rejectWith in interface PrimitiveObjectMap<V>
        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)
      • rejectWith

        public <P,​R extends java.util.Collection<V>> R rejectWith​(Predicate2<? super V,​? super P> predicate,
                                                                        P parameter,
                                                                        R targetCollection)
        Description copied from interface: RichIterable
        Similar to RichIterable.reject(Predicate, Collection), 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:

         MutableList<Person> rejected =
             people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18), Lists.mutable.empty());
         

        Example using an anonymous inner class:

         MutableList<Person> rejected =
             people.rejectWith(new Predicate2<Person, Integer>()
             {
                 public boolean accept(Person person, Integer age)
                 {
                     return person.getAge() < age;
                 }
             }, Integer.valueOf(18), Lists.mutable.empty());
         
        Specified by:
        rejectWith in interface RichIterable<V>
        Parameters:
        predicate - a Predicate2 to use as the reject criteria
        parameter - a parameter to pass in for evaluation of the second argument P in predicate
        targetCollection - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false
        Returns:
        targetCollection, which contains appended elements as a result of the reject criteria
        See Also:
        RichIterable.reject(Predicate), RichIterable.reject(Predicate, Collection)
      • partition

        public PartitionMutableBag<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"));
         

        Example using an anonymous inner class:

         PartitionIterable<Person> newYorkersAndNonNewYorkers =
             people.partition(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.getAddress().getState().getName().equals("New York");
                 }
             });
         
        Specified by:
        partition in interface MutablePrimitiveObjectMap<V>
        Specified by:
        partition in interface PrimitiveObjectMap<V>
        Specified by:
        partition in interface RichIterable<V>
      • partitionWith

        public <P> PartitionMutableBag<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");
         

        Example using an anonymous inner class:

         PartitionIterable<Person> newYorkersAndNonNewYorkers =
             people.partitionWith(new Predicate2<Person, String>()
             {
                 public boolean accept(Person person, String state)
                 {
                     return person.getAddress().getState().getName().equals(state);
                 }
             }, "New York");
         
        Specified by:
        partitionWith in interface MutablePrimitiveObjectMap<V>
        Specified by:
        partitionWith in interface PrimitiveObjectMap<V>
        Specified by:
        partitionWith in interface RichIterable<V>
      • collect

        public <VV> MutableBag<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());
         

        Example using an anonymous inner class:

         RichIterable<String> names =
             people.collect(new Function<Person, String>()
             {
                 public String valueOf(Person person)
                 {
                     return person.getFirstName() + " " + person.getLastName();
                 }
             });
         
        Specified by:
        collect in interface MutablePrimitiveObjectMap<V>
        Specified by:
        collect in interface PrimitiveObjectMap<V>
        Specified by:
        collect in interface RichIterable<V>
      • collectBoolean

        public MutableBooleanBag 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());
         

        Example using an anonymous inner class:

         BooleanIterable licenses =
             people.collectBoolean(new BooleanFunction<Person>()
             {
                 public boolean booleanValueOf(Person person)
                 {
                     return person.hasDrivingLicense();
                 }
             });
         
        Specified by:
        collectBoolean in interface MutablePrimitiveObjectMap<V>
        Specified by:
        collectBoolean in interface PrimitiveObjectMap<V>
        Specified by:
        collectBoolean in interface RichIterable<V>
      • collectByte

        public MutableByteBag 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());
         

        Example using an anonymous inner class:

         ByteIterable bytes =
             people.collectByte(new ByteFunction<Person>()
             {
                 public byte byteValueOf(Person person)
                 {
                     return person.getCode();
                 }
             });
         
        Specified by:
        collectByte in interface MutablePrimitiveObjectMap<V>
        Specified by:
        collectByte in interface PrimitiveObjectMap<V>
        Specified by:
        collectByte in interface RichIterable<V>
      • collectChar

        public MutableCharBag 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());
         

        Example using an anonymous inner class:

         CharIterable chars =
             people.collectChar(new CharFunction<Person>()
             {
                 public char charValueOf(Person person)
                 {
                     return person.getMiddleInitial();
                 }
             });
         
        Specified by:
        collectChar in interface MutablePrimitiveObjectMap<V>
        Specified by:
        collectChar in interface PrimitiveObjectMap<V>
        Specified by:
        collectChar in interface RichIterable<V>
      • collectDouble

        public MutableDoubleBag 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());
         

        Example using an anonymous inner class:

         DoubleIterable doubles =
             people.collectDouble(new DoubleFunction<Person>()
             {
                 public double doubleValueOf(Person person)
                 {
                     return person.getMilesFromNorthPole();
                 }
             });
         
        Specified by:
        collectDouble in interface MutablePrimitiveObjectMap<V>
        Specified by:
        collectDouble in interface PrimitiveObjectMap<V>
        Specified by:
        collectDouble in interface RichIterable<V>
      • collectFloat

        public MutableFloatBag 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());
         

        Example using an anonymous inner class:

         FloatIterable floats =
             people.collectFloat(new FloatFunction<Person>()
             {
                 public float floatValueOf(Person person)
                 {
                     return person.getHeightInInches();
                 }
             });
         
        Specified by:
        collectFloat in interface MutablePrimitiveObjectMap<V>
        Specified by:
        collectFloat in interface PrimitiveObjectMap<V>
        Specified by:
        collectFloat in interface RichIterable<V>
      • collectInt

        public MutableIntBag 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());
         

        Example using an anonymous inner class:

         IntIterable ints =
             people.collectInt(new IntFunction<Person>()
             {
                 public int intValueOf(Person person)
                 {
                     return person.getAge();
                 }
             });
         
        Specified by:
        collectInt in interface MutablePrimitiveObjectMap<V>
        Specified by:
        collectInt in interface PrimitiveObjectMap<V>
        Specified by:
        collectInt in interface RichIterable<V>
      • collectLong

        public MutableLongBag 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());
         

        Example using an anonymous inner class:

         LongIterable longs =
             people.collectLong(new LongFunction<Person>()
             {
                 public long longValueOf(Person person)
                 {
                     return person.getGuid();
                 }
             });
         
        Specified by:
        collectLong in interface MutablePrimitiveObjectMap<V>
        Specified by:
        collectLong in interface PrimitiveObjectMap<V>
        Specified by:
        collectLong in interface RichIterable<V>
      • collectShort

        public MutableShortBag 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());
         

        Example using an anonymous inner class:

         ShortIterable shorts =
             people.collectShort(new ShortFunction<Person>()
             {
                 public short shortValueOf(Person person)
                 {
                     return person.getNumberOfJunkMailItemsReceivedPerMonth();
                 }
             });
         
        Specified by:
        collectShort in interface MutablePrimitiveObjectMap<V>
        Specified by:
        collectShort in interface PrimitiveObjectMap<V>
        Specified by:
        collectShort in interface RichIterable<V>
      • collectWith

        public <P,​VV> MutableBag<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));
         

        Example using an anonymous inner class:

         Function2<Integer, Integer, Integer> addParameterFunction =
             new Function2<Integer, Integer, Integer>()
             {
                 public Integer value(Integer each, Integer parameter)
                 {
                     return each + parameter;
                 }
             };
         RichIterable<Integer> integers =
             Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
         
        Specified by:
        collectWith in interface MutablePrimitiveObjectMap<V>
        Specified by:
        collectWith in interface PrimitiveObjectMap<V>
        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)
      • collectWith

        public <P,​VV,​R extends java.util.Collection<VV>> R collectWith​(Function2<? super V,​? super P,​? extends VV> function,
                                                                                   P parameter,
                                                                                   R targetCollection)
        Description copied from interface: RichIterable
        Same as collectWith but with a targetCollection parameter to gather the results.

        Example using a Java 8 lambda expression:

         MutableSet<Integer> integers =
             Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1), Sets.mutable.empty());
         

        Example using an anonymous inner class:

         Function2<Integer, Integer, Integer> addParameterFunction =
             new Function2<Integer, Integer, Integer>()
             {
                 public Integer value(final Integer each, final Integer parameter)
                 {
                     return each + parameter;
                 }
             };
         MutableSet<Integer> integers =
             Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1), Sets.mutable.empty());
         
        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
        targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria function
        Returns:
        targetCollection, which contains appended elements as a result of the collect transformation
      • collect

        public <VV,​R extends java.util.Collection<VV>> R collect​(Function<? super V,​? extends VV> function,
                                                                       R target)
        Description copied from interface: RichIterable
        Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.

        Example using a Java 8 lambda expression:

         MutableList<String> names =
             people.collect(person -> person.getFirstName() + " " + person.getLastName(), Lists.mutable.empty());
         

        Example using an anonymous inner class:

         MutableList<String> names =
             people.collect(new Function<Person, String>()
             {
                 public String valueOf(Person person)
                 {
                     return person.getFirstName() + " " + person.getLastName();
                 }
             }, Lists.mutable.empty());
         
        Specified by:
        collect in interface RichIterable<V>
        Parameters:
        function - a Function to use as the collect transformation function
        target - the Collection to append to for all elements in this RichIterable that meet select criteria function
        Returns:
        target, which contains appended elements as a result of the collect transformation
        See Also:
        RichIterable.collect(Function)
      • collectIf

        public <VV> MutableBag<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 MutablePrimitiveObjectMap<V>
        Specified by:
        collectIf in interface PrimitiveObjectMap<V>
        Specified by:
        collectIf in interface RichIterable<V>
      • collectIf

        public <VV,​R extends java.util.Collection<VV>> R collectIf​(Predicate<? super V> predicate,
                                                                         Function<? super V,​? extends VV> function,
                                                                         R target)
        Description copied from interface: RichIterable
        Same as the collectIf method with two parameters but uses the specified target collection for the results.
        Specified by:
        collectIf in interface RichIterable<V>
        Parameters:
        predicate - a Predicate to use as the select criteria
        function - a Function to use as the collect transformation function
        target - the Collection to append to for all elements in this RichIterable that meet the collect criteria predicate
        Returns:
        targetCollection, which contains appended elements as a result of the collect criteria and transformation
        See Also:
        RichIterable.collectIf(Predicate, Function)
      • flatCollect

        public <VV> MutableBag<VV> flatCollect​(Function<? super V,​? extends java.lang.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 MutablePrimitiveObjectMap<V>
        Specified by:
        flatCollect in interface PrimitiveObjectMap<V>
        Specified by:
        flatCollect in interface RichIterable<V>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function
      • flatCollect

        public <VV,​R extends java.util.Collection<VV>> R flatCollect​(Function<? super V,​? extends java.lang.Iterable<VV>> function,
                                                                           R target)
        Description copied from interface: RichIterable
        Same as flatCollect, only the results are collected into the target collection.
        Specified by:
        flatCollect in interface RichIterable<V>
        Parameters:
        function - The Function to apply
        target - The collection into which results should be added.
        Returns:
        target, which will contain a flattened collection of results produced by applying the given function
        See Also:
        RichIterable.flatCollect(Function)
      • detect

        public V detect​(Predicate<? super V> predicate)
        Description copied from interface: RichIterable
        Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find.

        Example using a Java 8 lambda expression:

         Person person =
             people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
         

        Example using an anonymous inner class:

         Person person =
             people.detect(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
                 }
             });
         
        Specified by:
        detect in interface RichIterable<V>
      • detectWith

        public <P> V detectWith​(Predicate2<? super V,​? super P> predicate,
                                P parameter)
        Description copied from interface: RichIterable
        Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.

        Example using a Java 8 lambda expression:

         Person person =
             people.detectWith((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
         

        Example using an anonymous inner class:

         Person person =
             people.detectWith(new Predicate2<Person, String>()
             {
                 public boolean accept(Person person, String fullName)
                 {
                     return person.getFullName().equals(fullName);
                 }
             }, "John Smith");
         
        Specified by:
        detectWith in interface RichIterable<V>
      • detectOptional

        public java.util.Optional<V> detectOptional​(Predicate<? super V> predicate)
        Description copied from interface: RichIterable
        Returns the first element of the iterable for which the predicate evaluates to true as an Optional. This method is commonly called find.

        Example using a Java 8 lambda expression:

         Person person =
             people.detectOptional(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
         

        Specified by:
        detectOptional in interface RichIterable<V>
      • detectWithOptional

        public <P> java.util.Optional<V> detectWithOptional​(Predicate2<? super V,​? super P> predicate,
                                                            P parameter)
        Description copied from interface: RichIterable
        Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.

        Example using a Java 8 lambda expression:

         Optional<Person> person =
             people.detectWithOptional((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
         

        Specified by:
        detectWithOptional in interface RichIterable<V>
      • detectIfNone

        public V detectIfNone​(Predicate<? super V> predicate,
                              Function0<? extends V> function)
        Description copied from interface: RichIterable
        Returns the first element of the iterable for which the predicate evaluates to true. If no element matches the predicate, then returns the value of applying the specified function.
        Specified by:
        detectIfNone in interface RichIterable<V>
      • detectWithIfNone

        public <P> V detectWithIfNone​(Predicate2<? super V,​? super P> predicate,
                                      P parameter,
                                      Function0<? extends V> function)
        Description copied from interface: RichIterable
        Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.
        Specified by:
        detectWithIfNone in interface RichIterable<V>
      • count

        public int count​(Predicate<? super V> predicate)
        Description copied from interface: RichIterable
        Return the total number of elements that answer true to the specified predicate.

        Example using a Java 8 lambda expression:

         int count =
             people.count(person -> person.getAddress().getState().getName().equals("New York"));
         

        Example using an anonymous inner class:

         int count =
             people.count(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.getAddress().getState().getName().equals("New York");
                 }
             });
         
        Specified by:
        count in interface RichIterable<V>
      • countWith

        public <P> int countWith​(Predicate2<? super V,​? super P> predicate,
                                 P parameter)
        Description copied from interface: RichIterable
        Returns the total number of elements that evaluate to true for the specified predicate.
        e.g.
         return lastNames.countWith(Predicates2.equal(), "Smith");
         
        Specified by:
        countWith in interface RichIterable<V>
      • anySatisfy

        public boolean anySatisfy​(Predicate<? super V> predicate)
        Description copied from interface: RichIterable
        Returns true if the predicate evaluates to true for any element of the iterable. Returns false if the iterable is empty, or if no element returned true when evaluating the predicate.
        Specified by:
        anySatisfy in interface RichIterable<V>
      • anySatisfyWith

        public <P> boolean anySatisfyWith​(Predicate2<? super V,​? super P> predicate,
                                          P parameter)
        Description copied from interface: RichIterable
        Returns true if the predicate evaluates to true for any element of the collection, or return false. Returns false if the collection is empty.
        Specified by:
        anySatisfyWith in interface RichIterable<V>
      • allSatisfy

        public boolean allSatisfy​(Predicate<? super V> predicate)
        Description copied from interface: RichIterable
        Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty. Otherwise, returns false.
        Specified by:
        allSatisfy in interface RichIterable<V>
      • allSatisfyWith

        public <P> boolean allSatisfyWith​(Predicate2<? super V,​? super P> predicate,
                                          P parameter)
        Description copied from interface: RichIterable
        Returns true if the predicate evaluates to true for every element of the collection, or returns false.
        Specified by:
        allSatisfyWith in interface RichIterable<V>
      • noneSatisfy

        public boolean noneSatisfy​(Predicate<? super V> predicate)
        Description copied from interface: RichIterable
        Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. Otherwise, returns false.
        Specified by:
        noneSatisfy in interface RichIterable<V>
      • noneSatisfyWith

        public <P> boolean noneSatisfyWith​(Predicate2<? super V,​? super P> predicate,
                                           P parameter)
        Description copied from interface: RichIterable
        Returns true if the predicate evaluates to false for every element of the collection, or return false. Returns true if the collection is empty.
        Specified by:
        noneSatisfyWith in interface RichIterable<V>
      • injectInto

        public <IV> IV injectInto​(IV injectedValue,
                                  Function2<? super IV,​? super V,​? extends IV> function)
        Description copied from interface: RichIterable
        Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. This method is commonly called fold or sometimes reduce.
        Specified by:
        injectInto in interface RichIterable<V>
      • injectInto

        public int injectInto​(int injectedValue,
                              IntObjectToIntFunction<? super V> function)
        Description copied from interface: RichIterable
        Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
        Specified by:
        injectInto in interface RichIterable<V>
      • injectInto

        public long injectInto​(long injectedValue,
                               LongObjectToLongFunction<? super V> function)
        Description copied from interface: RichIterable
        Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
        Specified by:
        injectInto in interface RichIterable<V>
      • injectInto

        public float injectInto​(float injectedValue,
                                FloatObjectToFloatFunction<? super V> function)
        Description copied from interface: RichIterable
        Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
        Specified by:
        injectInto in interface RichIterable<V>
      • injectInto

        public double injectInto​(double injectedValue,
                                 DoubleObjectToDoubleFunction<? super V> function)
        Description copied from interface: RichIterable
        Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
        Specified by:
        injectInto in interface RichIterable<V>
      • zip

        @Deprecated
        public <S> MutableBag<Pair<V,​S>> zip​(java.lang.Iterable<S> that)
        Deprecated.
        in 7.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 MutablePrimitiveObjectMap<V>
        Specified by:
        zip in interface PrimitiveObjectMap<V>
        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.
      • chunk

        public RichIterable<RichIterable<V>> chunk​(int size)
        Description copied from interface: RichIterable
        Partitions elements in fixed size chunks.
        Specified by:
        chunk in interface RichIterable<V>
        Parameters:
        size - the number of elements per chunk
        Returns:
        A RichIterable containing RichIterables of size size, except the last will be truncated if the elements don't divide evenly.
      • aggregateInPlaceBy

        public <K,​VV> MutableMap<K,​VV> aggregateInPlaceBy​(Function<? super V,​? extends K> groupBy,
                                                                      Function0<? extends VV> zeroValueFactory,
                                                                      Procedure2<? super VV,​? super V> mutatingAggregator)
        Description copied from interface: RichIterable
        Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).
        Specified by:
        aggregateInPlaceBy in interface MutablePrimitiveObjectMap<V>
        Specified by:
        aggregateInPlaceBy in interface RichIterable<V>
      • groupBy

        public <VV> MutableBagMultimap<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);
         

        Example using an anonymous inner class:

         Multimap<String, Person> peopleByLastName =
             people.groupBy(new Function<Person, String>()
             {
                 public String valueOf(Person person)
                 {
                     return person.getLastName();
                 }
             });
         
        Specified by:
        groupBy in interface MutablePrimitiveObjectMap<V>
        Specified by:
        groupBy in interface PrimitiveObjectMap<V>
        Specified by:
        groupBy in interface RichIterable<V>
      • groupBy

        public <VV,​R extends MutableMultimap<VV,​V>> R groupBy​(Function<? super V,​? extends VV> function,
                                                                          R target)
        Description copied from interface: RichIterable
        Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.

        Example using a Java 8 method reference:

         FastListMultimap<String, Person> peopleByLastName =
             people.groupBy(Person::getLastName, new FastListMultimap<String, Person>());
         

        Example using an anonymous inner class:

         FastListMultimap<String, Person> peopleByLastName =
             people.groupBy(new Function<Person, String>()
             {
                 public String valueOf(Person person)
                 {
                     return person.getLastName();
                 }
             }, new FastListMultimap<String, Person>());
         
        Specified by:
        groupBy in interface RichIterable<V>
      • getFirst

        public V getFirst()
        Description copied from interface: RichIterable
        Returns the first element of an iterable. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

        The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.

        Specified by:
        getFirst in interface RichIterable<V>
      • getLast

        public V getLast()
        Description copied from interface: RichIterable
        Returns the last element of an iterable. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

        The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.

        Specified by:
        getLast in interface RichIterable<V>
      • 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<V>
        Returns:
        an element of an iterable.
      • into

        public <R extends java.util.Collection<V>> R into​(R target)
        Description copied from interface: RichIterable
        Adds all the elements in this iterable to the specific target Collection.
        Specified by:
        into in interface RichIterable<V>
      • toSortedSet

        public MutableSortedSet<V> toSortedSet()
        Description copied from interface: RichIterable
        Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.
        Specified by:
        toSortedSet in interface RichIterable<V>
      • toSortedSet

        public MutableSortedSet<V> toSortedSet​(java.util.Comparator<? super V> comparator)
        Description copied from interface: RichIterable
        Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.
        Specified by:
        toSortedSet in interface RichIterable<V>
      • toSortedBag

        public MutableSortedBag<V> toSortedBag()
        Description copied from interface: RichIterable
        Converts the collection to a MutableSortedBag implementation and sorts it using the natural order of the elements.
        Specified by:
        toSortedBag in interface RichIterable<V>
      • toSortedBag

        public MutableSortedBag<V> toSortedBag​(java.util.Comparator<? super V> comparator)
        Description copied from interface: RichIterable
        Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.
        Specified by:
        toSortedBag in interface RichIterable<V>
      • toMap

        public <NK,​NV> MutableMap<NK,​NV> toMap​(Function<? super V,​? extends NK> keyFunction,
                                                           Function<? super V,​? extends NV> valueFunction)
        Description copied from interface: RichIterable
        Converts the collection to a MutableMap implementation using the specified key and value functions.
        Specified by:
        toMap in interface RichIterable<V>
      • toSortedMap

        public <NK,​NV> MutableSortedMap<NK,​NV> toSortedMap​(Function<? super V,​? extends NK> keyFunction,
                                                                       Function<? super V,​? extends NV> valueFunction)
        Description copied from interface: RichIterable
        Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.
        Specified by:
        toSortedMap in interface RichIterable<V>
      • toSortedMap

        public <NK,​NV> MutableSortedMap<NK,​NV> toSortedMap​(java.util.Comparator<? super NK> comparator,
                                                                       Function<? super V,​? extends NK> keyFunction,
                                                                       Function<? super V,​? extends NV> valueFunction)
        Description copied from interface: RichIterable
        Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator.
        Specified by:
        toSortedMap in interface RichIterable<V>
      • toBiMap

        public <NK,​NV> MutableBiMap<NK,​NV> toBiMap​(Function<? super V,​? extends NK> keyFunction,
                                                               Function<? super V,​? extends NV> valueFunction)
        Description copied from interface: RichIterable
        Converts the collection to a BiMap implementation using the specified key and value functions.
        Specified by:
        toBiMap in interface RichIterable<V>
      • asLazy

        public LazyIterable<V> asLazy()
        Description copied from interface: RichIterable
        Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
        Specified by:
        asLazy in interface RichIterable<V>
      • min

        public V min​(java.util.Comparator<? super V> comparator)
        Description copied from interface: RichIterable
        Returns the minimum element out of this container based on the comparator.
        Specified by:
        min in interface RichIterable<V>
      • max

        public V max​(java.util.Comparator<? super V> comparator)
        Description copied from interface: RichIterable
        Returns the maximum element out of this container based on the comparator.
        Specified by:
        max in interface RichIterable<V>
      • min

        public V min()
        Description copied from interface: RichIterable
        Returns the minimum element out of this container based on the natural order.
        Specified by:
        min in interface RichIterable<V>
      • max

        public V max()
        Description copied from interface: RichIterable
        Returns the maximum element out of this container based on the natural order.
        Specified by:
        max in interface RichIterable<V>
      • maxBy

        public <VV extends java.lang.Comparable<? super VV>> V maxBy​(Function<? super V,​? extends VV> function)
        Description copied from interface: RichIterable
        Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
        Specified by:
        maxBy in interface RichIterable<V>
      • minBy

        public <VV extends java.lang.Comparable<? super VV>> V minBy​(Function<? super V,​? extends VV> function)
        Description copied from interface: RichIterable
        Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
        Specified by:
        minBy in interface RichIterable<V>
      • sumOfInt

        public long sumOfInt​(IntFunction<? super V> function)
        Description copied from interface: RichIterable
        Returns the final long result of evaluating function for each element of the iterable and adding the results together.
        Specified by:
        sumOfInt in interface RichIterable<V>
      • sumOfFloat

        public double sumOfFloat​(FloatFunction<? super V> function)
        Description copied from interface: RichIterable
        Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.
        Specified by:
        sumOfFloat in interface RichIterable<V>
      • sumOfLong

        public long sumOfLong​(LongFunction<? super V> function)
        Description copied from interface: RichIterable
        Returns the final long result of evaluating function for each element of the iterable and adding the results together.
        Specified by:
        sumOfLong in interface RichIterable<V>
      • sumOfDouble

        public double sumOfDouble​(DoubleFunction<? super V> function)
        Description copied from interface: RichIterable
        Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.
        Specified by:
        sumOfDouble in interface RichIterable<V>
      • put

        public V put​(int key,
                     V value)
        Description copied from interface: MutableIntObjectMap
        Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.
        Specified by:
        put in interface MutableIntObjectMap<V>
        Parameters:
        key - the key
        value - the value to associate with value
        Returns:
        the value previously associated with key if one existed, or null if not
      • putAll

        public void putAll​(IntObjectMap<? extends V> map)
        Description copied from interface: MutableIntObjectMap
        Puts all of the key/value mappings from the specified map into this map. If this map already has a value associated with one of the keys in the map, it will be replaced with the value in map.
        Specified by:
        putAll in interface MutableIntObjectMap<V>
        Parameters:
        map - the map to copy into this map
      • containsKey

        public boolean containsKey​(int key)
        Description copied from interface: IntObjectMap
        Returns whether or not the key is present in the map.
        Specified by:
        containsKey in interface IntObjectMap<V>
        Parameters:
        key - the key
        Returns:
        if a mapping exists in this map for the key
      • get

        public V get​(int key)
        Description copied from interface: IntObjectMap
        Retrieves the value associated with the key. If no mapping exists for the key, null is returned.
        Specified by:
        get in interface IntObjectMap<V>
        Parameters:
        key - the key
        Returns:
        the value associated with the key, or the default value if no such mapping exists
      • getIfAbsent

        public V getIfAbsent​(int key,
                             Function0<? extends V> ifAbsent)
        Description copied from interface: IntObjectMap
        Retrieves the value associated with the key if one exists; if it does not, returns the result of invoking the value supplier.
        Specified by:
        getIfAbsent in interface IntObjectMap<V>
        Parameters:
        key - the key
        Returns:
        the value associated with the key, if one exists, or the result of invoking ifAbsent if not
      • getIfAbsentPut

        public V getIfAbsentPut​(int key,
                                V value)
        Description copied from interface: MutableIntObjectMap
        Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
        Specified by:
        getIfAbsentPut in interface MutableIntObjectMap<V>
        Parameters:
        key - the key
        value - the value to associate with key if no such mapping exists
        Returns:
        the value associated with key, if one exists, or value if not
      • getIfAbsentPut

        public V getIfAbsentPut​(int key,
                                Function0<? extends V> function)
        Description copied from interface: MutableIntObjectMap
        Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.
        Specified by:
        getIfAbsentPut in interface MutableIntObjectMap<V>
        Parameters:
        key - the key
        function - the supplier that provides the value if no mapping exists for key
        Returns:
        the value associated with the key, if one exists, or the result of invoking function if not
      • getIfAbsentPutWith

        public <P> V getIfAbsentPutWith​(int key,
                                        Function<? super P,​? extends V> function,
                                        P parameter)
        Description copied from interface: MutableIntObjectMap
        Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.
        Specified by:
        getIfAbsentPutWith in interface MutableIntObjectMap<V>
        Type Parameters:
        P - the type of the value function's parameter
        Parameters:
        key - the key
        function - the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.
        parameter - the parameter to provide to function if no value exists for key
        Returns:
        the value associated with the key, if one exists, or the result of invoking function with parameter if not
      • getIfAbsentPutWithKey

        public V getIfAbsentPutWithKey​(int key,
                                       IntToObjectFunction<? extends V> function)
        Description copied from interface: MutableIntObjectMap
        Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.
        Specified by:
        getIfAbsentPutWithKey in interface MutableIntObjectMap<V>
        Parameters:
        key - the key
        function - the function that provides the value if no mapping exists. The key will be passed as the argument to the function.
        Returns:
        the value associated with the key, if one exists, or the result of invoking function with key if not
      • updateValue

        public V updateValue​(int key,
                             Function0<? extends V> factory,
                             Function<? super V,​? extends V> function)
        Description copied from interface: MutableIntObjectMap
        Look up the value associated with key, apply the function to it, and replace the value. If there is no value associated with key, start it off with a value supplied by factory.
        Specified by:
        updateValue in interface MutableIntObjectMap<V>
      • updateValueWith

        public <P> V updateValueWith​(int key,
                                     Function0<? extends V> factory,
                                     Function2<? super V,​? super P,​? extends V> function,
                                     P parameter)
        Description copied from interface: MutableIntObjectMap
        Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or the initial value supplied by the factory if one does not.
        Specified by:
        updateValueWith in interface MutableIntObjectMap<V>
        Type Parameters:
        P - the type of the value function's parameter
        Parameters:
        key - the key
        factory - the supplier providing the initial value to the function if no mapping exists for the key
        function - the function that returns the updated value based on the current value or the initial value, if no value exists. The specified parameter will also be passed as the second argument to the function.
        parameter - the parameter to provide to function if no value exists for key
        Returns:
        the new value associated with the key, either as a result of applying function to the value already associated with the key or as a result of applying it to the value returned by factory and associating the result with key
      • withKeyValue

        public IntObjectHashMap<V> withKeyValue​(int key,
                                                V value)
        Description copied from interface: MutableIntObjectMap
        Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.
        Specified by:
        withKeyValue in interface MutableIntObjectMap<V>
        Parameters:
        key - the key
        value - the value to associate with value
        Returns:
        this map
        See Also:
        #put(int, V)
      • withKeysValues

        public IntObjectHashMap<V> withKeysValues​(int key1,
                                                  V value1,
                                                  int key2,
                                                  V value2)
      • withKeysValues

        public IntObjectHashMap<V> withKeysValues​(int key1,
                                                  V value1,
                                                  int key2,
                                                  V value2,
                                                  int key3,
                                                  V value3)
      • withKeysValues

        public IntObjectHashMap<V> withKeysValues​(int key1,
                                                  V value1,
                                                  int key2,
                                                  V value2,
                                                  int key3,
                                                  V value3,
                                                  int key4,
                                                  V value4)
      • asUnmodifiable

        public MutableIntObjectMap<V> asUnmodifiable()
        Description copied from interface: MutableIntObjectMap
        Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations. This avoids the overhead of copying the map when calling IntObjectMap.toImmutable() while still providing immutability.
        Specified by:
        asUnmodifiable in interface MutableIntObjectMap<V>
        Returns:
        an unmodifiable view of this map
      • asSynchronized

        public MutableIntObjectMap<V> asSynchronized()
        Description copied from interface: MutableIntObjectMap
        Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.
        Specified by:
        asSynchronized in interface MutableIntObjectMap<V>
        Returns:
        a synchronized view of this map
      • toImmutable

        public ImmutableIntObjectMap<V> toImmutable()
        Description copied from interface: IntObjectMap
        Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
        Specified by:
        toImmutable in interface IntObjectMap<V>
        Returns:
        an immutable map that is equivalent to this one
      • writeExternal

        public void writeExternal​(java.io.ObjectOutput out)
                           throws java.io.IOException
        Specified by:
        writeExternal in interface java.io.Externalizable
        Throws:
        java.io.IOException
      • readExternal

        public void readExternal​(java.io.ObjectInput in)
                          throws java.io.IOException,
                                 java.lang.ClassNotFoundException
        Specified by:
        readExternal in interface java.io.Externalizable
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException
      • addKeyValueAtIndex

        private void addKeyValueAtIndex​(int key,
                                        V value,
                                        int index)
      • removeKeyAtIndex

        private void removeKeyAtIndex​(int index)
      • copyKeys

        private void copyKeys()
      • nullSafeEquals

        private static boolean nullSafeEquals​(java.lang.Object value,
                                              java.lang.Object other)
      • keySet

        public MutableIntSet keySet()
        Description copied from interface: IntObjectMap
        Returns a set containing all the keys in this map. The set is backed by the map, so any modifications to the returned set will affect this map.
        Specified by:
        keySet in interface IntObjectMap<V>
        Returns:
        a mutable set containing the keys in this map
      • compact

        public void compact()
        Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.
      • rehashAndGrow

        private void rehashAndGrow()
      • rehash

        private void rehash​(int newCapacity)
      • probe

        int probe​(int element)
      • probeTwo

        int probeTwo​(int element,
                     int removedIndex)
      • probeThree

        int probeThree​(int element,
                       int removedIndex)
      • spreadAndMask

        int spreadAndMask​(int element)
      • spreadTwoAndMask

        int spreadTwoAndMask​(int element)
      • mask

        private int mask​(int spread)
      • allocateTable

        protected void allocateTable​(int sizeToAllocate)
      • isEmptyKey

        private static boolean isEmptyKey​(int key)
      • isRemovedKey

        private static boolean isRemovedKey​(int key)
      • isNonSentinel

        private static boolean isNonSentinel​(int key)
      • maxOccupiedWithData

        private int maxOccupiedWithData()
      • keysView

        public LazyIntIterable keysView()
        Description copied from interface: IntObjectMap
        Returns a view of the keys in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the keys returned by the iterable.
        Specified by:
        keysView in interface IntObjectMap<V>
        Returns:
        a view of the keys in this map
      • keyValuesView

        public RichIterable<IntObjectPair<V>> keyValuesView()
        Description copied from interface: IntObjectMap
        Returns a view of the key/value pairs in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the pairs returned by the iterable.
        Specified by:
        keyValuesView in interface IntObjectMap<V>
        Returns:
        a view of the keys in this map