Package org.eclipse.collections.api.bag.primitive

Interface ShortBag

All Superinterfaces:

PrimitiveIterable, ShortIterable

All Known Subinterfaces:

ImmutableShortBag, MutableShortBag

All Known Implementing Classes:

ShortHashBag, SynchronizedShortBag, UnmodifiableShortBag

public interface ShortBag
extends ShortIterable

This file was automatically generated from template file primitiveBag.stg.

Since:

3.0.

Method Summary

Modifier and Type	Method	Description
ListIterable<ShortIntPair>	bottomOccurrences(int count)	Returns the count least frequently occurring items.
<V> Bag<V>	collect(ShortToObjectFunction<? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
boolean	equals(java.lang.Object o)	Follows the same general contract as Bag.equals(Object).
void	forEachWithOccurrences(ShortIntProcedure procedure)	For each distinct item, with the number of occurrences, execute the specified procedure.
int	hashCode()	Follows the same general contract as Bag.hashCode().
int	occurrencesOf(short item)	The occurrences of a distinct item in the bag.
ShortBag	reject(ShortPredicate predicate)	Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.
ShortBag	select(ShortPredicate predicate)	Returns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.
ShortBag	selectByOccurrences(IntPredicate predicate)	Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
default ShortBag	selectDuplicates()	Returns all elements of the bag that have more than one occurrence.
ShortSet	selectUnique()	Returns all elements of the bag that have exactly one occurrence.
int	sizeDistinct()	The size of the Bag when counting only distinct elements.
default ShortBag	tap(ShortProcedure procedure)
ImmutableShortBag	toImmutable()	Returns an immutable copy of this bag.
ListIterable<ShortIntPair>	topOccurrences(int count)	Returns the count most frequently occurring items.
default java.lang.String	toStringOfItemToCount()

Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable

appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size, toString

Methods inherited from interface org.eclipse.collections.api.ShortIterable

allSatisfy, anySatisfy, asLazy, average, averageIfEmpty, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, count, detectIfNone, each, flatCollect, forEach, injectInto, max, maxIfEmpty, median, medianIfEmpty, min, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, shortIterator, sum, summaryStatistics, toArray, toBag, toList, toSet, toSortedArray, toSortedList

Method Detail

sizeDistinct

int sizeDistinct()

The size of the Bag when counting only distinct elements.

tap

default ShortBag tap(ShortProcedure procedure)

Specified by:

tap in interface ShortIterable

Since:

9.0.

selectByOccurrences

ShortBag selectByOccurrences(IntPredicate predicate)

Returns all elements of the bag that have a number of occurrences that satisfy the predicate.

Since:

8.0

selectDuplicates

default ShortBag selectDuplicates()

Returns all elements of the bag that have more than one occurrence.

Since:

9.2

selectUnique

ShortSet selectUnique()

Returns all elements of the bag that have exactly one occurrence.

Since:

9.2

topOccurrences

ListIterable<ShortIntPair> topOccurrences(int count)

Returns the count most frequently occurring items. In the event of a tie, all of the items with the number of occurrences that match the occurrences of the last item will be returned.

Since:

8.0

bottomOccurrences

ListIterable<ShortIntPair> bottomOccurrences(int count)

Returns the count least frequently occurring items. In the event of a tie, all of the items with the number of occurrences that match the occurrences of the last item will be returned.

Since:

8.0

occurrencesOf

int occurrencesOf(short item)

The occurrences of a distinct item in the bag.

forEachWithOccurrences

void forEachWithOccurrences(ShortIntProcedure procedure)

For each distinct item, with the number of occurrences, execute the specified procedure.

select

ShortBag select(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.

Specified by:

select in interface ShortIterable

reject

ShortBag reject(ShortPredicate predicate)

Description copied from interface: ShortIterable

Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.

Specified by:

reject in interface ShortIterable

collect

<V> Bag<V> collect(ShortToObjectFunction<? extends V> function)

Description copied from interface: ShortIterable

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Specified by:

collect in interface ShortIterable

equals

boolean equals(java.lang.Object o)

Follows the same general contract as Bag.equals(Object).

Overrides:

equals in class java.lang.Object

hashCode

int hashCode()

Follows the same general contract as Bag.hashCode().

Overrides:

hashCode in class java.lang.Object

toImmutable

ImmutableShortBag toImmutable()

Returns an immutable copy of this bag. If the bag is immutable, it returns itself.

toStringOfItemToCount

default java.lang.String toStringOfItemToCount()

Since:

9.2