com.artemis.utils

Class IntBag

java.lang.Object

com.artemis.utils.IntBag

Type Parameters:

E - object type this bag holds

public class IntBag
extends Object

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:

Arni Arent

Field Summary

Fields

Modifier and Type	Field and Description
protected int	size The amount of elements contained in 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

Methods

Modifier and Type	Method and Description
void	add(int e) Adds the specified element to the end of this bag.
void	clear() Removes all of the elements from this bag.
boolean	contains(int e) 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.
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.
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.
int	safeGet(int index) Returns the element at the specified position in Bag.
void	set(int index, int e) Set element at specified index in the bag.
int	size() Returns the number of elements in this bag.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

size

protected int size

The amount of elements contained in 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

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

contains

public boolean contains(int e)

Check if bag contains this element.

Parameters:

e - 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.

Parameters:

index - index of the element to return

Returns:

the element at the specified position in bag

Throws:

ArrayIndexOutOfBoundsException

safeGet

public int safeGet(int index)

Returns the element at the specified position in Bag. This method ensures that the bag grows if the requested index is outside the bounds of the current backing array.

Parameters:

index - index of the element to return

Returns:

the element at the specified position in bag

size

public int size()

Returns the number of elements in this bag.

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.

Returns:

true if this bag contains no elements

add

public void add(int e)

Adds the specified element to the end of this bag.

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

Parameters:

e - element to be added to this list

set

public void set(int index,
       int e)

Set element at specified index in the bag.

Parameters:

index - position of element

e - 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()

toString

public String toString()

Overrides:

toString in class Object