com.artemis.utils

Class IntBag

java.lang.Object

com.artemis.utils.IntBag

All Implemented Interfaces:

ImmutableIntBag

public class IntBag
extends Object
implements ImmutableIntBag

Collection type a bit like ArrayList but does not preserve the order of its entities, speedwise it is very good, especially suited for games.

Author:

original Bag by Arni Arent

Field Summary

Fields

Modifier and Type	Field and Description
protected int	size The number of values stored by this bag.

Constructor Summary

Constructors

Constructor and Description
IntBag() Constructs an empty Bag with an initial capacity of 64.
IntBag(int capacity) Constructs an empty Bag with the specified initial capacity.

Method Summary

Modifier and Type	Method and Description
void	add(int value) Adds the specified element to the end of this bag.
void	addAll(IntBag other) Adds the specified elements to the end of this bag.
void	clear() Removes all of the elements from this bag.
boolean	contains(int value) Check if bag contains this element.
void	ensureCapacity(int index) Check if an item, if added at the given item will fit into the bag.
boolean	equals(Object o)
int	get(int index) Returns the element at the specified position in Bag.
int	getCapacity() Returns the number of elements the bag can hold without growing.
int[]	getData() Returns this bag's underlying array.
int	hashCode()
int	indexOf(int value) Find index of element.
boolean	isEmpty() Returns true if this bag contains no elements.
boolean	isIndexWithinBounds(int index) Checks if the internal storage supports this index.
int	remove(int index) Removes the element at the specified position in this Bag.
boolean	removeValue(int value) Removes the first occurrence of the value from this IntBag, if it is present.
void	set(int index, int value) Set element at specified index in the bag.
void	setSize(int size) Set the size.
int	size() Returns the number of elements in this bag.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

size

protected int size

The number of values stored by this bag.

Constructor Detail

IntBag

public IntBag()

Constructs an empty Bag with an initial capacity of 64.

IntBag

public IntBag(int capacity)

Constructs an empty Bag with the specified initial capacity.

Parameters:

capacity - the initial capacity of Bag

Method Detail

removeValue

public boolean removeValue(int value)
                    throws ArrayIndexOutOfBoundsException

Removes the first occurrence of the value from this IntBag, if it is present.

Parameters:

value - the value to be removed

Returns:

true, if value was removed

Throws:

ArrayIndexOutOfBoundsException

remove

public int remove(int index)
           throws ArrayIndexOutOfBoundsException

Removes the element at the specified position in this Bag.

It does this by overwriting it was last element then removing last element

Parameters:

index - the index of element to be removed

Returns:

element that was removed from the Bag

Throws:

ArrayIndexOutOfBoundsException

indexOf

public int indexOf(int value)

Find index of element.

Parameters:

value - element to check

Returns:

index of element, or -1 if there is no such index.

contains

public boolean contains(int value)

Check if bag contains this element.

Specified by:

contains in interface ImmutableIntBag

Parameters:

value - element to check

Returns:

true if the bag contains this element

get

public int get(int index)
        throws ArrayIndexOutOfBoundsException

Returns the element at the specified position in Bag.

Specified by:

get in interface ImmutableIntBag

Parameters:

index - index of the element to return

Returns:

the element at the specified position in bag

Throws:

ArrayIndexOutOfBoundsException

size

public int size()

Returns the number of elements in this bag.

Specified by:

size in interface ImmutableIntBag

Returns:

the number of elements in this bag

getCapacity

public int getCapacity()

Returns the number of elements the bag can hold without growing.

Returns:

the number of elements the bag can hold without growing

isIndexWithinBounds

public boolean isIndexWithinBounds(int index)

Checks if the internal storage supports this index.

Parameters:

index - index to check

Returns:

true if the index is within bounds

isEmpty

public boolean isEmpty()

Returns true if this bag contains no elements.

Specified by:

isEmpty in interface ImmutableIntBag

Returns:

true if this bag contains no elements

add

public void add(int value)

Adds the specified element to the end of this bag.

If required, it also increases the capacity of the bag.

Parameters:

value - element to be added to this list

addAll

public void addAll(IntBag other)

Adds the specified elements to the end of this bag.

If required, it also increases the capacity of the bag.

Parameters:

other - elements to be added to this list

set

public void set(int index,
                int value)

Set element at specified index in the bag.

Parameters:

index - position of element

value - the element

ensureCapacity

public void ensureCapacity(int index)

Check if an item, if added at the given item will fit into the bag.

If not, the bag capacity will be increased to hold an item at the index.

Parameters:

index - index to check

clear

public void clear()

Removes all of the elements from this bag.

The bag will be empty after this call returns.

getData

public int[] getData()

Returns this bag's underlying array.

Use with care.

Returns:

the underlying array

See Also:

size()

setSize

public void setSize(int size)

Set the size.

This will not resize the bag, nor will it clean up contents beyond the given size. Use with caution.

Parameters:

size - the size to set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object