com.artemis.utils.ImmutableBag Maven / Gradle / Ivy

Go to download
package com.artemis.utils;


/**
 * A non-modifiable bag.
 * 
 * A bag is a set that can also hold duplicates. Also known as multiset.
 * 
 *
 * @author Arni Arent
 *
 * @param 
 *
 * @see Bag
 */
public interface ImmutableBag extends Iterable {


	/**
	 * Returns the element at the specified position in Bag.
	 *
	 * @param index
	 *			index of the element to return
	 *
	 * @return the element at the specified position in bag
	 */
	E get(int index);

	/**
	 * Returns the number of elements in this bag.
	 *
	 * @return the number of elements in this bag
	 */
	int size();

	/**
	 * Returns true if this bag contains no elements.
	 *
	 * @return true if this bag contains no elements
	 */
	boolean isEmpty();

	/**
	 * Check if bag contains this element.
	 *
	 * @param e
	 *
	 * @return true if the bag contains this element
	 */
	boolean contains(E e);

}