Class ForwardingSortedMultiset.StandardDescendingMultiset

    • Method Detail

      • elementSet

        public NavigableSet<E> elementSet()
        Description copied from interface: Multiset
        Returns the set of distinct elements contained in this multiset. The element set is backed by the same data as the multiset, so any change to either is immediately reflected in the other. The order of the elements in the element set is unspecified.

        If the element set supports any removal operations, these necessarily cause all occurrences of the removed element(s) to be removed from the multiset. Implementations are not expected to support the add operations, although this is possible.

        A common use for the element set is to find the number of distinct elements in the multiset: elementSet().size().

        Specified by:
        elementSet in interface Multiset<E>
        Specified by:
        elementSet in interface SortedMultiset<E>
        Overrides:
        elementSet in class ForwardingMultiset<E>
        Returns:
        a view of the set of distinct elements in this multiset
      • pollFirstEntry

        public Multiset.Entry<E> pollFirstEntry()
        Description copied from interface: SortedMultiset
        Returns and removes the entry associated with the lowest element in this multiset, or returns null if this multiset is empty.
        Specified by:
        pollFirstEntry in interface SortedMultiset<E>
      • pollLastEntry

        public Multiset.Entry<E> pollLastEntry()
        Description copied from interface: SortedMultiset
        Returns and removes the entry associated with the greatest element in this multiset, or returns null if this multiset is empty.
        Specified by:
        pollLastEntry in interface SortedMultiset<E>
      • headMultiset

        public SortedMultiset<E> headMultiset​(E toElement,
                                              BoundType boundType)
        Description copied from interface: SortedMultiset
        Returns a view of this multiset restricted to the elements less than upperBound, optionally including upperBound itself. The returned multiset is a view of this multiset, so changes to one will be reflected in the other. The returned multiset supports all operations that this multiset supports.

        The returned multiset will throw an IllegalArgumentException on attempts to add elements outside its range.

        Specified by:
        headMultiset in interface SortedMultiset<E>
      • subMultiset

        public SortedMultiset<E> subMultiset​(E fromElement,
                                             BoundType fromBoundType,
                                             E toElement,
                                             BoundType toBoundType)
        Description copied from interface: SortedMultiset
        Returns a view of this multiset restricted to the range between lowerBound and upperBound. The returned multiset is a view of this multiset, so changes to one will be reflected in the other. The returned multiset supports all operations that this multiset supports.

        The returned multiset will throw an IllegalArgumentException on attempts to add elements outside its range.

        This method is equivalent to tailMultiset(lowerBound, lowerBoundType).headMultiset(upperBound, upperBoundType).

        Specified by:
        subMultiset in interface SortedMultiset<E>
      • tailMultiset

        public SortedMultiset<E> tailMultiset​(E fromElement,
                                              BoundType boundType)
        Description copied from interface: SortedMultiset
        Returns a view of this multiset restricted to the elements greater than lowerBound, optionally including lowerBound itself. The returned multiset is a view of this multiset, so changes to one will be reflected in the other. The returned multiset supports all operations that this multiset supports.

        The returned multiset will throw an IllegalArgumentException on attempts to add elements outside its range.

        Specified by:
        tailMultiset in interface SortedMultiset<E>
      • delegate

        protected Multiset<E> delegate()
        Description copied from class: ForwardingObject
        Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.
        Specified by:
        delegate in class ForwardingMultiset<E>
      • entrySet

        public Set<Multiset.Entry<E>> entrySet()
        Description copied from interface: Multiset
        Returns a view of the contents of this multiset, grouped into Multiset.Entry instances, each providing an element of the multiset and the count of that element. This set contains exactly one entry for each distinct element in the multiset (thus it always has the same size as the Multiset.elementSet()). The order of the elements in the element set is unspecified.

        The entry set is backed by the same data as the multiset, so any change to either is immediately reflected in the other. However, multiset changes may or may not be reflected in any Entry instances already retrieved from the entry set (this is implementation-dependent). Furthermore, implementations are not required to support modifications to the entry set at all, and the Entry instances themselves don't even have methods for modification. See the specific implementation class for more details on how its entry set handles modifications.

        Specified by:
        entrySet in interface Multiset<E>
        Specified by:
        entrySet in interface SortedMultiset<E>
        Overrides:
        entrySet in class ForwardingMultiset<E>
        Returns:
        a set of entries representing the data of this multiset
      • toArray

        public Object[] toArray()
        Description copied from interface: java.util.Collection
        Returns an array containing all of the elements in this collection. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array's runtime component type is Object.

        The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.

        Specified by:
        toArray in interface Collection<E>
        Overrides:
        toArray in class ForwardingCollection<E>
        Returns:
        an array, whose runtime component type is Object, containing all of the elements in this collection
      • toArray

        public <T> T[] toArray​(T[] array)
        Description copied from interface: java.util.Collection
        Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.

        If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to null. (This is useful in determining the length of this collection only if the caller knows that this collection does not contain any null elements.)

        If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

        Specified by:
        toArray in interface Collection<E>
        Overrides:
        toArray in class ForwardingCollection<E>
        Type Parameters:
        T - the component type of the array to contain the collection
        Parameters:
        array - the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
        Returns:
        an array containing all of the elements in this collection
      • toString

        public String toString()
        Description copied from class: ForwardingObject
        Returns the string representation generated by the delegate's toString method.
        Specified by:
        toString in interface Multiset<E>
        Overrides:
        toString in class ForwardingObject
        Returns:
        a string representation of the object.