Package com.google.common.collect

Class ForwardingSortedMultiset.StandardElementSet

    • Constructor Summary

      Constructors 
      Constructor Description
      StandardElementSet()
      Constructor for use by subclasses.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      E ceiling​(E e)
      Returns the least element in this set greater than or equal to the given element, or null if there is no such element.
      void clear()
      Removes all of the elements from this collection (optional operation).
      Comparator<? super E> comparator()
      Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.
      boolean contains​(Object o)
      Returns true if this collection contains the specified element.
      boolean containsAll​(Collection<?> c)
      Returns true if this collection contains all of the elements in the specified collection.
      Iterator<E> descendingIterator()
      Returns an iterator over the elements in this set, in descending order.
      NavigableSet<E> descendingSet()
      Returns a reverse order view of the elements contained in this set.
      E first()
      Returns the first (lowest) element currently in this set.
      E floor​(E e)
      Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.
      SortedSet<E> headSet​(E toElement)
      Returns a view of the portion of this set whose elements are strictly less than toElement.
      NavigableSet<E> headSet​(E toElement, boolean inclusive)
      Returns a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement.
      E higher​(E e)
      Returns the least element in this set strictly greater than the given element, or null if there is no such element.
      boolean isEmpty()
      Returns true if this collection contains no elements.
      Iterator<E> iterator()
      Returns an iterator over the elements contained in this collection.
      E last()
      Returns the last (highest) element currently in this set.
      E lower​(E e)
      Returns the greatest element in this set strictly less than the given element, or null if there is no such element.
      E pollFirst()
      Retrieves and removes the first (lowest) element, or returns null if this set is empty.
      E pollLast()
      Retrieves and removes the last (highest) element, or returns null if this set is empty.
      boolean remove​(Object o)
      Removes a single instance of the specified element from this collection, if it is present (optional operation).
      boolean removeAll​(Collection<?> c)
      Removes from this set all of its elements that are contained in the specified collection (optional operation).
      boolean retainAll​(Collection<?> c)
      Retains only the elements in this collection that are contained in the specified collection (optional operation).
      int size()
      Returns the number of elements in this collection.
      NavigableSet<E> subSet​(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
      Returns a view of the portion of this set whose elements range from fromElement to toElement.
      SortedSet<E> subSet​(E fromElement, E toElement)
      Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive.
      SortedSet<E> tailSet​(E fromElement)
      Returns a view of the portion of this set whose elements are greater than or equal to fromElement.
      NavigableSet<E> tailSet​(E fromElement, boolean inclusive)
      Returns a view of the portion of this set whose elements are greater than (or equal to, if inclusive is true) fromElement.

    • Constructor Detail

    • Method Detail

      • lower

        @CheckForNull
public E lower​(E e)
        Description copied from interface: java.util.NavigableSet
        Returns the greatest element in this set strictly less than the given element, or null if there is no such element.
        Specified by:
        lower in interface NavigableSet<E extends @Nullable Object>
        Parameters:
        e - the value to match
        Returns:
        the greatest element less than e, or null if there is no such element

      • floor

        @CheckForNull
public E floor​(E e)
        Description copied from interface: java.util.NavigableSet
        Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.
        Specified by:
        floor in interface NavigableSet<E extends @Nullable Object>
        Parameters:
        e - the value to match
        Returns:
        the greatest element less than or equal to e, or null if there is no such element

      • ceiling

        @CheckForNull
public E ceiling​(E e)
        Description copied from interface: java.util.NavigableSet
        Returns the least element in this set greater than or equal to the given element, or null if there is no such element.
        Specified by:
        ceiling in interface NavigableSet<E extends @Nullable Object>
        Parameters:
        e - the value to match
        Returns:
        the least element greater than or equal to e, or null if there is no such element

      • higher

        @CheckForNull
public E higher​(E e)
        Description copied from interface: java.util.NavigableSet
        Returns the least element in this set strictly greater than the given element, or null if there is no such element.
        Specified by:
        higher in interface NavigableSet<E extends @Nullable Object>
        Parameters:
        e - the value to match
        Returns:
        the least element greater than e, or null if there is no such element

      • descendingSet

        public NavigableSet<E> descendingSet()
        Description copied from interface: java.util.NavigableSet
        Returns a reverse order view of the elements contained in this set. The descending set is backed by this set, so changes to the set are reflected in the descending set, and vice-versa. If either set is modified while an iteration over either set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined.

        The returned set has an ordering equivalent to Collections.reverseOrder(comparator()). The expression s.descendingSet().descendingSet() returns a view of s essentially equivalent to s.

        Specified by:
        descendingSet in interface NavigableSet<E extends @Nullable Object>
        Returns:
        a reverse order view of this set

      • descendingIterator

        public Iterator<E> descendingIterator()
        Description copied from interface: java.util.NavigableSet
        Returns an iterator over the elements in this set, in descending order. Equivalent in effect to descendingSet().iterator().
        Specified by:
        descendingIterator in interface NavigableSet<E extends @Nullable Object>
        Returns:
        an iterator over the elements in this set, in descending order

      • subSet

        public NavigableSet<E> subSet​(E fromElement,
                              boolean fromInclusive,
                              E toElement,
                              boolean toInclusive)
        Description copied from interface: java.util.NavigableSet
        Returns a view of the portion of this set whose elements range from fromElement to toElement. If fromElement and toElement are equal, the returned set is empty unless fromInclusive and toInclusive are both true. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

        The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

        Specified by:
        subSet in interface NavigableSet<E extends @Nullable Object>
        Parameters:
        fromElement - low endpoint of the returned set
        fromInclusive - true if the low endpoint is to be included in the returned view
        toElement - high endpoint of the returned set
        toInclusive - true if the high endpoint is to be included in the returned view
        Returns:
        a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive

      • headSet

        public NavigableSet<E> headSet​(E toElement,
                               boolean inclusive)
        Description copied from interface: java.util.NavigableSet
        Returns a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

        The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

        Specified by:
        headSet in interface NavigableSet<E extends @Nullable Object>
        Parameters:
        toElement - high endpoint of the returned set
        inclusive - true if the high endpoint is to be included in the returned view
        Returns:
        a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement

      • tailSet

        public NavigableSet<E> tailSet​(E fromElement,
                               boolean inclusive)
        Description copied from interface: java.util.NavigableSet
        Returns a view of the portion of this set whose elements are greater than (or equal to, if inclusive is true) fromElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

        The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

        Specified by:
        tailSet in interface NavigableSet<E extends @Nullable Object>
        Parameters:
        fromElement - low endpoint of the returned set
        inclusive - true if the low endpoint is to be included in the returned view
        Returns:
        a view of the portion of this set whose elements are greater than or equal to fromElement

      • comparator

        public Comparator<? super E> comparator()
        Description copied from interface: java.util.SortedSet
        Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.
        Specified by:
        comparator in interface SortedSet<E extends @Nullable Object>
        Returns:
        the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements

      • subSet

        public SortedSet<E> subSet​(E fromElement,
                           E toElement)
        Description copied from interface: java.util.SortedSet
        Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive. (If fromElement and toElement are equal, the returned set is empty.) The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

        The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

        Specified by:
        subSet in interface SortedSet<E extends @Nullable Object>
        Parameters:
        fromElement - low endpoint (inclusive) of the returned set
        toElement - high endpoint (exclusive) of the returned set
        Returns:
        a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive

      • headSet

        public SortedSet<E> headSet​(E toElement)
        Description copied from interface: java.util.SortedSet
        Returns a view of the portion of this set whose elements are strictly less than toElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

        The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

        Specified by:
        headSet in interface SortedSet<E extends @Nullable Object>
        Parameters:
        toElement - high endpoint (exclusive) of the returned set
        Returns:
        a view of the portion of this set whose elements are strictly less than toElement

      • tailSet

        public SortedSet<E> tailSet​(E fromElement)
        Description copied from interface: java.util.SortedSet
        Returns a view of the portion of this set whose elements are greater than or equal to fromElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

        The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

        Specified by:
        tailSet in interface SortedSet<E extends @Nullable Object>
        Parameters:
        fromElement - low endpoint (inclusive) of the returned set
        Returns:
        a view of the portion of this set whose elements are greater than or equal to fromElement

      • first

        public E first()
        Description copied from interface: java.util.SortedSet
        Returns the first (lowest) element currently in this set.
        Specified by:
        first in interface SortedSet<E extends @Nullable Object>
        Returns:
        the first (lowest) element currently in this set

      • last

        public E last()
        Description copied from interface: java.util.SortedSet
        Returns the last (highest) element currently in this set.
        Specified by:
        last in interface SortedSet<E extends @Nullable Object>
        Returns:
        the last (highest) element currently in this set

      • remove

        public boolean remove​(@CheckForNull
                      Object o)
        Description copied from class: java.util.AbstractCollection
        Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).
        Specified by:
        remove in interface Collection<E extends @Nullable Object>
        Specified by:
        remove in interface Set<E extends @Nullable Object>
        Overrides:
        remove in class AbstractCollection<E extends @Nullable Object>
        Parameters:
        o - element to be removed from this collection, if present
        Returns:
        true if an element was removed as a result of this call

      • removeAll

        public boolean removeAll​(Collection<?> c)
        Description copied from class: java.util.AbstractSet
        Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

        This implementation determines which is the smaller of this set and the specified collection, by invoking the size method on each. If this set has fewer elements, then the implementation iterates over this set, checking each element returned by the iterator in turn to see if it is contained in the specified collection. If it is so contained, it is removed from this set with the iterator's remove method. If the specified collection has fewer elements, then the implementation iterates over the specified collection, removing from this set each element returned by the iterator, using this set's remove method.

        Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method.

        Specified by:
        removeAll in interface Collection<E extends @Nullable Object>
        Specified by:
        removeAll in interface Set<E extends @Nullable Object>
        Overrides:
        removeAll in class AbstractSet<E extends @Nullable Object>
        Parameters:
        c - collection containing elements to be removed from this set
        Returns:
        true if this set changed as a result of the call
        See Also:
        AbstractCollection.remove(Object), AbstractCollection.contains(Object)