Package org.eclipse.collections.api.bag

Interface MultiReaderBag<T>

All Superinterfaces:
Bag<T>, Collection<T>, InternalIterable<T>, Iterable<T>, MutableBag<T>, MutableBagIterable<T>, MutableCollection<T>, RichIterable<T>, UnsortedBag<T>
public interface MultiReaderBag<T> extends MutableBag<T>
A MultiReaderBag provides thread-safe iteration for a bag through methods withReadLockAndDelegate() and withWriteLockAndDelegate().
Since:
10.0.

  • Method Details

    • withReadLockAndDelegate

      void withReadLockAndDelegate(Procedure<? super MutableBag<T>> procedure)

    • withWriteLockAndDelegate

      void withWriteLockAndDelegate(Procedure<? super MutableBag<T>> procedure)

    • newEmpty

      MultiReaderBag<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 MutableBag<T>
      Specified by:
      newEmpty in interface MutableCollection<T>

    • with

      default MultiReaderBag<T> with(T element)
      Description copied from interface: MutableCollection
      This method allows mutable and fixed size collections the ability to add elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new element to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
       MutableCollection<String> list = list.with("1");
 list = list.with("2");
 return list;
      In the case of FixedSizeCollection a new instance of MutableCollection will be returned by with, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling add on itself.
      Specified by:
      with in interface MutableBag<T>
      Specified by:
      with in interface MutableBagIterable<T>
      Specified by:
      with in interface MutableCollection<T>
      See Also:

    • without

      default MultiReaderBag<T> without(T element)
      Description copied from interface: MutableCollection
      This method allows mutable and fixed size collections the ability to remove elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling remove. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
       MutableCollection<String> list = list.without("1");
 list = list.without("2");
 return list;
      In the case of FixedSizeCollection a new instance of MutableCollection will be returned by without, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling remove on itself.
      Specified by:
      without in interface MutableBag<T>
      Specified by:
      without in interface MutableBagIterable<T>
      Specified by:
      without in interface MutableCollection<T>
      See Also:

    • withOccurrences

      default MultiReaderBag<T> withOccurrences(T element, int occurrences)
      Specified by:
      withOccurrences in interface MutableBag<T>
      Specified by:
      withOccurrences in interface MutableBagIterable<T>

    • withoutOccurrences

      default MultiReaderBag<T> withoutOccurrences(T element, int occurrences)
      Specified by:
      withoutOccurrences in interface MutableBag<T>
      Specified by:
      withoutOccurrences in interface MutableBagIterable<T>

    • withAll

      default MultiReaderBag<T> withAll(Iterable<? extends T> elements)
      Description copied from interface: MutableCollection
      This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new elements to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
       MutableCollection<String> list = list.withAll(FastList.newListWith("1", "2"));
      In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling addAll on itself.
      Specified by:
      withAll in interface MutableBag<T>
      Specified by:
      withAll in interface MutableBagIterable<T>
      Specified by:
      withAll in interface MutableCollection<T>
      See Also:

    • withoutAll

      default MultiReaderBag<T> withoutAll(Iterable<? extends T> elements)
      Description copied from interface: MutableCollection
      This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling removeAll. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
       MutableCollection<String> list = list.withoutAll(FastList.newListWith("1", "2"));
      In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withoutAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling removeAll on itself.
      Specified by:
      withoutAll in interface MutableBag<T>
      Specified by:
      withoutAll in interface MutableBagIterable<T>
      Specified by:
      withoutAll in interface MutableCollection<T>
      See Also:

    • tap

      default MultiReaderBag<T> tap(Procedure<? super T> procedure)
      Description copied from interface: RichIterable
      Executes the Procedure for each element in the iterable and returns this.

      Example using a Java 8 lambda expression: 

       RichIterable<Person> tapped =
     people.tap(person -> LOGGER.info(person.getName()));
      Specified by:
      tap in interface Bag<T>
      Specified by:
      tap in interface MutableBag<T>
      Specified by:
      tap in interface MutableBagIterable<T>
      Specified by:
      tap in interface MutableCollection<T>
      Specified by:
      tap in interface RichIterable<T>
      Specified by:
      tap in interface UnsortedBag<T>
      See Also: