/*
 * Copyright (c) 2020 Goldman Sachs and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v. 1.0 which accompany this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 */

package org.eclipse.collections.api.bag.primitive;

import java.util.StringJoiner;

import org.eclipse.collections.api.ShortIterable;
import org.eclipse.collections.api.bag.Bag;
import org.eclipse.collections.api.block.function.primitive.ShortToObjectFunction;
import org.eclipse.collections.api.block.predicate.primitive.IntPredicate;
import org.eclipse.collections.api.block.predicate.primitive.ShortPredicate;
import org.eclipse.collections.api.block.procedure.primitive.ShortProcedure;
import org.eclipse.collections.api.block.procedure.primitive.ShortIntProcedure;
import org.eclipse.collections.api.list.ListIterable;
import org.eclipse.collections.api.tuple.primitive.ShortIntPair;
import org.eclipse.collections.api.set.primitive.ShortSet;

This file was automatically generated from template file primitiveBag.stg.
Since:3.0.
/** * This file was automatically generated from template file primitiveBag.stg. * * @since 3.0. */
public interface ShortBag extends ShortIterable {
The size of the Bag when counting only distinct elements.
/** * The size of the Bag when counting only distinct elements. */
int sizeDistinct();
Since:9.0.
/** * @since 9.0. */
@Override default ShortBag tap(ShortProcedure procedure) { this.forEach(procedure); return this; }
Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
Since:8.0
/** * Returns all elements of the bag that have a number of occurrences that satisfy the predicate. * * @since 8.0 */
ShortBag selectByOccurrences(IntPredicate predicate);
Returns all elements of the bag that have more than one occurrence.
Since:9.2
/** * Returns all elements of the bag that have more than one occurrence. * * @since 9.2 */
default ShortBag selectDuplicates() { return this.selectByOccurrences(occurrences -> occurrences > 1); }
Returns all elements of the bag that have exactly one occurrence.
Since:9.2
/** * Returns all elements of the bag that have exactly one occurrence. * * @since 9.2 */
ShortSet selectUnique();
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
/** * Returns the {@code 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 */
ListIterable<ShortIntPair> topOccurrences(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
/** * Returns the {@code 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 */
ListIterable<ShortIntPair> bottomOccurrences(int count);
The occurrences of a distinct item in the bag.
/** * The occurrences of a distinct item in the bag. */
int occurrencesOf(short item);
For each distinct item, with the number of occurrences, execute the specified procedure.
/** * For each distinct item, with the number of occurrences, execute the specified procedure. */
void forEachWithOccurrences(ShortIntProcedure procedure); @Override ShortBag select(ShortPredicate predicate); @Override ShortBag reject(ShortPredicate predicate); @Override <V> Bag<V> collect(ShortToObjectFunction<? extends V> function);
Follows the same general contract as Bag.equals(Object).
/** * Follows the same general contract as {@link Bag#equals(Object)}. */
@Override boolean equals(Object o);
Follows the same general contract as Bag.hashCode().
/** * Follows the same general contract as {@link Bag#hashCode()}. */
@Override int hashCode();
Returns an immutable copy of this bag. If the bag is immutable, it returns itself.
/** * Returns an immutable copy of this bag. If the bag is immutable, it returns itself. */
ImmutableShortBag toImmutable();
Since:9.2
/** * @since 9.2 */
default String toStringOfItemToCount() { StringJoiner joiner = new StringJoiner(", ", "{", "}"); this.forEachWithOccurrences((each, occurrences) -> joiner.add(each + "=" + occurrences)); return joiner.toString(); } }