Class MultiReaderFastList<T>

  • All Implemented Interfaces:
    java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>, java.util.RandomAccess, MutableCollection<T>, InternalIterable<T>, ListIterable<T>, MultiReaderList<T>, MutableList<T>, OrderedIterable<T>, ReversibleIterable<T>, RichIterable<T>

    public final class MultiReaderFastList<T>
    extends AbstractMultiReaderMutableCollection<T>
    implements java.util.RandomAccess, java.io.Externalizable, MultiReaderList<T>
    MultiReadFastList provides a thread-safe wrapper around a FastList, using a ReentrantReadWriteLock. In order to provide true thread-safety, MultiReaderFastList does not implement iterator(), listIterator(), listIterator(int), or get(int), as all these methods require an external lock to be taken to provide thread-safe iteration. All of these methods are available however, if you use the withReadLockAndDelegate() or withWriteLockAndDelegate() methods. Both of these methods take a parameter of type Procedure<MutableList>, and a wrapped version of the underlying FastList is returned. This wrapper guarantees that no external pointer can ever reference the underlying FastList outside a locked procedure. In the case of the read lock method, an Unmodifiable version of the collection is offered, which will throw UnsupportedOperationExceptions on any write methods like add or remove.
    See Also:
    Serialized Form
    • Constructor Detail

      • MultiReaderFastList

        @Deprecated
        public MultiReaderFastList()
        Deprecated.
        Empty default constructor used for serialization.
      • MultiReaderFastList

        private MultiReaderFastList​(MutableList<T> newDelegate)
      • MultiReaderFastList

        private MultiReaderFastList​(MutableList<T> newDelegate,
                                    java.util.concurrent.locks.ReadWriteLock newLock)
    • Method Detail

      • newList

        public static <T> MultiReaderFastList<T> newList​(java.lang.Iterable<? extends T> iterable)
      • asSynchronized

        public MutableList<T> asSynchronized()
        Description copied from interface: MutableCollection
        Returns a synchronized wrapper backed by this collection. This is the equivalent of using Collections.synchronizedCollection(this) only with a return type that supports the full iteration protocols available on MutableCollection. The preferred way of iterating over a synchronized collection is to use the internal iteration methods which are properly synchronized internally.
          MutableCollection synchedCollection = collection.asSynchronized();
             ...
          synchedCollection.forEach(each -> ... );
          synchedCollection.select(each -> ... );
          synchedCollection.collect(each -> ... );
         
        If you want to iterate using an imperative style, you must protect external iterators using a synchronized block. This includes explicit iterators as well as JDK 5 style for loops.

        Specified by:
        asSynchronized in interface MutableCollection<T>
        Specified by:
        asSynchronized in interface MutableList<T>
        Returns:
        a synchronized view of this collection.
        See Also:
        Collections.synchronizedCollection(Collection)
      • collectBoolean

        public MutableBooleanList collectBoolean​(BooleanFunction<? super T> booleanFunction)
        Description copied from interface: MutableCollection
        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();
                 }
             });
         
        Co-variant example for MutableCollection:
         MutableBooleanCollection licenses =
             people.collectBoolean(person -> person.hasDrivingLicense());
         
        Specified by:
        collectBoolean in interface ListIterable<T>
        Specified by:
        collectBoolean in interface MutableCollection<T>
        Specified by:
        collectBoolean in interface MutableList<T>
        Specified by:
        collectBoolean in interface OrderedIterable<T>
        Specified by:
        collectBoolean in interface ReversibleIterable<T>
        Specified by:
        collectBoolean in interface RichIterable<T>
      • collectByte

        public MutableByteList collectByte​(ByteFunction<? super T> byteFunction)
        Description copied from interface: MutableCollection
        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();
                 }
             });
         
        Co-variant example for MutableCollection:
         MutableByteCollection bytes =
             people.collectByte(person -> person.getCode());
         
        Specified by:
        collectByte in interface ListIterable<T>
        Specified by:
        collectByte in interface MutableCollection<T>
        Specified by:
        collectByte in interface MutableList<T>
        Specified by:
        collectByte in interface OrderedIterable<T>
        Specified by:
        collectByte in interface ReversibleIterable<T>
        Specified by:
        collectByte in interface RichIterable<T>
      • collectChar

        public MutableCharList collectChar​(CharFunction<? super T> charFunction)
        Description copied from interface: MutableCollection
        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();
                 }
             });
         
        Co-variant example for MutableCollection:
         MutableCharCollection chars =
             people.collectChar(person -> person.getMiddleInitial());
         
        Specified by:
        collectChar in interface ListIterable<T>
        Specified by:
        collectChar in interface MutableCollection<T>
        Specified by:
        collectChar in interface MutableList<T>
        Specified by:
        collectChar in interface OrderedIterable<T>
        Specified by:
        collectChar in interface ReversibleIterable<T>
        Specified by:
        collectChar in interface RichIterable<T>
      • collectDouble

        public MutableDoubleList collectDouble​(DoubleFunction<? super T> doubleFunction)
        Description copied from interface: MutableCollection
        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();
                 }
             });
         
        Co-variant example for MutableCollection:
         MutableDoubleCollection doubles =
             people.collectDouble(person -> person.getMilesFromNorthPole());
         
        Specified by:
        collectDouble in interface ListIterable<T>
        Specified by:
        collectDouble in interface MutableCollection<T>
        Specified by:
        collectDouble in interface MutableList<T>
        Specified by:
        collectDouble in interface OrderedIterable<T>
        Specified by:
        collectDouble in interface ReversibleIterable<T>
        Specified by:
        collectDouble in interface RichIterable<T>
      • collectFloat

        public MutableFloatList collectFloat​(FloatFunction<? super T> floatFunction)
        Description copied from interface: MutableCollection
        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();
                 }
             });
         
        Co-variant example for MutableCollection:
         MutableFloatCollection floats =
             people.collectFloat(person -> person.getHeightInInches());
         
        Specified by:
        collectFloat in interface ListIterable<T>
        Specified by:
        collectFloat in interface MutableCollection<T>
        Specified by:
        collectFloat in interface MutableList<T>
        Specified by:
        collectFloat in interface OrderedIterable<T>
        Specified by:
        collectFloat in interface ReversibleIterable<T>
        Specified by:
        collectFloat in interface RichIterable<T>
      • collectInt

        public MutableIntList collectInt​(IntFunction<? super T> intFunction)
        Description copied from interface: MutableCollection
        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();
                 }
             });
         
        Co-variant example for MutableCollection:
         MutableIntCollection ints =
             people.collectInt(person -> person.getAge());
         
        Specified by:
        collectInt in interface ListIterable<T>
        Specified by:
        collectInt in interface MutableCollection<T>
        Specified by:
        collectInt in interface MutableList<T>
        Specified by:
        collectInt in interface OrderedIterable<T>
        Specified by:
        collectInt in interface ReversibleIterable<T>
        Specified by:
        collectInt in interface RichIterable<T>
      • collectLong

        public MutableLongList collectLong​(LongFunction<? super T> longFunction)
        Description copied from interface: MutableCollection
        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();
                 }
             });
         
        Co-variant example for MutableCollection:
         MutableLongCollection longs =
             people.collectLong(person -> person.getGuid());
         
        Specified by:
        collectLong in interface ListIterable<T>
        Specified by:
        collectLong in interface MutableCollection<T>
        Specified by:
        collectLong in interface MutableList<T>
        Specified by:
        collectLong in interface OrderedIterable<T>
        Specified by:
        collectLong in interface ReversibleIterable<T>
        Specified by:
        collectLong in interface RichIterable<T>
      • collectShort

        public MutableShortList collectShort​(ShortFunction<? super T> shortFunction)
        Description copied from interface: MutableCollection
        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();
                 }
             });
         
        Co-variant example for MutableCollection:
         MutableShortCollection shorts =
             people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
         
        Specified by:
        collectShort in interface ListIterable<T>
        Specified by:
        collectShort in interface MutableCollection<T>
        Specified by:
        collectShort in interface MutableList<T>
        Specified by:
        collectShort in interface OrderedIterable<T>
        Specified by:
        collectShort in interface ReversibleIterable<T>
        Specified by:
        collectShort in interface RichIterable<T>
      • flatCollect

        public <V> MutableList<V> flatCollect​(Function<? super T,​? extends java.lang.Iterable<V>> function)
        Description copied from interface: MutableCollection
        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);
         
        Co-variant example for MutableCollection:
         Function<Person, List<Address>> addressFunction = Person::getAddresses;
         MutableCollection<Person> people = ...;
         MutableCollection<List<Address>> addresses = people.collect(addressFunction);
         MutableCollection<Address> addresses = people.flatCollect(addressFunction);
         
        Specified by:
        flatCollect in interface ListIterable<T>
        Specified by:
        flatCollect in interface MutableCollection<T>
        Specified by:
        flatCollect in interface MutableList<T>
        Specified by:
        flatCollect in interface OrderedIterable<T>
        Specified by:
        flatCollect in interface ReversibleIterable<T>
        Specified by:
        flatCollect in interface RichIterable<T>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function
      • collectWith

        public <P,​V> MutableList<V> collectWith​(Function2<? super T,​? super P,​? extends V> function,
                                                      P parameter)
        Description copied from interface: MutableCollection
        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));
         
        Co-variant example for MutableCollection:
         MutableCollection<Integer> integers =
             Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
         
        Specified by:
        collectWith in interface ListIterable<T>
        Specified by:
        collectWith in interface MutableCollection<T>
        Specified by:
        collectWith in interface MutableList<T>
        Specified by:
        collectWith in interface OrderedIterable<T>
        Specified by:
        collectWith in interface ReversibleIterable<T>
        Specified by:
        collectWith in interface RichIterable<T>
        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)
      • newEmpty

        public MutableList<T> newEmpty()
        Description copied from interface: MutableCollection
        Creates a new empty mutable version of the same collection type. For example, if this instance is a FastList, this method will return a new empty FastList. If the class of this instance is immutable or fixed size (i.e. SingletonList) then a mutable alternative to the class will be provided.
        Specified by:
        newEmpty in interface MutableCollection<T>
        Specified by:
        newEmpty in interface MutableList<T>
      • partition

        public PartitionMutableList<T> partition​(Predicate<? super T> predicate)
        Description copied from interface: MutableCollection
        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");
                 }
             });
         
        Co-variant example for MutableCollection:
         PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
             people.partition(person -> person.getAddress().getState().getName().equals("New York"));
         
        Specified by:
        partition in interface ListIterable<T>
        Specified by:
        partition in interface MutableCollection<T>
        Specified by:
        partition in interface MutableList<T>
        Specified by:
        partition in interface OrderedIterable<T>
        Specified by:
        partition in interface ReversibleIterable<T>
        Specified by:
        partition in interface RichIterable<T>
      • partitionWith

        public <P> PartitionMutableList<T> partitionWith​(Predicate2<? super T,​? super P> predicate,
                                                         P parameter)
        Description copied from interface: MutableCollection
        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");
         
        Co-variant example for MutableCollection:
         PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
             people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
         
        Specified by:
        partitionWith in interface ListIterable<T>
        Specified by:
        partitionWith in interface MutableCollection<T>
        Specified by:
        partitionWith in interface MutableList<T>
        Specified by:
        partitionWith in interface OrderedIterable<T>
        Specified by:
        partitionWith in interface ReversibleIterable<T>
        Specified by:
        partitionWith in interface RichIterable<T>
      • sortThisBy

        public <V extends java.lang.Comparable<? super V>> MultiReaderList<T> sortThisBy​(Function<? super T,​? extends V> function)
        Description copied from interface: MutableList
        Sorts the internal data structure of this list based on the natural order of the attribute returned by function.
        Specified by:
        sortThisBy in interface MultiReaderList<T>
        Specified by:
        sortThisBy in interface MutableList<T>
      • subList

        public MutableList<T> subList​(int fromIndex,
                                      int toIndex)
        Specified by:
        subList in interface java.util.List<T>
        Specified by:
        subList in interface ListIterable<T>
        Specified by:
        subList in interface MutableList<T>
        See Also:
        List.subList(int, int)
      • equals

        public boolean equals​(java.lang.Object o)
        Description copied from interface: ListIterable
        Follows the same general contract as List.equals(Object).
        Specified by:
        equals in interface java.util.Collection<T>
        Specified by:
        equals in interface java.util.List<T>
        Specified by:
        equals in interface ListIterable<T>
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Description copied from interface: ListIterable
        Follows the same general contract as List.hashCode().
        Specified by:
        hashCode in interface java.util.Collection<T>
        Specified by:
        hashCode in interface java.util.List<T>
        Specified by:
        hashCode in interface ListIterable<T>
        Overrides:
        hashCode in class java.lang.Object
      • get

        public T get​(int index)
        Description copied from interface: ListIterable
        Returns the item at the specified position in this list iterable.
        Specified by:
        get in interface java.util.List<T>
        Specified by:
        get in interface ListIterable<T>
      • getFirstOptional

        public java.util.Optional<T> getFirstOptional()
        Description copied from interface: OrderedIterable
        Returns the first element of an iterable as an Optional. 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, Optional.empty() is returned.
        Specified by:
        getFirstOptional in interface OrderedIterable<T>
      • getLastOptional

        public java.util.Optional<T> getLastOptional()
        Description copied from interface: OrderedIterable
        Returns the last element of an iterable as an Optional. 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, Optional.empty() is returned.
        Specified by:
        getLastOptional in interface OrderedIterable<T>
      • indexOf

        public int indexOf​(java.lang.Object o)
        Description copied from interface: OrderedIterable
        Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.
        Specified by:
        indexOf in interface java.util.List<T>
        Specified by:
        indexOf in interface OrderedIterable<T>
        See Also:
        List.indexOf(Object)
      • lastIndexOf

        public int lastIndexOf​(java.lang.Object o)
        Description copied from interface: ListIterable
        Returns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.
        Specified by:
        lastIndexOf in interface java.util.List<T>
        Specified by:
        lastIndexOf in interface ListIterable<T>
      • listIterator

        public java.util.ListIterator<T> listIterator()
        This method is not supported directly on a MultiReaderFastList. If you would like to use a ListIterator with MultiReaderFastList, then you must do the following:
         multiReaderList.withReadLockAndDelegate(new Procedure<MutableList<Person>>()
         {
             public void value(MutableList<Person> people)
             {
                 Iterator it = people.listIterator();
                 ....
             }
         });
         
        Specified by:
        listIterator in interface java.util.List<T>
        Specified by:
        listIterator in interface ListIterable<T>
        See Also:
        List.listIterator()
      • replaceAll

        public void replaceAll​(java.util.function.UnaryOperator<T> operator)
        Specified by:
        replaceAll in interface java.util.List<T>
        Since:
        10.0 - Overridden for correctness
      • sort

        public void sort​(java.util.Comparator<? super T> comparator)
        Specified by:
        sort in interface java.util.List<T>
        Since:
        10.0 - Overridden for correctness
      • listIterator

        public java.util.ListIterator<T> listIterator​(int index)
        This method is not supported directly on a MultiReaderFastList. If you would like to use a ListIterator with MultiReaderFastList, then you must do the following:
         multiReaderList.withReadLockAndDelegate(new Procedure<MutableList<Person>>()
         {
             public void value(MutableList<Person> people)
             {
                 Iterator it = people.listIterator(0);
                 ....
             }
         });
         
        Specified by:
        listIterator in interface java.util.List<T>
        Specified by:
        listIterator in interface ListIterable<T>
        See Also:
        List.listIterator(int)
      • remove

        public T remove​(int index)
        Specified by:
        remove in interface java.util.List<T>
      • set

        public T set​(int index,
                     T element)
        Specified by:
        set in interface java.util.List<T>
      • addAll

        public boolean addAll​(int index,
                              java.util.Collection<? extends T> collection)
        Specified by:
        addAll in interface java.util.List<T>
      • add

        public void add​(int index,
                        T element)
        Specified by:
        add in interface java.util.List<T>
      • corresponds

        public <S> boolean corresponds​(OrderedIterable<S> other,
                                       Predicate2<? super T,​? super S> predicate)
        Description copied from interface: OrderedIterable
        Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other. The predicate is evaluated for each element at the same position of each OrderedIterable in a forward iteration order. This is a short circuit pattern.
        Specified by:
        corresponds in interface OrderedIterable<T>
      • forEach

        public void forEach​(int startIndex,
                            int endIndex,
                            Procedure<? super T> procedure)
        Description copied from interface: OrderedIterable
        Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.
        e.g.
         OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
         people.forEach(0, 1, new Procedure<Person>()
         {
             public void value(Person person)
             {
                  LOGGER.info(person.getName());
             }
         });
         

        This code would output ted and mary's names.

        Specified by:
        forEach in interface OrderedIterable<T>
      • forEachInBoth

        public <T2> void forEachInBoth​(ListIterable<T2> other,
                                       Procedure2<? super T,​? super T2> procedure)
        Description copied from interface: ListIterable
        Iterates over this ListIterable and the other ListIterable together passing the elements of each list as parameters to the specified procedure.
        Specified by:
        forEachInBoth in interface ListIterable<T>
      • binarySearch

        public int binarySearch​(T key,
                                java.util.Comparator<? super T> comparator)
        Description copied from interface: ListIterable
        Searches for the specified object using the binary search algorithm. The list must be sorted into ascending order according to the specified comparator.
        Specified by:
        binarySearch in interface ListIterable<T>
        See Also:
        Collections.binarySearch(List, Object, Comparator)
      • binarySearch

        public int binarySearch​(T key)
        Description copied from interface: ListIterable
        Searches for the specified object using the binary search algorithm. The elements in this list must implement Comparable and the list must be sorted into ascending order.
        Specified by:
        binarySearch in interface ListIterable<T>
        See Also:
        Collections.binarySearch(List, Object)
      • reverseForEach

        public void reverseForEach​(Procedure<? super T> procedure)
        Description copied from interface: ReversibleIterable
        Evaluates the procedure for each element of the list iterating in reverse order.
        e.g.
         people.reverseForEach(person -> LOGGER.info(person.getName()));
         
        Specified by:
        reverseForEach in interface ReversibleIterable<T>
      • reverseForEachWithIndex

        public void reverseForEachWithIndex​(ObjectIntProcedure<? super T> procedure)
        Description copied from interface: ReversibleIterable
        Evaluates the procedure for each element and it's index in reverse order.
        e.g.
         people.reverseForEachWithIndex((person, index) ->
                 LOGGER.info("Index: " + index + " person: " + person.getName()));
         
        Specified by:
        reverseForEachWithIndex in interface ReversibleIterable<T>
      • forEachWithIndex

        public void forEachWithIndex​(int fromIndex,
                                     int toIndex,
                                     ObjectIntProcedure<? super T> objectIntProcedure)
        Description copied from interface: OrderedIterable
        Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.
        e.g.
         OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
         people.forEachWithIndex(0, 1, new ObjectIntProcedure<Person>()
         {
             public void value(Person person, int index)
             {
                  LOGGER.info(person.getName());
             }
         });
         

        This code would output ted and mary's names.

        Specified by:
        forEachWithIndex in interface OrderedIterable<T>
      • 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
      • detectIndex

        public int detectIndex​(Predicate<? super T> predicate)
        Description copied from interface: OrderedIterable
        Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.
        Specified by:
        detectIndex in interface OrderedIterable<T>
      • detectLastIndex

        public int detectLastIndex​(Predicate<? super T> predicate)
        Description copied from interface: ReversibleIterable
        Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.
        Specified by:
        detectLastIndex in interface ReversibleIterable<T>
      • groupBy

        public <V> MutableListMultimap<V,​T> groupBy​(Function<? super T,​? extends V> function)
        Description copied from interface: MutableCollection
        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();
                 }
             });
         
        Co-variant example for MutableCollection:
         MutableMultimap<String, Person> peopleByLastName =
             people.groupBy(Person::getLastName);
         
        Specified by:
        groupBy in interface ListIterable<T>
        Specified by:
        groupBy in interface MutableCollection<T>
        Specified by:
        groupBy in interface MutableList<T>
        Specified by:
        groupBy in interface OrderedIterable<T>
        Specified by:
        groupBy in interface ReversibleIterable<T>
        Specified by:
        groupBy in interface RichIterable<T>
      • zip

        public <S> MutableList<Pair<T,​S>> zip​(java.lang.Iterable<S> that)
        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 ListIterable<T>
        Specified by:
        zip in interface MutableCollection<T>
        Specified by:
        zip in interface MutableList<T>
        Specified by:
        zip in interface OrderedIterable<T>
        Specified by:
        zip in interface ReversibleIterable<T>
        Specified by:
        zip in interface RichIterable<T>
        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<T>> chunk​(int size)
        Description copied from interface: RichIterable
        Partitions elements in fixed size chunks.
        Specified by:
        chunk in interface RichIterable<T>
        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.
      • take

        public MutableList<T> take​(int count)
        Description copied from interface: ReversibleIterable
        Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.
        Specified by:
        take in interface ListIterable<T>
        Specified by:
        take in interface MutableList<T>
        Specified by:
        take in interface ReversibleIterable<T>
        Parameters:
        count - the number of items to take.
      • drop

        public MutableList<T> drop​(int count)
        Description copied from interface: ReversibleIterable
        Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.
        Specified by:
        drop in interface ListIterable<T>
        Specified by:
        drop in interface MutableList<T>
        Specified by:
        drop in interface ReversibleIterable<T>
        Parameters:
        count - the number of items to drop.
      • asParallel

        public ParallelListIterable<T> asParallel​(java.util.concurrent.ExecutorService executorService,
                                                  int batchSize)
        Description copied from interface: ListIterable
        Returns a parallel iterable of this ListIterable.
        Specified by:
        asParallel in interface ListIterable<T>