Package org.eclipse.collections.impl.set.mutable

Class SetAdapter<T>

    • Field Detail

      • delegate

        private final java.util.Set<T> delegate

    • Constructor Detail

      • SetAdapter

        SetAdapter​(java.util.Set<T> newDelegate)

    • Method Detail

      • asSynchronized

        public MutableSet<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 MutableSet<T>
        Returns:
        a synchronized view of this collection.
        See Also:
        Collections.synchronizedCollection(Collection)

      • adapt

        public static <E> MutableSet<E> adapt​(java.util.Set<E> set)

      • contains

        public boolean contains​(java.lang.Object o)
        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 java.util.Collection<T>
        Specified by:
        contains in interface RichIterable<T>
        Specified by:
        contains in interface java.util.Set<T>
        Overrides:
        contains in class AbstractCollectionAdapter<T>

      • containsAll

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

      • equals

        public boolean equals​(java.lang.Object obj)
        Description copied from interface: SetIterable
        Follows the same general contract as Set.equals(Object).
        Specified by:
        equals in interface java.util.Collection<T>
        Specified by:
        equals in interface java.util.Set<T>
        Specified by:
        equals in interface SetIterable<T>
        Overrides:
        equals in class java.lang.Object

      • hashCode

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

      • with

        public SetAdapter<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 MutableCollection<T>
        Specified by:
        with in interface MutableSet<T>
        Specified by:
        with in interface MutableSetIterable<T>
        See Also:
        Collection.add(Object)

      • with

        public SetAdapter<T> with​(T element1,
                          T element2,
                          T element3)

      • without

        public SetAdapter<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 MutableCollection<T>
        Specified by:
        without in interface MutableSet<T>
        Specified by:
        without in interface MutableSetIterable<T>
        See Also:
        Collection.remove(Object)

      • withAll

        public SetAdapter<T> withAll​(java.lang.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 MutableCollection<T>
        Specified by:
        withAll in interface MutableSet<T>
        Specified by:
        withAll in interface MutableSetIterable<T>
        See Also:
        Collection.addAll(Collection)

      • withoutAll

        public SetAdapter<T> withoutAll​(java.lang.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 MutableCollection<T>
        Specified by:
        withoutAll in interface MutableSet<T>
        Specified by:
        withoutAll in interface MutableSetIterable<T>
        See Also:
        Collection.removeAll(Collection)

      • newEmpty

        @Deprecated
public MutableSet<T> newEmpty()
        Deprecated.
        use UnifiedSet.newSet() instead (inlineable)
        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 MutableSet<T>

      • flatCollect

        public <V> MutableSet<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 MutableCollection<T>
        Specified by:
        flatCollect in interface MutableSet<T>
        Specified by:
        flatCollect in interface RichIterable<T>
        Specified by:
        flatCollect in interface UnsortedSetIterable<T>
        Overrides:
        flatCollect in class AbstractCollectionAdapter<T>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function

      • groupBy

        public <V> UnifiedSetMultimap<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);
        Co-variant example for MutableCollection: 
         MutableMultimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName);
        Specified by:
        groupBy in interface MutableCollection<T>
        Specified by:
        groupBy in interface MutableSet<T>
        Specified by:
        groupBy in interface MutableSetIterable<T>
        Specified by:
        groupBy in interface RichIterable<T>
        Specified by:
        groupBy in interface UnsortedSetIterable<T>
        Overrides:
        groupBy in class AbstractCollectionAdapter<T>

      • zip

        @Deprecated
public <S> MutableSet<Pair<T,​S>> zip​(java.lang.Iterable<S> that)
        Deprecated.
        in 6.0. Use OrderedIterable.zip(Iterable) instead.
        Description copied from interface: RichIterable
        Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.
        Specified by:
        zip in interface MutableCollection<T>
        Specified by:
        zip in interface MutableSet<T>
        Specified by:
        zip in interface MutableSetIterable<T>
        Specified by:
        zip in interface RichIterable<T>
        Specified by:
        zip in interface UnsortedSetIterable<T>
        Overrides:
        zip in class AbstractCollectionAdapter<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.

      • union

        public MutableSet<T> union​(SetIterable<? extends T> set)
        Description copied from interface: SetIterable
        Returns the set of all objects that are a member of this or set or both. The union of [1, 2, 3] and [2, 3, 4] is the set [1, 2, 3, 4]. If equal elements appear in both sets, then the output will contain the copy from this.
        Specified by:
        union in interface MutableSet<T>
        Specified by:
        union in interface SetIterable<T>
        Specified by:
        union in interface UnsortedSetIterable<T>

      • intersect

        public MutableSet<T> intersect​(SetIterable<? extends T> set)
        Description copied from interface: SetIterable
        Returns the set of all objects that are members of both this and set. The intersection of [1, 2, 3] and [2, 3, 4] is the set [2, 3]. The output will contain instances from the smaller of the two sets (this or set) based on the size. If the sizes are equal, the output will contain instances from this.

        Note: If you need to ensure that the memory references from this are preserved in the resulting set, consider using this.select(that::contains) instead.

        Specified by:
        intersect in interface MutableSet<T>
        Specified by:
        intersect in interface SetIterable<T>
        Specified by:
        intersect in interface UnsortedSetIterable<T>

      • isSubsetOf

        public boolean isSubsetOf​(SetIterable<? extends T> candidateSuperset)
        Description copied from interface: SetIterable
        Returns true if all the members of this are also members of candidateSuperset. For example, [1, 2] is a subset of [1, 2, 3], but [1, 4] is not.
        Specified by:
        isSubsetOf in interface SetIterable<T>

      • isProperSubsetOf

        public boolean isProperSubsetOf​(SetIterable<? extends T> candidateSuperset)
        Description copied from interface: SetIterable
        Returns true if all the members of this are also members of candidateSuperset and the two sets are not equal. For example, [1, 2] is a proper subset of [1, 2, 3], but [1, 2, 3] is not.
        Specified by:
        isProperSubsetOf in interface SetIterable<T>