org.apache.cayenne.modeler.util

Class CircularArray

java.lang.Object

org.apache.cayenne.modeler.util.CircularArray

public class CircularArray
extends Object

A circular array is an array of fixed size as objects are added it will push objects off of the end to allow space for new objects to be added. This is useful for things like a fixed history size for a navigation tool.

Since:

1.2

Constructor Summary

Constructors

Constructor and Description
CircularArray(int capacity) Creates an array of capacity size.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Object obj) Adds a new object to the array.
int	capacity() Returns the number of objects stored in the array.
void	clear() Clears out the contents of the array.
boolean	contains(Object obj) Returns true if the array contains the specified object.
Object	get(int index) Gets the object at the specified index.
int	indexOf(Object obj) Returns the index of the specified object
String	internalRep()
boolean	isEmpty() Returns true if the array has no elements;
void	remove(Object obj) Removes the specified object from the array
void	resize(int newCapacity) Resizes the array to the specified new size.
int	size() Returns the number of objects stored in the array.
Object[]	toArray() Converts the array to an Object array.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CircularArray

public CircularArray(int capacity)

Creates an array of capacity size.

Parameters:

capacity - - size of the new array

Method Detail

clear

public void clear()

Clears out the contents of the array.

isEmpty

public boolean isEmpty()

Returns true if the array has no elements;

add

public void add(Object obj)

Adds a new object to the array. If the array is full it will push the oldest item out of the array.

Parameters:

obj - - the object to be added

capacity

public int capacity()

Returns the number of objects stored in the array.

contains

public boolean contains(Object obj)

Returns true if the array contains the specified object.

Parameters:

obj - the object to be checked

get

public Object get(int index)

Gets the object at the specified index.

Parameters:

index - the index of the object to be retrieved

indexOf

public int indexOf(Object obj)

Returns the index of the specified object

Parameters:

obj - the object that is being searched for

remove

public void remove(Object obj)

Removes the specified object from the array

Parameters:

i - the index of the object to be removed

resize

public void resize(int newCapacity)

Resizes the array to the specified new size. If the new capacity is smaller than the current object count in the array, it will keep the newCapacity most recent objects.

Parameters:

newCapacity - the new capacity of the array

size

public int size()

Returns the number of objects stored in the array.

toArray

public Object[] toArray()

Converts the array to an Object array.

internalRep

public String internalRep()

toString

public String toString()

Overrides:

toString in class Object